GridColumn

class \TYPO3\CMS\Backend\View\BackendLayout\Grid\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.

Table of Contents

Properties

$colSpan  : int
$columnName  : string
$columnNumber  : int|null
$context  : PageLayoutContext
$definition  : array
$icon  : string
$iconFactory  : IconFactory
$identifier  : string|null
$items  : GridColumnItem[]
$rowSpan  : int
$slideMode  : ContentSlideMode
$table  : string

Methods

__construct()  : mixed
addItem()  : void
getAfterSectionMarkup()  : string
getAllContainedItemUids()  : int[]
getAllowedContentTypes()  : string
Comma-separated list of CTypes allowed in this column, based on the backend layout column configuration. An empty string means "no allow list" (all types allowed).
getBeforeSectionMarkup()  : string
getColSpan()  : int
getColumnName()  : string
getColumnNumber()  : int|null
getContext()  : PageLayoutContext
getDefinition()  : array<string, mixed>
getDisallowedContentTypes()  : string
Comma-separated list of CTypes disallowed in this column, based on the backend layout column configuration.
getEditUrl()  : string|null
getIcon()  : string
getIdentifier()  : string|null
getIdentifierCleaned()  : string
getItems()  : GridColumnItem[]
getNewContentUrl()  : string
getRowSpan()  : int
getSlideMode()  : ContentSlideMode
getTitle()  : string
getTitleInaccessible()  : string
getTitleUnassigned()  : string
isActive()  : bool
isContentEditable()  : bool
isUnassigned()  : bool
isUnused()  : bool
getBackendUser()  : BackendUserAuthentication
getColPosConfiguration()  : array<string, mixed>
getLanguageService()  : LanguageService
getRecords()  : RecordInterface[]
Get the raw records for the current column

Properties

$columnName read-only

protected string $columnName

$columnNumber read-only

protected int|null $columnNumber

$definition read-only

protected array $definition

$identifier read-only

protected string|null $identifier

$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'

getAfterSectionMarkup()

public getAfterSectionMarkup() : string

Deprecated

since TYPO3 v14, will be removed in TYPO3 v15 together with AfterSectionMarkupGeneratedEvent. Has no replacement.

Return values

string

getAllContainedItemUids()

public getAllContainedItemUids() : int[]

Return values

int[]

getAllowedContentTypes()

Comma-separated list of CTypes allowed in this column, based on the backend layout column configuration. An empty string means "no allow list" (all types allowed).

public getAllowedContentTypes() : string

Return values

string

getBeforeSectionMarkup()

public getBeforeSectionMarkup() : string

Deprecated

since TYPO3 v14, will be removed in TYPO3 v15 together with BeforeSectionMarkupGeneratedEvent. Has no replacement.

Return values

string

getColSpan()

public getColSpan() : int

Return values

int

getColumnName()

public getColumnName() : string

Return values

string

getColumnNumber()

public getColumnNumber() : int|null

Return values

int|null

getDefinition()

public getDefinition() : array<string, mixed>

Return values

array<string, mixed>

getDisallowedContentTypes()

Comma-separated list of CTypes disallowed in this column, based on the backend layout column configuration.

public getDisallowedContentTypes() : string

Return values

string

getEditUrl()

public getEditUrl() : string|null

Return values

string|null

getIcon()

public getIcon() : string

Return values

string

getIdentifier()

public getIdentifier() : string|null

Return values

string|null

getIdentifierCleaned()

public getIdentifierCleaned() : string

Return values

string

getNewContentUrl()

public getNewContentUrl() : string

Return values

string

getRowSpan()

public getRowSpan() : int

Return values

int

getTitle()

public getTitle() : string

Return values

string

getTitleInaccessible()

public getTitleInaccessible() : string

Return values

string

getTitleUnassigned()

public getTitleUnassigned() : string

Return values

string

isActive()

public isActive() : bool

Return values

bool

isContentEditable()

public isContentEditable() : bool

Return values

bool

isUnassigned()

public isUnassigned() : bool

Return values

bool

isUnused()

public isUnused() : bool

Return values

bool

getColPosConfiguration()

protected getColPosConfiguration() : array<string, mixed>

Return values

array<string, mixed>
On this page