class GridFieldAddByDBField implements GridField_ActionProvider, GridField_HTMLProvider (View source)

Traits

A class that can be instantiated or replaced via DI

Methods

static Injectable
create(mixed ...$args)

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

static Injectable
singleton(string $class = null)

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

__construct(string $targetFragment = 'before', string $dataObjectField = 'Title')

Creates a text field and add button which allows the user to directly create a new DataObject by just entering the title.

array
getActions(GridField $gridField)

Provide actions to this component.

handleAction(GridField $gridField, string $actionName, array $arguments, array $data)

Handles the add action for the given DataObject.

string
getDataObjectField()

Returns the database field for which we'll add the new data object.

$this
setButtonName($name)

Set the button name

setDataObjectField($field)

Set the database field.

array
getHTMLFragments(GridField $gridField)

Renders the TextField and add button to the GridField.

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

__construct(string $targetFragment = 'before', string $dataObjectField = 'Title')

Creates a text field and add button which allows the user to directly create a new DataObject by just entering the title.

Parameters

string $targetFragment
string $dataObjectField

array getActions(GridField $gridField)

Provide actions to this component.

Parameters

GridField $gridField

Return Value

array

with action identifier strings.

handleAction(GridField $gridField, string $actionName, array $arguments, array $data)

Handles the add action for the given DataObject.

Parameters

GridField $gridField
string $actionName

Action identifier, see {@link getActions()}.

array $arguments

Arguments relevant for this

array $data

All form data

Exceptions

UnexpectedValueException

string getDataObjectField()

Returns the database field for which we'll add the new data object.

Return Value

string

$this setButtonName($name)

Set the button name

Parameters

$name

string

Return Value

$this

setDataObjectField($field)

Set the database field.

Parameters

$field

string

array getHTMLFragments(GridField $gridField)

Renders the TextField and add button to the GridField.

Parameters

GridField $gridField

Return Value

array