1. class
  2. SilverStripe
  3. \
  4. Forms
  5. \
  6. GridField
  7. \
  8. GridFieldVersionedState

GridFieldVersionedState deprecated

class GridFieldVersionedState extends VersionedGridFieldState

deprecated 4.1.0:5.0.0

Methods

__construct($versionedLabelFields = ['Name', 'Title'])

No description

string
getColumn()

Column to decorate with version state

from VersionedGridFieldState
VersionedGridFieldState
setColumn(string $column)

No description

from VersionedGridFieldState
array
getVersionedLabelFields()

Search list for default column

from VersionedGridFieldState
VersionedGridFieldState
setVersionedLabelFields(array $versionedLabelFields)

No description

from VersionedGridFieldState
augmentColumns(GridField $gridField, array $columns)

Modify the list of columns displayed in the table.

from VersionedGridFieldState
array
getColumnsHandled(GridField $gridField)

Names of all columns which are affected by this component.

from VersionedGridFieldState
string
getColumnContent(GridField $gridField, DataObject $record, string $columnName)

HTML for the column, content of the element.

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

Attributes for the element containing the content returned by {@link getColumnContent()}.

from VersionedGridFieldState
array
getColumnMetadata(GridField $gridField, string $columnName)

Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.

from VersionedGridFieldState

Details

at line 18
__construct($versionedLabelFields = ['Name', 'Title'])

Parameters

$versionedLabelFields

in VersionedGridFieldState at line 37
string getColumn()

Column to decorate with version state

Return Value

string

in VersionedGridFieldState at line 46
VersionedGridFieldState setColumn(string $column)

Parameters

string $column

Return Value

VersionedGridFieldState

in VersionedGridFieldState at line 57
array getVersionedLabelFields()

Search list for default column

Return Value

array

in VersionedGridFieldState at line 66
VersionedGridFieldState setVersionedLabelFields(array $versionedLabelFields)

Parameters

array $versionedLabelFields

Return Value

VersionedGridFieldState

in VersionedGridFieldState at line 81
augmentColumns(GridField $gridField, array $columns)

Modify the list of columns displayed in the table.

Parameters

GridField $gridField
array $columns List reference of all column names.

See also

{@link GridFieldDataColumns->getDisplayFields()}
{@link GridFieldDataColumns}.

in VersionedGridFieldState at line 111
array getColumnsHandled(GridField $gridField)

Names of all columns which are affected by this component.

Parameters

GridField $gridField

Return Value

array

in VersionedGridFieldState at line 124
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.

in VersionedGridFieldState at line 148
array getColumnAttributes(GridField $gridField, DataObject $record, string $columnName)

Attributes for the element containing the content returned by {@link getColumnContent()}.

Parameters

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

Return Value

array

in VersionedGridFieldState at line 161
array getColumnMetadata(GridField $gridField, string $columnName)

Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.

Parameters

GridField $gridField
string $columnName

Return Value

array
  • Map of arbitrary metadata identifiers to their values.