GridFieldAddNewMultiClass
class GridFieldAddNewMultiClass implements GridField_HTMLProvider, GridField_URLHandler (View source)
A component which lets the user select from a list of classes to create a new record form.
By default the list of classes that are createable is the grid field's model class, and any subclasses. This can be customised using setClasses().
Properties
| protected | string | $itemRequestClass |
Methods
Sets the fragment name this button is rendered into.
Gets the classes that can be created using this button, defaulting to the model class and its subclasses.
Sets the classes that can be created using this button.
Sets the default class that is selected automatically.
Handles adding a new instance of a selected class.
Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.
Return URLs to be handled by this grid field, in an array the same form as $url_handlers.
Details
__construct(string $fragment = 'before')
No description
string
getFragment()
Gets the fragment name this button is rendered into.
GridFieldAddNewMultiClass
setFragment(string $fragment)
Sets the fragment name this button is rendered into.
string
getTitle()
Gets the button title text.
GridFieldAddNewMultiClass
setTitle(string $title)
Sets the button title text.
array
getClasses(GridField $grid)
Gets the classes that can be created using this button, defaulting to the model class and its subclasses.
GridFieldAddNewMultiClass
setClasses(array $classes, $default = null)
Sets the classes that can be created using this button.
GridFieldAddNewMultiClass
setDefaultClass(string $default)
Sets the default class that is selected automatically.
GridFieldAddNewMultiClassHandler
handleAdd(GridField $grid, SS_HTTPRequest $request)
Handles adding a new instance of a selected class.
array
getHTMLFragments($grid)
Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.
Here are 4 built-in fragments: 'header', 'footer', 'before', and 'after', but components may also specify fragments of their own.
To specify a new fragment, specify a new fragment by including the text "$DefineFragment(fragmentname)" in the HTML that you return.
Fragment names should only contain alphanumerics, -, and _.
If you attempt to return HTML for a fragment that doesn't exist, an exception will be thrown when the GridField is rendered.
getURLHandlers($grid)
Return URLs to be handled by this grid field, in an array the same form as $url_handlers.
Handler methods will be called on the component, rather than the GridField.
setItemRequestClass($class)
No description
protected string
sanitiseClassName($class)
Sanitise a model class' name for inclusion in a link
protected string
unsanitiseClassName($class)
Unsanitise a model class' name from a URL param