TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn Class Reference

Inheritance diagram for TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn:

Public Member Functions
	__construct (protected PageLayoutContext $context, protected readonly array $definition, protected readonly string $table='tt_content')
	isActive ()
	addItem (GridColumnItem $item)
GridColumnItem[]	getItems ()
	getColumnNumber ()
	getColumnName ()
	getIcon ()
	getColSpan ()
	getRowSpan ()
int[]	getAllContainedItemUids ()
	getEditUrl ()
	getNewContentUrl ()
	getTitle ()
	getTitleInaccessible ()
	getTitleUnassigned ()
	getBeforeSectionMarkup ()
	getAfterSectionMarkup ()
	isUnassigned ()
	isUnused ()
	isContentEditable ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject
	__construct (protected PageLayoutContext $context)
	getContext ()

Public Attributes
array< string, function getDefinition():array { return $this->	definition
	$records [(int) $record['uid']] = $record
return	$records

Protected Member Functions
array< int, getRecords():array { if( $this->items===[]) { return[];} $records=[];foreach( $this->items as $item) { $record=$item->	getRecord ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject
	getLanguageService ()
	getBackendUser ()

Protected Attributes
array	$items = []
readonly int	$columnNumber
readonly string	$columnName
readonly string	$icon
readonly int	$colSpan
readonly int	$rowSpan
‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject
readonly IconFactory	$iconFactory

Private Attributes
readonly EventDispatcherInterface	$eventDispatcher

Detailed Description

Grid Column

Object representation (model/proxy) for a single column from a grid defined in a BackendLayout. Stores GridColumnItem representations of content records and provides getter methods which return various properties associated with a single column, e.g. the "edit all elements in content" URL and the "add new content element" URL of the button that is placed in the top of columns in the page layout.

Accessed from Fluid templates.

this is experimental and subject to change in TYPO3 v10 / v11

Definition at line 43 of file GridColumn.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::__construct	(	protected PageLayoutContext	$context,
		protected readonly array	$definition,
		protected readonly string	$table = 'tt_content'
	)

Parameters

array<string,mixed>

‪$definition

Definition at line 60 of file GridColumn.php.

Member Function Documentation

addItem()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::addItem

(

GridColumnItem

$item

)

Definition at line 87 of file GridColumn.php.

getAfterSectionMarkup()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getAfterSectionMarkup

(

)

Definition at line 208 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\definition.

getAllContainedItemUids()

int [] TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getAllContainedItemUids

(

)

Returns

‪int[]

Definition at line 134 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getEditUrl().

getBeforeSectionMarkup()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getBeforeSectionMarkup

(

)

Definition at line 201 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\definition.

getColSpan()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getColSpan

(

)

Definition at line 115 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$colSpan.

getColumnName()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getColumnName

(

)

Definition at line 105 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$columnName.

getColumnNumber()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getColumnNumber

(

)

Definition at line 100 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$columnNumber.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridRow\addColumn(), and TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getTitle().

getEditUrl()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getEditUrl

(

)

Definition at line 143 of file GridColumn.php.

References TYPO3\CMS\Core\Type\Bitmask\Permission\CONTENT_EDIT, TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getAllContainedItemUids(), and TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject\getBackendUser().

getIcon()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getIcon

(

)

Definition at line 110 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$icon.

getItems()

GridColumnItem [] TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getItems

(

)

Returns

‪GridColumnItem[]

Definition at line 95 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$items.

getNewContentUrl()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getNewContentUrl

(

)

Definition at line 165 of file GridColumn.php.

getRecord()

array<int, getRecords(): array { if ($this->items === []) { return []; } $records = []; foreach ($this->items as $item) { $record = $item-> TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getRecord ( )

protected

Get the raw records for the current column

Returns

‪array<int, array<string, mixed>>

getRowSpan()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getRowSpan

(

)

Definition at line 123 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$rowSpan.

getTitle()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getTitle

(

)

Definition at line 179 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\$columnNumber, TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$title, TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getColumnNumber(), and TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject\getLanguageService().

getTitleInaccessible()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getTitleInaccessible

(

)

Definition at line 191 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject\getLanguageService().

getTitleUnassigned()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::getTitleUnassigned

(

)

Definition at line 196 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject\getLanguageService().

isActive()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::isActive

(

)

Definition at line 82 of file GridColumn.php.

isContentEditable()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::isContentEditable

(

)

Definition at line 225 of file GridColumn.php.

References TYPO3\CMS\Core\Type\Bitmask\Permission\CONTENT_EDIT, and TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject\getBackendUser().

isUnassigned()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::isUnassigned

(

)

Definition at line 215 of file GridColumn.php.

isUnused()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::isUnused

(

)

Definition at line 220 of file GridColumn.php.

Member Data Documentation

$colSpan

readonly int TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$colSpan

protected

Definition at line 53 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getColSpan().

$columnName

readonly string TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$columnName

protected

Definition at line 51 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getColumnName().

$columnNumber

readonly int TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$columnNumber

protected

Definition at line 50 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getColumnNumber(), and TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getTitle().

$eventDispatcher

readonly EventDispatcherInterface TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$eventDispatcher

private

Definition at line 55 of file GridColumn.php.

$icon

readonly string TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$icon

protected

Definition at line 52 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getIcon().

$items

array TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$items = []

protected

Definition at line 48 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getItems().

$records [1/2]

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$records[(int) $record[ 'uid']] = $record

Definition at line 253 of file GridColumn.php.

$records [2/2]

return TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$records

Definition at line 255 of file GridColumn.php.

$rowSpan

readonly int TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$rowSpan

protected

Definition at line 54 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getRowSpan().

definition

array<string, function getDefinition(): array { return $this-> TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::definition

Returns

‪array<string, mixed>

Definition at line 79 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getAfterSectionMarkup(), and TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getBeforeSectionMarkup().