54 lines
1.3 KiB
PHP
54 lines
1.3 KiB
PHP
<?php
|
|
|
|
namespace SilverStripe\Forms\GridField;
|
|
|
|
use SilverStripe\ORM\DataObject;
|
|
|
|
/**
|
|
* GridField action menu item interface, this provides data so the action
|
|
* will be included if there is a {@see GridField_ActionMenu}
|
|
*/
|
|
interface GridField_ActionMenuItem extends GridFieldComponent
|
|
{
|
|
/**
|
|
* Default group name
|
|
*/
|
|
const DEFAULT_GROUP = 'Default';
|
|
|
|
/**
|
|
* Gets the title for this menu item
|
|
*
|
|
* @see {@link GridField_ActionMenu->getColumnContent()}
|
|
*
|
|
* @param GridField $gridField
|
|
* @param DataObject $record
|
|
*
|
|
* @return string $title
|
|
*/
|
|
public function getTitle($gridField, $record, $columnName);
|
|
|
|
/**
|
|
* Gets any extra data that could go in to the schema that the menu generates
|
|
*
|
|
* @see {@link GridField_ActionMenu->getColumnContent()}
|
|
*
|
|
* @param GridField $gridField
|
|
* @param DataObject $record
|
|
*
|
|
* @return array $data
|
|
*/
|
|
public function getExtraData($gridField, $record, $columnName);
|
|
|
|
/**
|
|
* Gets the group this menu item will belong to
|
|
*
|
|
* @see {@link GridField_ActionMenu->getColumnContent()}
|
|
*
|
|
* @param GridField $gridField
|
|
* @param DataObject $record
|
|
*
|
|
* @return string $group
|
|
*/
|
|
public function getGroup($gridField, $record, $columnName);
|
|
}
|