GridColumn extends AbstractGridObject
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
Table of Contents
Properties
- $colSpan : int
- $columnName : string
- $columnNumber : int|null
- $context : PageLayoutContext
- $definition : array<string|int, mixed>
- $icon : string
- $iconFactory : IconFactory
- $items : array<string|int, GridColumnItem>
- $rowSpan : int
- $table : string
Methods
- __construct() : mixed
- addItem() : void
- getAfterSectionMarkup() : string
- getAllContainedItemUids() : array<string|int, int>
- getBeforeSectionMarkup() : string
- getColSpan() : int
- getColumnName() : string
- getColumnNumber() : int|null
- getContext() : PageLayoutContext
- getDefinition() : array<string, mixed>
- getEditUrl() : string|null
- getIcon() : string
- getItems() : array<string|int, GridColumnItem>
- getNewContentUrl() : string
- getRowSpan() : int
- getTitle() : string
- getTitleInaccessible() : string
- getTitleUnassigned() : string
- isActive() : bool
- isContentEditable() : bool
- isUnassigned() : bool
- isUnused() : bool
- getBackendUser() : BackendUserAuthentication
- getLanguageService() : LanguageService
- getRecords() : array<int, array<string, mixed>>
- Get the raw records for the current column
Properties
$colSpan read-only
protected
int
$colSpan
$columnName read-only
protected
string
$columnName
$columnNumber read-only
protected
int|null
$columnNumber
$context
protected
PageLayoutContext
$context
$definition read-only
protected
array<string|int, mixed>
$definition
$icon read-only
protected
string
$icon
$iconFactory read-only
protected
IconFactory
$iconFactory
$items
protected
array<string|int, GridColumnItem>
$items
= []
$rowSpan read-only
protected
int
$rowSpan
$table read-only
protected
string
$table
= 'tt_content'
Methods
__construct()
public
__construct(PageLayoutContext $context, array<string, mixed> $definition[, string $table = 'tt_content' ]) : mixed
Parameters
- $context : PageLayoutContext
- $definition : array<string, mixed>
- $table : string = 'tt_content'
addItem()
public
addItem(GridColumnItem $item) : void
Parameters
- $item : GridColumnItem
getAfterSectionMarkup()
public
getAfterSectionMarkup() : string
Return values
stringgetAllContainedItemUids()
public
getAllContainedItemUids() : array<string|int, int>
Return values
array<string|int, int>getBeforeSectionMarkup()
public
getBeforeSectionMarkup() : string
Return values
stringgetColSpan()
public
getColSpan() : int
Return values
intgetColumnName()
public
getColumnName() : string
Return values
stringgetColumnNumber()
public
getColumnNumber() : int|null
Return values
int|nullgetContext()
public
getContext() : PageLayoutContext
Return values
PageLayoutContextgetDefinition()
public
getDefinition() : array<string, mixed>
Return values
array<string, mixed>getEditUrl()
public
getEditUrl() : string|null
Return values
string|nullgetIcon()
public
getIcon() : string
Return values
stringgetItems()
public
getItems() : array<string|int, GridColumnItem>
Return values
array<string|int, GridColumnItem>getNewContentUrl()
public
getNewContentUrl() : string
Return values
stringgetRowSpan()
public
getRowSpan() : int
Return values
intgetTitle()
public
getTitle() : string
Return values
stringgetTitleInaccessible()
public
getTitleInaccessible() : string
Return values
stringgetTitleUnassigned()
public
getTitleUnassigned() : string
Return values
stringisActive()
public
isActive() : bool
Return values
boolisContentEditable()
public
isContentEditable() : bool
Return values
boolisUnassigned()
public
isUnassigned() : bool
Return values
boolisUnused()
public
isUnused() : bool
Return values
boolgetBackendUser()
protected
getBackendUser() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicegetRecords()
Get the raw records for the current column
protected
getRecords() : array<int, array<string, mixed>>