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

Public Member Functions
	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 (PageLayoutContext $context)

	getUniqueId ()

	getContext ()

Public Attributes
$this	columnNumber = isset($definition['colPos']) ? (int)$definition['colPos'] : null

$this	columnName = $definition['name'] ?? $this->columnName

$this	icon = $definition['icon'] ?? $this->icon

$this	colSpan = (int)($definition['colspan'] ?? $this->colSpan)

$this	rowSpan = (int)($definition['rowspan'] ?? $this->rowSpan)

$this	eventDispatcher = GeneralUtility::makeInstance(EventDispatcherInterface::class)

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
GridColumnItem[]	$items = array( )

int null	$columnNumber

string	$columnName = 'default'

string null	$icon

int	$colSpan = 1

int	$rowSpan = 1

array< string, $definition;private EventDispatcherInterface $eventDispatcher;public function __construct(PageLayoutContext $context, array $definition) { parent::__construct( $context);$this->	definition = $definition

‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject
PageLayoutContext	$context

IconFactory	$iconFactory

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 44 of file GridColumn.php.

Member Function Documentation

◆ addItem()

TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::addItem ( GridColumnItem $item )

Definition at line 101 of file GridColumn.php.

◆ getAfterSectionMarkup()

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

Definition at line 246 of file GridColumn.php.

References TYPO3\CMS\Backend\View\PageLayoutView\createFromPageLayoutContext(), and TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\eventDispatcher.

◆ getAllContainedItemUids()

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

Returns: ‪int[]

Definition at line 148 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 233 of file GridColumn.php.

References TYPO3\CMS\Backend\View\PageLayoutView\createFromPageLayoutContext(), and TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\eventDispatcher.

◆ getColSpan()

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

Definition at line 129 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 119 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 114 of file GridColumn.php.

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

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

◆ getEditUrl()

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

Definition at line 157 of file GridColumn.php.

References $GLOBALS, 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 124 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 109 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 175 of file GridColumn.php.

References $GLOBALS, and TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getColumnNumber().

◆ 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 137 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 211 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 223 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 228 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 96 of file GridColumn.php.

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

◆ isContentEditable()

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

Definition at line 269 of file GridColumn.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\columnNumber, 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 259 of file GridColumn.php.

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

◆ isUnused()

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

Definition at line 264 of file GridColumn.php.

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

Member Data Documentation

◆ $colSpan

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

protected

Definition at line 64 of file GridColumn.php.

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

◆ $columnName

string TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::$columnName = 'default'

protected

Definition at line 56 of file GridColumn.php.

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

◆ $columnNumber

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

protected

Definition at line 52 of file GridColumn.php.

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

◆ $icon

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

protected

Definition at line 60 of file GridColumn.php.

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

◆ $items

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

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 297 of file GridColumn.php.

◆ $records [2/2]

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

Definition at line 299 of file GridColumn.php.

◆ $rowSpan

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

protected

Definition at line 68 of file GridColumn.php.

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

◆ colSpan

$this TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::colSpan = (int)($definition['colspan'] ?? $this->colSpan)

Definition at line 83 of file GridColumn.php.

◆ columnName

$this TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::columnName = $definition['name'] ?? $this->columnName

Definition at line 81 of file GridColumn.php.

◆ columnNumber

$this TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::columnNumber = isset($definition['colPos']) ? (int)$definition['colPos'] : null

Definition at line 80 of file GridColumn.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\isActive(), TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\isContentEditable(), TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\isUnassigned(), and TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\isUnused().

◆ definition [1/2]

array<string, $definition; private EventDispatcherInterface $eventDispatcher; public function __construct(PageLayoutContext $context, array $definition) { parent::__construct($context); $this-> TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::definition = $definition

protected

mixed>

Definition at line 79 of file GridColumn.php.

◆ definition [2/2]

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

Returns: ‪array<string, mixed>

Definition at line 93 of file GridColumn.php.

◆ eventDispatcher

$this TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::eventDispatcher = GeneralUtility::makeInstance(EventDispatcherInterface::class)

Definition at line 85 of file GridColumn.php.

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

◆ icon

$this TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::icon = $definition['icon'] ?? $this->icon

Definition at line 82 of file GridColumn.php.

◆ rowSpan

$this TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn::rowSpan = (int)($definition['rowspan'] ?? $this->rowSpan)

Definition at line 84 of file GridColumn.php.

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addItem()

◆ getAfterSectionMarkup()

◆ getAllContainedItemUids()

◆ getBeforeSectionMarkup()

◆ getColSpan()

◆ getColumnName()

◆ getColumnNumber()

◆ getEditUrl()

◆ getIcon()

◆ getItems()

◆ getNewContentUrl()

◆ getRecord()

◆ getRowSpan()

◆ getTitle()

◆ getTitleInaccessible()

◆ getTitleUnassigned()

◆ isActive()

◆ isContentEditable()

◆ isUnassigned()

◆ isUnused()

Member Data Documentation

◆ $colSpan

◆ $columnName

◆ $columnNumber

◆ $icon

◆ $items

◆ $records [1/2]

◆ $records [2/2]

◆ $rowSpan

◆ colSpan

◆ columnName

◆ columnNumber

◆ definition [1/2]

◆ definition [2/2]

◆ eventDispatcher

◆ icon

◆ rowSpan