GridFieldSiteTreeState

class GridFieldSiteTreeState implements GridField_ColumnProvider (View source)

Provides a component to the GridField which shows the publish status of a page.

Methods

public
augmentColumns(GridField $gridField, array $columns)

Modify the list of columns displayed in the table.

public
array
getColumnsHandled(GridField $gridField)

Names of all columns which are affected by this component.

public
string
getColumnContent(GridField $gridField, DataObject $record, string $columnName)

HTML for the column, content of the element.

public
array
getColumnAttributes(GridField $gridField, DataObject $record, string $columnName)

Attributes for the element containing the content returned by getColumnContent().

public
getColumnMetaData($gridField, $columnName)

No description

Details

at line 14
augmentColumns(GridField $gridField, array $columns)

Modify the list of columns displayed in the table.

Parameters

GridField $gridField
array $columns

List of columns

at line 28
array getColumnsHandled(GridField $gridField)

Names of all columns which are affected by this component.

Parameters

GridField $gridField

Return Value

array

at line 33
string getColumnContent(GridField $gridField, DataObject $record, string $columnName)

HTML for the column, content of the element.

Parameters

GridField $gridField
DataObject $record
  • Record displayed in this row
string $columnName

Return Value

string
  • HTML for the column. Return NULL to skip.

at line 66
array getColumnAttributes(GridField $gridField, DataObject $record, string $columnName)

Attributes for the element containing the content returned by getColumnContent().

Parameters

GridField $gridField
DataObject $record

displayed in this row
string $columnName

Return Value

array

at line 82
getColumnMetaData($gridField, $columnName)

No description

Parameters

$gridField
$columnName