class GridFieldAddNewInlineButton implements GridField_HTMLProvider, GridField_SaveHandler (View source)

Builds on the GridFieldEditableColumns component to allow creating new records.

Methods

public
__construct(string $fragment = 'buttons-before-left')

No description

public
string
getFragment()

Gets the fragment name this button is rendered into.

public
setFragment(string $fragment)

Sets the fragment name this button is rendered into.

public
string
getTitle()

Gets the button title text.

public
setTitle(string $title)

Sets the button title text.

public
array
getHTMLFragments($grid)

Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.

public
handleSave(GridField $grid, DataObjectInterface $record)

Called when a grid field is saved - i.e. the form is submitted.

Details

__construct(string $fragment = 'buttons-before-left')

No description

Parameters

string $fragment

the fragment to render the button in

string getFragment()

Gets the fragment name this button is rendered into.

Return Value

string

GridFieldAddNewInlineButton setFragment(string $fragment)

Sets the fragment name this button is rendered into.

Parameters

string $fragment

Return Value

GridFieldAddNewInlineButton $this

string getTitle()

Gets the button title text.

Return Value

string

GridFieldAddNewInlineButton setTitle(string $title)

Sets the button title text.

Parameters

string $title

Return Value

GridFieldAddNewInlineButton $this

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.

Parameters

$grid

Return Value

array

handleSave(GridField $grid, DataObjectInterface $record)

Called when a grid field is saved - i.e. the form is submitted.

Parameters

GridField $grid
DataObjectInterface $record