Public Member Functions
	__construct (array $columns, string $table, array $recordIds, DatabaseRecordList $recordList)

	setColumn (string $column, string $columnName='')

bool	hasColumn (string $columnName)

string null	getColumn (string $columnName)

bool	removeColumn (string $columnName)

	setColumns (array $columns)

	getColumns ()

	setHeaderAttributes (array $headerAttributes)

	getHeaderAttributes ()

	getTable ()

	getRecordIds ()

DatabaseRecordList	getRecordList ()

Private Attributes
array	$columns

string	$table

array	$recordIds

DatabaseRecordList	$recordList

array	$headerAttributes = []

Detailed Description

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

Definition at line 25 of file ModifyRecordListHeaderColumnsEvent.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent::__construct	(	array	$columns,
		string	$table,
		array	$recordIds,
		DatabaseRecordList	$recordList
	)

Definition at line 44 of file ModifyRecordListHeaderColumnsEvent.php.

References TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent\$columns, TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent\$recordIds, TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent\$recordList, and TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent\$table.

Member Function Documentation

◆ getColumn()

string null TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent::getColumn ( string $columnName )

Get column by its name

Parameters

string $columnName

Returns: ‪string|null The column or NULL if the column does not exist

Definition at line 92 of file ModifyRecordListHeaderColumnsEvent.php.

◆ getColumns()

TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent::getColumns ( )

Definition at line 118 of file ModifyRecordListHeaderColumnsEvent.php.

References TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent\$columns.

◆ getHeaderAttributes()

TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent::getHeaderAttributes ( )

Definition at line 128 of file ModifyRecordListHeaderColumnsEvent.php.

References TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent\$headerAttributes.

◆ getRecordIds()

TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent::getRecordIds ( )

Definition at line 138 of file ModifyRecordListHeaderColumnsEvent.php.

References TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent\$recordIds.

◆ getRecordList()

DatabaseRecordList TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent::getRecordList ( )

Returns the current DatabaseRecordList instance.

Returns: ‪DatabaseRecordList

Todo:: ‪Might be replaced by a DTO in the future

Definition at line 149 of file ModifyRecordListHeaderColumnsEvent.php.

References TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent\$recordList.

◆ getTable()

TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent::getTable ( )

Definition at line 133 of file ModifyRecordListHeaderColumnsEvent.php.

References TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent\$table.

◆ hasColumn()

bool TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent::hasColumn ( string $columnName )

Whether the column exists

Parameters

string $columnName

Returns: ‪bool

Definition at line 81 of file ModifyRecordListHeaderColumnsEvent.php.

◆ removeColumn()

bool TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent::removeColumn ( string $columnName )

Remove column by its name

Parameters

string $columnName

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

Definition at line 104 of file ModifyRecordListHeaderColumnsEvent.php.

◆ setColumn()

TYPO3\CMS\Recordlist\Event\ModifyRecordListHeaderColumnsEvent::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