class GridFieldAddNewButton implements GridField_HTMLProvider (View source)

This component provides a button for opening the add new form provided by GridFieldDetailForm.

Only returns a button if DataObject->canCreate() for this record returns true.

Properties

protected $targetFragment
protected $buttonName

Methods

public
setButtonName($name)

No description

public
__construct($targetFragment = 'before')

No description

public
array
getHTMLFragments($gridField)

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

Details

setButtonName($name)

No description

Parameters

$name

__construct($targetFragment = 'before')

No description

Parameters

$targetFragment

array getHTMLFragments($gridField)

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

$gridField

Return Value

array