class GridFieldSiteTreeAddNewButton extends GridFieldAddNewButton implements GridField_ActionProvider (View source)

This component creates a dropdown of possible page types and a button to create a new page.

This bypasses GridFieldDetailForm to use the standard CMS.

Properties

protected $targetFragment from  GridFieldAddNewButton
protected $buttonName from  GridFieldAddNewButton

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.

public
bool
getAllowedChildren(SiteTree $parent = null)

Determine the list of classnames and titles allowed for a given parent object

public
array
getActions($gridField)

Provide actions to this component.

public
handleAction(GridField $gridField, $actionName, $arguments, $data)

Handles the add action, but only acts as a wrapper for CMSPageAddController::doAdd()

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

bool getAllowedChildren(SiteTree $parent = null)

Determine the list of classnames and titles allowed for a given parent object

Parameters

SiteTree $parent

Return Value

bool

array getActions($gridField)

Provide actions to this component.

Parameters

$gridField

Return Value

array

with action identifier strings.

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

Handles the add action, but only acts as a wrapper for CMSPageAddController::doAdd()

Parameters

GridField $gridField
$actionName
$arguments
$data