class GridFieldWorkflowRestrictedEditButton extends AbstractGridFieldComponent implements GridField_ColumnProvider (View source)

Traits

A class that can be instantiated or replaced via DI

Methods

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public
augmentColumns(GridField $gridField, array $columns)

Add a column

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

Append a 'disabled' CSS class to GridField rows whose WorkflowInstance records are not viewable/editable by the current user.

public
array
getColumnMetadata(GridField $gridField, string $columnName)

Add the title

public
array
getColumnsHandled(GridField $gridField)

Which columns are handled by this component

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

No description

Details

static Injectable create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

augmentColumns(GridField $gridField, array $columns)

Add a column

Parameters

GridField $gridField
array $columns

List reference of all column names.

array getColumnAttributes(GridField $gridField, ViewableData $record, string $columnName)

Append a 'disabled' CSS class to GridField rows whose WorkflowInstance records are not viewable/editable by the current user.

This is used to visually "grey out" records and it's leveraged in some overriding JavaScript, to maintain an ability to click the target object's hyperlink.

Parameters

GridField $gridField
ViewableData $record

displayed in this row

string $columnName

Return Value

array

array getColumnMetadata(GridField $gridField, string $columnName)

Add the title

Parameters

GridField $gridField
string $columnName

Return Value

array
  • Map of arbitrary metadata identifiers to their values.

array getColumnsHandled(GridField $gridField)

Which columns are handled by this component

Parameters

GridField $gridField

Return Value

array

string getColumnContent(GridField $gridField, ViewableData $record, string $columnName)

No description

Parameters

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

Return Value

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