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<string, mixed>
$icon  : string|null
$iconFactory  : IconFactory
$items  : GridColumnItem[]
$rowSpan  : int
$table  : string

Methods

__construct()  : mixed
addItem()  : void
getAfterSectionMarkup()  : string
getAllContainedItemUids()  : int[]
getBeforeSectionMarkup()  : string
getColSpan()  : int
getColumnName()  : string
getColumnNumber()  : int|null
getContext()  : PageLayoutContext
getDefinition()  : array<string, mixed>
getEditUrl()  : string|null
getIcon()  : string|null
getItems()  : GridColumnItem[]
getNewContentUrl()  : string
getRowSpan()  : int
getTitle()  : string
getTitleInaccessible()  : string
getTitleUnassigned()  : string
getUniqueId()  : 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

$columnName

protected string $columnName = 'default'

$columnNumber

protected int|null $columnNumber

$definition

protected array<string, mixed> $definition

$table

protected string $table = 'tt_content'

Methods

__construct()

public __construct(PageLayoutContext $context, array $definition[, string $table = 'tt_content' ]) : mixed

Parameters

$context : PageLayoutContext
$definition : array
$table : string = 'tt_content'

getAllContainedItemUids()

public getAllContainedItemUids() : int[]

Return values

int[]

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>

getEditUrl()

public getEditUrl() : string|null

Return values

string|null

getIcon()

public getIcon() : string|null

Return values

string|null

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

getUniqueId()

public getUniqueId() : 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

getRecords()

Get the raw records for the current column

protected getRecords() : array<int, array<string, mixed>>

Return values

array<int, array<string, mixed>>
On this page