/field//item/ * - /field//item//edit */ class GridFieldDetailForm implements GridField_URLHandler { use Extensible, Injectable, GridFieldStateAware; /** * @var string */ protected $template = null; /** * @var string */ protected $name; /** * @var bool */ protected $showPagination; /** * @var bool */ protected $showAdd; /** * @var Validator The form validator used for both add and edit fields. */ protected $validator; /** * @var FieldList Falls back to {@link DataObject->getCMSFields()} if not defined. */ protected $fields; /** * @var string */ protected $itemRequestClass; /** * @var callable With two parameters: $form and $component */ protected $itemEditFormCallback; public function getURLHandlers($gridField) { return array( 'item/$ID' => 'handleItem' ); } /** * Create a popup component. The two arguments will specify how the popup form's HTML and * behaviour is created. The given controller will be customised, putting the edit form into the * template with the given name. * * The arguments are experimental API's to support partial content to be passed back to whatever * controller who wants to display the getCMSFields * * @param string $name The name of the edit form to place into the pop-up form * @param bool $showPagination Whether the `Previous` and `Next` buttons should display or not, leave as null to use default * @param bool $showAdd Whether the `Add` button should display or not, leave as null to use default */ public function __construct($name = null, $showPagination = null, $showAdd = null) { $this->setName($name ?: 'DetailForm'); $this->setShowPagination($showPagination); $this->setShowAdd($showAdd); } /** * * @param GridField $gridField * @param HTTPRequest $request * @return HTTPResponse */ public function handleItem($gridField, $request) { // Our getController could either give us a true Controller, if this is the top-level GridField. // It could also give us a RequestHandler in the form of GridFieldDetailForm_ItemRequest if this is a // nested GridField. $requestHandler = $gridField->getForm()->getController(); $record = $this->getRecordFromRequest($gridField, $request); if (!$record) { return $requestHandler->httpError(404, 'That record was not found'); } $handler = $this->getItemRequestHandler($gridField, $record, $requestHandler); $manager = $this->getStateManager(); if ($gridStateStr = $manager->getStateFromRequest($gridField, $request)) { $gridField->getState(false)->setValue($gridStateStr); } // if no validator has been set on the GridField and the record has a // CMS validator, use that. if (!$this->getValidator() && ClassInfo::hasMethod($record, 'getCMSValidator')) { $this->setValidator($record->getCMSValidator()); } return $handler->handleRequest($request); } /** * @param GridField $gridField * @param HTTPRequest $request * @return DataObject|null */ protected function getRecordFromRequest(GridField $gridField, HTTPRequest $request): ?DataObject { /** @var DataObject $record */ if (is_numeric($request->param('ID'))) { /** @var Filterable $dataList */ $dataList = $gridField->getList(); $record = $dataList->byID($request->param('ID')); } else { $record = Injector::inst()->create($gridField->getModelClass()); } return $record; } /** * Build a request handler for the given record * * @param GridField $gridField * @param DataObject $record * @param RequestHandler $requestHandler * @return GridFieldDetailForm_ItemRequest */ protected function getItemRequestHandler($gridField, $record, $requestHandler) { $class = $this->getItemRequestClass(); $assignedClass = $this->itemRequestClass; $this->extend('updateItemRequestClass', $class, $gridField, $record, $requestHandler, $assignedClass); /** @var GridFieldDetailForm_ItemRequest $handler */ $handler = Injector::inst()->createWithArgs( $class, array($gridField, $this, $record, $requestHandler, $this->name) ); if ($template = $this->getTemplate()) { $handler->setTemplate($template); } $this->extend('updateItemRequestHandler', $handler); return $handler; } /** * @param string $template * @return $this */ public function setTemplate($template) { $this->template = $template; return $this; } /** * @return String */ public function getTemplate() { return $this->template; } /** * @param string $name * @return $this */ public function setName($name) { $this->name = $name; return $this; } /** * @return String */ public function getName() { return $this->name; } /** * @return bool */ protected function getDefaultShowPagination() { $formActionsConfig = GridFieldDetailForm_ItemRequest::config()->get('formActions'); return isset($formActionsConfig['showPagination']) ? (bool) $formActionsConfig['showPagination'] : false; } /** * @return bool */ public function getShowPagination() { if ($this->showPagination === null) { return $this->getDefaultShowPagination(); } return (bool) $this->showPagination; } /** * @param bool|null $showPagination * @return GridFieldDetailForm */ public function setShowPagination($showPagination) { $this->showPagination = $showPagination; return $this; } /** * @return bool */ protected function getDefaultShowAdd() { $formActionsConfig = GridFieldDetailForm_ItemRequest::config()->get('formActions'); return isset($formActionsConfig['showAdd']) ? (bool) $formActionsConfig['showAdd'] : false; } /** * @return bool */ public function getShowAdd() { if ($this->showAdd === null) { return $this->getDefaultShowAdd(); } return (bool) $this->showAdd; } /** * @param bool|null $showAdd * @return GridFieldDetailForm */ public function setShowAdd($showAdd) { $this->showAdd = $showAdd; return $this; } /** * @param Validator $validator * @return $this */ public function setValidator(Validator $validator) { $this->validator = $validator; return $this; } /** * @return Validator */ public function getValidator() { return $this->validator; } /** * @param FieldList $fields * @return $this */ public function setFields(FieldList $fields) { $this->fields = $fields; return $this; } /** * @return FieldList */ public function getFields() { return $this->fields; } /** * @param string $class * @return $this */ public function setItemRequestClass($class) { $this->itemRequestClass = $class; return $this; } /** * @return string name of {@see GridFieldDetailForm_ItemRequest} subclass */ public function getItemRequestClass() { if ($this->itemRequestClass) { return $this->itemRequestClass; } elseif (ClassInfo::exists(static::class . '_ItemRequest')) { return static::class . '_ItemRequest'; } return GridFieldDetailForm_ItemRequest::class; } /** * @param Closure $cb Make changes on the edit form after constructing it. * @return $this */ public function setItemEditFormCallback(Closure $cb) { $this->itemEditFormCallback = $cb; return $this; } /** * @return Closure */ public function getItemEditFormCallback() { return $this->itemEditFormCallback; } }