ModifyRecordListHeaderColumnsEvent

New in version 11.4.

An event to modify the header columns for a table in the record list.

API

class TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent

An event to modify the header columns for a table in the RecordList

setColumn(string column, string columnName = '')

Add a new column or override an existing one. Latter is only possible, in case $columnName is given. Otherwise, the column will be added with a numeric index, which is generally not recommended.

Note: Due to the behaviour of DatabaseRecordList, just adding a column does not mean that it is also displayed. The internal $fieldArray needs to be adjusted as well. This method only adds the column to the data array. Therefore, this method should mainly be used to edit existing columns, e.g. change their label.

Parameters:
  • $column (string) – the column
  • $columnName (string) – the columnName, default: ‘’
hasColumn(string columnName)

Whether the column exists

Parameters:
  • $columnName (string) – the columnName
Return type:

bool

getColumn(string columnName)

Get column by its name

Parameters:
  • $columnName (string) – the columnName
Return type:

string

Returns:

The column or NULL if the column does not exist

removeColumn(string columnName)

Remove column by its name

Parameters:
  • $columnName (string) – the columnName
Return type:

bool

Returns:

Whether the column could be removed - Will therefore return FALSE if the column to remove does not exist.

setColumns(array columns)
Parameters:
  • $columns (array) – the columns
getColumns()
Return type:array
setHeaderAttributes(array headerAttributes)
Parameters:
  • $headerAttributes (array) – the headerAttributes
getHeaderAttributes()
Return type:array
getTable()
Return type:string
getRecordIds()
Return type:array
getRecordList()

Returns the current DatabaseRecordList instance.

Return type:TYPO3CMSRecordlistRecordListDatabaseRecordList