mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
741ab96418
Controller:curr() in this context are equivalent to calling getToplevelController() which already solves the issue of nested GridFields.
669 lines
18 KiB
PHP
669 lines
18 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Provides view and edit forms at GridField-specific URLs.
|
|
*
|
|
* These can be placed into pop-ups by an appropriate front-end.
|
|
*
|
|
* Usually added to a {@link GridField} alongside of a
|
|
* {@link GridFieldEditButton} which takes care of linking the
|
|
* individual rows to their edit view.
|
|
*
|
|
* The URLs provided will be off the following form:
|
|
* - <FormURL>/field/<GridFieldName>/item/<RecordID>
|
|
* - <FormURL>/field/<GridFieldName>/item/<RecordID>/edit
|
|
*
|
|
* @package forms
|
|
* @subpackage fields-gridfield
|
|
*/
|
|
class GridFieldDetailForm implements GridField_URLHandler {
|
|
|
|
/**
|
|
* @var String
|
|
*/
|
|
protected $template = 'GridFieldDetailForm';
|
|
|
|
/**
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $name;
|
|
|
|
/**
|
|
* @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 function With two parameters: $form and $component
|
|
*/
|
|
protected $itemEditFormCallback;
|
|
|
|
public function getURLHandlers($gridField) {
|
|
return array(
|
|
'item/$ID' => 'handleItem',
|
|
'autocomplete' => 'handleAutocomplete',
|
|
);
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
public function __construct($name = 'DetailForm') {
|
|
$this->name = $name;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param type $gridField
|
|
* @param type $request
|
|
* @return GridFieldDetailForm_ItemRequest
|
|
*/
|
|
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();
|
|
|
|
if(is_numeric($request->param('ID'))) {
|
|
$record = $gridField->getList()->byId($request->param("ID"));
|
|
} else {
|
|
$record = Object::create($gridField->getModelClass());
|
|
}
|
|
|
|
$class = $this->getItemRequestClass();
|
|
|
|
$handler = Object::create($class, $gridField, $this, $record, $requestHandler, $this->name);
|
|
$handler->setTemplate($this->template);
|
|
|
|
// if no validator has been set on the GridField and the record has a
|
|
// CMS validator, use that.
|
|
if(!$this->getValidator() && method_exists($record, 'getCMSValidator')) {
|
|
$this->setValidator($record->getCMSValidator());
|
|
}
|
|
|
|
return $handler->handleRequest($request, DataModel::inst());
|
|
}
|
|
|
|
/**
|
|
* @param String
|
|
*/
|
|
public function setTemplate($template) {
|
|
$this->template = $template;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return String
|
|
*/
|
|
public function getTemplate() {
|
|
return $this->template;
|
|
}
|
|
|
|
/**
|
|
* @param String
|
|
*/
|
|
public function setName($name) {
|
|
$this->name = $name;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return String
|
|
*/
|
|
public function getName() {
|
|
return $this->name;
|
|
}
|
|
|
|
/**
|
|
* @param Validator $validator
|
|
*/
|
|
public function setValidator(Validator $validator) {
|
|
$this->validator = $validator;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return Validator
|
|
*/
|
|
public function getValidator() {
|
|
return $this->validator;
|
|
}
|
|
|
|
/**
|
|
* @param FieldList $fields
|
|
*/
|
|
public function setFields(FieldList $fields) {
|
|
$this->fields = $fields;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return FieldList
|
|
*/
|
|
public function getFields() {
|
|
return $this->fields;
|
|
}
|
|
|
|
/**
|
|
* @param String
|
|
*/
|
|
public function setItemRequestClass($class) {
|
|
$this->itemRequestClass = $class;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return String
|
|
*/
|
|
public function getItemRequestClass() {
|
|
if($this->itemRequestClass) {
|
|
return $this->itemRequestClass;
|
|
} else if(ClassInfo::exists(get_class($this) . "_ItemRequest")) {
|
|
return get_class($this) . "_ItemRequest";
|
|
} else {
|
|
return 'GridFieldDetailForm_ItemRequest';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param Closure $cb Make changes on the edit form after constructing it.
|
|
*/
|
|
public function setItemEditFormCallback(Closure $cb) {
|
|
$this->itemEditFormCallback = $cb;
|
|
}
|
|
|
|
/**
|
|
* @return Closure
|
|
*/
|
|
public function getItemEditFormCallback() {
|
|
return $this->itemEditFormCallback;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @package forms
|
|
* @subpackage fields-gridfield
|
|
*/
|
|
class GridFieldDetailForm_ItemRequest extends RequestHandler {
|
|
|
|
private static $allowed_actions = array(
|
|
'edit',
|
|
'view',
|
|
'ItemEditForm'
|
|
);
|
|
|
|
/**
|
|
*
|
|
* @var GridField
|
|
*/
|
|
protected $gridField;
|
|
|
|
/**
|
|
*
|
|
* @var GridField_URLHandler
|
|
*/
|
|
protected $component;
|
|
|
|
/**
|
|
*
|
|
* @var DataObject
|
|
*/
|
|
protected $record;
|
|
|
|
/**
|
|
* This represents the current parent RequestHandler (which does not necessarily need to be a Controller).
|
|
* It allows us to traverse the RequestHandler chain upwards to reach the Controller stack.
|
|
*
|
|
* @var RequestHandler
|
|
*/
|
|
protected $popupController;
|
|
|
|
/**
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $popupFormName;
|
|
|
|
/**
|
|
* @var String
|
|
*/
|
|
protected $template = 'GridFieldItemEditView';
|
|
|
|
private static $url_handlers = array(
|
|
'$Action!' => '$Action',
|
|
'' => 'edit',
|
|
);
|
|
|
|
/**
|
|
*
|
|
* @param GridFIeld $gridField
|
|
* @param GridField_URLHandler $component
|
|
* @param DataObject $record
|
|
* @param RequestHandler $requestHandler
|
|
* @param string $popupFormName
|
|
*/
|
|
public function __construct($gridField, $component, $record, $requestHandler, $popupFormName) {
|
|
$this->gridField = $gridField;
|
|
$this->component = $component;
|
|
$this->record = $record;
|
|
$this->popupController = $requestHandler;
|
|
$this->popupFormName = $popupFormName;
|
|
parent::__construct();
|
|
}
|
|
|
|
public function Link($action = null) {
|
|
return Controller::join_links($this->gridField->Link('item'),
|
|
$this->record->ID ? $this->record->ID : 'new', $action);
|
|
}
|
|
|
|
public function view($request) {
|
|
if(!$this->record->canView()) {
|
|
$this->httpError(403);
|
|
}
|
|
|
|
$controller = $this->getToplevelController();
|
|
|
|
$form = $this->ItemEditForm($this->gridField, $request);
|
|
$form->makeReadonly();
|
|
|
|
$data = new ArrayData(array(
|
|
'Backlink' => $controller->Link(),
|
|
'ItemEditForm' => $form
|
|
));
|
|
$return = $data->renderWith($this->template);
|
|
|
|
if($request->isAjax()) {
|
|
return $return;
|
|
} else {
|
|
return $controller->customise(array('Content' => $return));
|
|
}
|
|
}
|
|
|
|
public function edit($request) {
|
|
$controller = $this->getToplevelController();
|
|
$form = $this->ItemEditForm($this->gridField, $request);
|
|
|
|
$return = $this->customise(array(
|
|
'Backlink' => $controller->hasMethod('Backlink') ? $controller->Backlink() : $controller->Link(),
|
|
'ItemEditForm' => $form,
|
|
))->renderWith($this->template);
|
|
|
|
if($request->isAjax()) {
|
|
return $return;
|
|
} else {
|
|
// If not requested by ajax, we need to render it within the controller context+template
|
|
return $controller->customise(array(
|
|
// TODO CMS coupling
|
|
'Content' => $return,
|
|
));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Builds an item edit form. The arguments to getCMSFields() are the popupController and
|
|
* popupFormName, however this is an experimental API and may change.
|
|
*
|
|
* @todo In the future, we will probably need to come up with a tigher object representing a partially
|
|
* complete controller with gaps for extra functionality. This, for example, would be a better way
|
|
* of letting Security/login put its log-in form inside a UI specified elsewhere.
|
|
*
|
|
* @return Form
|
|
*/
|
|
public function ItemEditForm() {
|
|
$list = $this->gridField->getList();
|
|
|
|
if (empty($this->record)) {
|
|
$controller = $this->getToplevelController();
|
|
$noActionURL = $controller->removeAction($_REQUEST['url']);
|
|
$controller->getResponse()->removeHeader('Location'); //clear the existing redirect
|
|
return $controller->redirect($noActionURL, 302);
|
|
}
|
|
|
|
$canView = $this->record->canView();
|
|
$canEdit = $this->record->canEdit();
|
|
$canDelete = $this->record->canDelete();
|
|
$canCreate = $this->record->canCreate();
|
|
|
|
if(!$canView) {
|
|
$controller = $this->getToplevelController();
|
|
// TODO More friendly error
|
|
return $controller->httpError(403);
|
|
}
|
|
|
|
$actions = new FieldList();
|
|
if($this->record->ID !== 0) {
|
|
if($canEdit) {
|
|
$actions->push(FormAction::create('doSave', _t('GridFieldDetailForm.Save', 'Save'))
|
|
->setUseButtonTag(true)
|
|
->addExtraClass('ss-ui-action-constructive')
|
|
->setAttribute('data-icon', 'accept'));
|
|
}
|
|
|
|
if($canDelete) {
|
|
$actions->push(FormAction::create('doDelete', _t('GridFieldDetailForm.Delete', 'Delete'))
|
|
->setUseButtonTag(true)
|
|
->addExtraClass('ss-ui-action-destructive action-delete'));
|
|
}
|
|
|
|
}else{ // adding new record
|
|
//Change the Save label to 'Create'
|
|
$actions->push(FormAction::create('doSave', _t('GridFieldDetailForm.Create', 'Create'))
|
|
->setUseButtonTag(true)
|
|
->addExtraClass('ss-ui-action-constructive')
|
|
->setAttribute('data-icon', 'add'));
|
|
|
|
// Add a Cancel link which is a button-like link and link back to one level up.
|
|
$curmbs = $this->Breadcrumbs();
|
|
if($curmbs && $curmbs->count()>=2){
|
|
$one_level_up = $curmbs->offsetGet($curmbs->count()-2);
|
|
$text = sprintf(
|
|
"<a class=\"%s\" href=\"%s\">%s</a>",
|
|
"crumb ss-ui-button ss-ui-action-destructive cms-panel-link ui-corner-all", // CSS classes
|
|
$one_level_up->Link, // url
|
|
_t('GridFieldDetailForm.CancelBtn', 'Cancel') // label
|
|
);
|
|
$actions->push(new LiteralField('cancelbutton', $text));
|
|
}
|
|
}
|
|
|
|
$fields = $this->component->getFields();
|
|
if(!$fields) $fields = $this->record->getCMSFields();
|
|
|
|
// If we are creating a new record in a has-many list, then
|
|
// pre-populate the record's foreign key. Also disable the form field as
|
|
// it has no effect.
|
|
if($list instanceof HasManyList) {
|
|
$key = $list->getForeignKey();
|
|
$id = $list->getForeignID();
|
|
|
|
if(!$this->record->isInDB()) {
|
|
$this->record->$key = $id;
|
|
}
|
|
|
|
if($field = $fields->dataFieldByName($key)) {
|
|
$fields->makeFieldReadonly($field);
|
|
}
|
|
}
|
|
|
|
// Caution: API violation. Form expects a Controller, but we are giving it a RequestHandler instead.
|
|
// Thanks to this however, we are able to nest GridFields, and also access the initial Controller by
|
|
// dereferencing GridFieldDetailForm_ItemRequest->getController() multiple times. See getToplevelController
|
|
// below.
|
|
$form = new Form(
|
|
$this,
|
|
'ItemEditForm',
|
|
$fields,
|
|
$actions,
|
|
$this->component->getValidator()
|
|
);
|
|
|
|
$form->loadDataFrom($this->record, $this->record->ID == 0 ? Form::MERGE_IGNORE_FALSEISH : Form::MERGE_DEFAULT);
|
|
|
|
if($this->record->ID && !$canEdit) {
|
|
// Restrict editing of existing records
|
|
$form->makeReadonly();
|
|
// Hack to re-enable delete button if user can delete
|
|
if ($canDelete) {
|
|
$form->Actions()->fieldByName('action_doDelete')->setReadonly(false);
|
|
}
|
|
} elseif(!$this->record->ID && !$canCreate) {
|
|
// Restrict creation of new records
|
|
$form->makeReadonly();
|
|
}
|
|
|
|
// Load many_many extraData for record.
|
|
// Fields with the correct 'ManyMany' namespace need to be added manually through getCMSFields().
|
|
if($list instanceof ManyManyList) {
|
|
$extraData = $list->getExtraData('', $this->record->ID);
|
|
$form->loadDataFrom(array('ManyMany' => $extraData));
|
|
}
|
|
|
|
// TODO Coupling with CMS
|
|
$toplevelController = $this->getToplevelController();
|
|
if($toplevelController && $toplevelController instanceof LeftAndMain) {
|
|
// Always show with base template (full width, no other panels),
|
|
// regardless of overloaded CMS controller templates.
|
|
// TODO Allow customization, e.g. to display an edit form alongside a search form from the CMS controller
|
|
$form->setTemplate('LeftAndMain_EditForm');
|
|
$form->addExtraClass('cms-content cms-edit-form center');
|
|
$form->setAttribute('data-pjax-fragment', 'CurrentForm Content');
|
|
if($form->Fields()->hasTabset()) {
|
|
$form->Fields()->findOrMakeTab('Root')->setTemplate('CMSTabSet');
|
|
$form->addExtraClass('cms-tabset');
|
|
}
|
|
|
|
$form->Backlink = $this->getBackLink();
|
|
}
|
|
|
|
$cb = $this->component->getItemEditFormCallback();
|
|
if($cb) $cb($form, $this);
|
|
$this->extend("updateItemEditForm", $form);
|
|
return $form;
|
|
}
|
|
|
|
/**
|
|
* Traverse the nested RequestHandlers until we reach something that's not GridFieldDetailForm_ItemRequest.
|
|
* This allows us to access the Controller responsible for invoking the top-level GridField.
|
|
* This should be equivalent to getting the controller off the top of the controller stack via Controller::curr(),
|
|
* but allows us to avoid accessing the global state.
|
|
*
|
|
* GridFieldDetailForm_ItemRequests are RequestHandlers, and as such they are not part of the controller stack.
|
|
*
|
|
* @return Controller
|
|
*/
|
|
protected function getToplevelController() {
|
|
$c = $this->popupController;
|
|
while($c && $c instanceof GridFieldDetailForm_ItemRequest) {
|
|
$c = $c->getController();
|
|
}
|
|
return $c;
|
|
}
|
|
|
|
protected function getBackLink(){
|
|
// TODO Coupling with CMS
|
|
$backlink = '';
|
|
$toplevelController = $this->getToplevelController();
|
|
if($toplevelController && $toplevelController instanceof LeftAndMain) {
|
|
if($toplevelController->hasMethod('Backlink')) {
|
|
$backlink = $toplevelController->Backlink();
|
|
} elseif($this->popupController->hasMethod('Breadcrumbs')) {
|
|
$parents = $this->popupController->Breadcrumbs(false)->items;
|
|
$backlink = array_pop($parents)->Link;
|
|
}
|
|
}
|
|
if(!$backlink) $backlink = $toplevelController->Link();
|
|
|
|
return $backlink;
|
|
}
|
|
|
|
|
|
|
|
public function doSave($data, $form) {
|
|
$new_record = $this->record->ID == 0;
|
|
$controller = $this->getToplevelController();
|
|
$list = $this->gridField->getList();
|
|
|
|
if($list instanceof ManyManyList) {
|
|
// Data is escaped in ManyManyList->add()
|
|
$extraData = (isset($data['ManyMany'])) ? $data['ManyMany'] : null;
|
|
} else {
|
|
$extraData = null;
|
|
}
|
|
|
|
if(!$this->record->canEdit()) {
|
|
return $controller->httpError(403);
|
|
}
|
|
|
|
if (isset($data['ClassName']) && $data['ClassName'] != $this->record->ClassName) {
|
|
$newClassName = $data['ClassName'];
|
|
// The records originally saved attribute was overwritten by $form->saveInto($record) before.
|
|
// This is necessary for newClassInstance() to work as expected, and trigger change detection
|
|
// on the ClassName attribute
|
|
$this->record->setClassName($this->record->ClassName);
|
|
// Replace $record with a new instance
|
|
$this->record = $this->record->newClassInstance($newClassName);
|
|
}
|
|
|
|
try {
|
|
$form->saveInto($this->record);
|
|
$this->record->write();
|
|
$list->add($this->record, $extraData);
|
|
} catch(ValidationException $e) {
|
|
$form->sessionMessage($e->getResult()->message(), 'bad');
|
|
$responseNegotiator = new PjaxResponseNegotiator(array(
|
|
'CurrentForm' => function() use(&$form) {
|
|
return $form->forTemplate();
|
|
},
|
|
'default' => function() use(&$controller) {
|
|
return $controller->redirectBack();
|
|
}
|
|
));
|
|
if($controller->getRequest()->isAjax()){
|
|
$controller->getRequest()->addHeader('X-Pjax', 'CurrentForm');
|
|
}
|
|
return $responseNegotiator->respond($controller->getRequest());
|
|
}
|
|
|
|
// TODO Save this item into the given relationship
|
|
|
|
// TODO Allow HTML in form messages
|
|
// $link = '<a href="' . $this->Link('edit') . '">"'
|
|
// . htmlspecialchars($this->record->Title, ENT_QUOTES)
|
|
// . '"</a>';
|
|
$link = '"' . $this->record->Title . '"';
|
|
$message = _t(
|
|
'GridFieldDetailForm.Saved',
|
|
'Saved {name} {link}',
|
|
array(
|
|
'name' => $this->record->i18n_singular_name(),
|
|
'link' => $link
|
|
)
|
|
);
|
|
|
|
$form->sessionMessage($message, 'good');
|
|
|
|
if($new_record) {
|
|
return $controller->redirect($this->Link());
|
|
} elseif($this->gridField->getList()->byId($this->record->ID)) {
|
|
// Return new view, as we can't do a "virtual redirect" via the CMS Ajax
|
|
// to the same URL (it assumes that its content is already current, and doesn't reload)
|
|
return $this->edit($controller->getRequest());
|
|
} else {
|
|
// Changes to the record properties might've excluded the record from
|
|
// a filtered list, so return back to the main view if it can't be found
|
|
$noActionURL = $controller->removeAction($data['url']);
|
|
$controller->getRequest()->addHeader('X-Pjax', 'Content');
|
|
return $controller->redirect($noActionURL, 302);
|
|
}
|
|
}
|
|
|
|
public function doDelete($data, $form) {
|
|
$title = $this->record->Title;
|
|
try {
|
|
if (!$this->record->canDelete()) {
|
|
throw new ValidationException(
|
|
_t('GridFieldDetailForm.DeletePermissionsFailure',"No delete permissions"),0);
|
|
}
|
|
|
|
$this->record->delete();
|
|
} catch(ValidationException $e) {
|
|
$form->sessionMessage($e->getResult()->message(), 'bad');
|
|
return $this->getToplevelController()->redirectBack();
|
|
}
|
|
|
|
$message = sprintf(
|
|
_t('GridFieldDetailForm.Deleted', 'Deleted %s %s'),
|
|
$this->record->i18n_singular_name(),
|
|
htmlspecialchars($title, ENT_QUOTES)
|
|
);
|
|
|
|
$toplevelController = $this->getToplevelController();
|
|
if($toplevelController && $toplevelController instanceof LeftAndMain) {
|
|
$backForm = $toplevelController->getEditForm();
|
|
$backForm->sessionMessage($message, 'good');
|
|
} else {
|
|
$form->sessionMessage($message, 'good');
|
|
}
|
|
|
|
//when an item is deleted, redirect to the parent controller
|
|
$controller = $this->getToplevelController();
|
|
$controller->getRequest()->addHeader('X-Pjax', 'Content'); // Force a content refresh
|
|
|
|
return $controller->redirect($this->getBacklink(), 302); //redirect back to admin section
|
|
}
|
|
|
|
/**
|
|
* @param String
|
|
*/
|
|
public function setTemplate($template) {
|
|
$this->template = $template;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return String
|
|
*/
|
|
public function getTemplate() {
|
|
return $this->template;
|
|
}
|
|
|
|
/**
|
|
* @return Controller
|
|
*/
|
|
public function getController() {
|
|
return $this->popupController;
|
|
}
|
|
|
|
/**
|
|
* @return GridField
|
|
*/
|
|
public function getGridField() {
|
|
return $this->gridField;
|
|
}
|
|
|
|
/**
|
|
* CMS-specific functionality: Passes through navigation breadcrumbs
|
|
* to the template, and includes the currently edited record (if any).
|
|
* see {@link LeftAndMain->Breadcrumbs()} for details.
|
|
*
|
|
* @param boolean $unlinked
|
|
* @return ArrayData
|
|
*/
|
|
public function Breadcrumbs($unlinked = false) {
|
|
if(!$this->popupController->hasMethod('Breadcrumbs')) return;
|
|
|
|
$items = $this->popupController->Breadcrumbs($unlinked);
|
|
if($this->record && $this->record->ID) {
|
|
$items->push(new ArrayData(array(
|
|
'Title' => $this->record->Title,
|
|
'Link' => $this->Link()
|
|
)));
|
|
} else {
|
|
$items->push(new ArrayData(array(
|
|
'Title' => sprintf(_t('GridField.NewRecord', 'New %s'), $this->record->i18n_singular_name()),
|
|
'Link' => false
|
|
)));
|
|
}
|
|
|
|
return $items;
|
|
}
|
|
}
|