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.

Internal

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

$columnName read-only

protected string $columnName

$columnNumber read-only

protected int|null $columnNumber

$definition read-only

protected array<string|int, mixed> $definition

$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
Return values
string

getAllContainedItemUids()

public getAllContainedItemUids() : array<string|int, int>
Return values
array<string|int, int>

getBeforeSectionMarkup()

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

getEditUrl()

public getEditUrl() : string|null
Return values
string|null

getIcon()

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

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

        
    


            

                    

        

    

        

            
Search results