GridFieldAddByDBField
class GridFieldAddByDBField implements GridField_ActionProvider, GridField_HTMLProvider (View source)
Traits
A class that can be instantiated or replaced via DI
Properties
| protected | string | $targetFragment | HTML Fragment to render the field. |
|
| protected | string | $dataObjectField | Default field to create the DataObject by should be Title. |
|
| protected | string | $buttonName | Name for the buttons displayed in the CMS |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Creates a text field and add button which allows the user to directly create a new DataObject by just entering the title.
Handles the add action for the given DataObject.
Returns the database field for which we'll add the new data object.
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();
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).
__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.