Columns¶

Adding database column¶

DataTables\Table\Columns::addDatabaseColumn(string $dataBaseField, ?int $index = null)¶

This method will add a new database column to the table, but first it will check if the column exists in table schema, both for the table itself and for its relations. Its name must be unique for the table. As in CakePHP, the column name words must be separated by underscore and the table name (optional) in CamelCase format, both separated by a dot. This method will return a Column object that you can use to set some configurations for the created column. You can pass the index to put the column in a specific position. Example of usage:

/**
 * @param \DataTables\Table\ConfigBundle $configBundle
 */
public function config(ConfigBundle $configBundle): void
{
   $configBundle->Columns->addDatabaseColumn('id');

   $configBundle->Columns->addDatabaseColumn('created');
   $configBundle->Columns->addDatabaseColumn('modified');

   // Adding a column BelongsTo
   $configBundle->Columns->addDatabaseColumn('Categories.name');

   // Adding a column HasMany
   $configBundle->Columns->addDatabaseColumn('Tags.name');

}

Adding a custom database column¶

DataTables\Table\Columns::addCustomDatabaseColumn(FunctionExpression $functionExpression, string $asName, ?int $index = null)¶

With this method, you will able of do some custom sql finds like CONCAT, SUM and others. You must provide a FunctionExpression instance that is the result of one of many methods that you can find in FunctionsBuilder that you can get in $configBundle->Columns->func() method. Example of usage:

/**
 * @param \DataTables\Table\ConfigBundle $configBundle
 */
public function config(ConfigBundle $configBundle): void
{
    $func = $configBundle->Columns->func()->concat(['id' => 'identifier', ' created in: ', 'created' => 'identifier']);
    $configBundle->Columns->addCustomDatabaseColumn($func, 'custom_field');

}

Adding non database column¶

DataTables\Table\Columns::addNonDatabaseColumn(string $label, ?int $index = null)¶

This method will add a new non database column to the table. Its name must be a alphanumeric string and unique for the the table. You can use this method to create columns with custom values as a sum or concatenate of two database fields or a action column. This method will return a Column object that you can use to set some configurations for the created column. You can pass the index to put the column in a specific position. Example of usage:

/**
 * @param \DataTables\Table\ConfigBundle $configBundle
 */
public function config(ConfigBundle $configBundle): void
{
   $configBundle->Columns->addNonDatabaseColumn('total');
   $configBundle->Columns->addNonDatabaseColumn('action');
}

Changing the index of a column¶

DataTables\Table\Columns::changeColumnIndex(string $columnName, int $index)¶

By default, the column index will follow the created order, if you want change the order, you can use this method in your DataTables class or in controller using the DataTables Component. Example of usage:

/**
 * @param \DataTables\Table\ConfigBundle $configBundle
 */
public function config(ConfigBundle $configBundle): void
{
    $configBundle->Columns->addDatabaseColumn('name');
    $configBundle->Columns->addDatabaseColumn('created');
    $configBundle->Columns->addDatabaseColumn('modified');
    $configBundle->Columns->addNonDatabaseColumn('action');
    $configBundle->Columns->addDatabaseColumn('id');

    $configBundle->Columns->changeColumnIndex('id', 0);
}

Or:

/**
 * A example of controller action.
 */
public function controllerAction()
{
    $columns = $this->DataTables->getColumns('Products')
    $columns->changeColumnIndex('id', 0);
}

Getting created columns¶

DataTables\Table\Columns::getColumns()¶

If you need get all configured columns, you can call this method, it will return a array will all column objects. Example of usage:

/**
 * A example of controller action.
 */
public function controllerAction()
{
    $columns = $this->DataTables->getColumns('Products')

    $columnTitles = [];
    foreach ($columns->getColumns() as $column) {
        $columnTitles[] = $column->getTitle();
    }
}

Getting a column¶

DataTables\Table\Columns::getColumn(string $columnName)¶

If you need get a specific configured column, you can call this method, it will return a column object for the requested column name. Example of usage:

/**
 * A example of controller action.
 */
public function controllerAction()
{
    $columns = $this->DataTables->getColumns('Products')

    $columnTitle = $columns->getColumn('id')->getTitle();
}

Getting a column by index¶

DataTables\Table\Columns::getColumnByIndex(int $index)¶

If you need get a specific configured column, you can call this method, it will return a column object for the requested column index. Example of usage:

/**
 * A example of controller action.
 */
public function controllerAction()
{
    $columns = $this->DataTables->getColumns('Products')

    $columnTitle = $columns->getColumnByIndex(0)->getTitle();
}

Getting a column index by name¶

DataTables\Table\Columns::getColumnIndexByName(string $columnName)¶

If you need know the index of a specific column, you can provide the column name to this method and it will return the index. Example of usage:

/**
 * A example of controller action.
 */
public function controllerAction()
{
    $columns = $this->DataTables->getColumns('Products')

    $columnIndex = $columns->getColumnIndexByName('Products.created');
}

Getting a column name by index¶

DataTables\Table\Columns::getColumnNameByIndex(int $index)¶

If you need to know what the column name for a specific index, you can call this method passing a index number for it. Example of usage:

/**
 * A example of controller action.
 */
public function controllerAction()
{
    $columns = $this->DataTables->getColumns('Products')

    $columnName = $columns->getColumnNameByIndex(0);
}

Deleting a column¶

DataTables\Table\Columns::deleteColumn(string $columnName)¶

If you need remove a specific column from table, you can call this method passing a column name for it. Example of usage:

/**
 * A example of controller action.
 */
public function controllerAction()
{
    $columns = $this->DataTables->getColumns('Products')

    $columns->deleteColumn('action')
}

Deleting all columns¶

DataTables\Table\Columns::deleteAllColumns()¶

If you want remove all created columns, you can call this method. Example of usage:

/**
 * A example of controller action.
 */
public function controllerAction()
{
    $columns = $this->DataTables->getColumns('Products')

    $columns->deleteAllColumns()
    $columns->Columns->addDatabaseColumn('id');
    $columns->Columns->addDatabaseColumn('name');
    $columns->Columns->addDatabaseColumn('created');
    $columns->Columns->addDatabaseColumn('modified');
    $columns->Columns->addNonDatabaseColumn('action');
}