mirror of
https://github.com/silverstripe/silverstripe-cms
synced 2024-10-22 08:05:56 +02:00
05ad3c8e1c
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/cms/trunk@60203 467b73ca-7a2a-4603-9d3b-597d59a354a9
333 lines
8.5 KiB
PHP
333 lines
8.5 KiB
PHP
<?php
|
|
/**
|
|
* Generates a three-pane UI for editing model classes,
|
|
* with an automatically generated search panel, tabular results
|
|
* and edit forms.
|
|
* Relies on data such as {@link DataObject::$db} and {@DataObject::getCMSFields()}
|
|
* to scaffold interfaces "out of the box", while at the same time providing
|
|
* flexibility to customize the default output.
|
|
*
|
|
* Add a route (note - this doc is not currently in sync with the code, need to update)
|
|
* <code>
|
|
* Director::addRules(50, array('admin/mymodel/$Class/$Action/$ID' => 'MyModelAdmin'));
|
|
* </code>
|
|
*
|
|
* @todo saving logic (should mostly use Form->saveInto() and iterate over relations)
|
|
* @todo ajax form loading and saving
|
|
* @todo ajax result display
|
|
* @todo relation formfield scaffolding (one tab per relation) - relations don't have DBField sublclasses, we do
|
|
* we define the scaffold defaults. can be ComplexTableField instances for a start.
|
|
* @todo has_many/many_many relation autocomplete field (HasManyComplexTableField doesn't work well with larger datasets)
|
|
*
|
|
* Long term TODOs:
|
|
* @todo Hook into RESTful interface on DataObjects (yet to be developed)
|
|
* @todo Permission control via datamodel and Form class
|
|
*
|
|
* @uses {@link SearchContext}
|
|
*
|
|
* @package cms
|
|
*/
|
|
abstract class ModelAdmin extends LeftAndMain {
|
|
|
|
/**
|
|
* List of all managed {@link DataObject}s in this interface.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected static $managed_models = null;
|
|
|
|
public static $allowed_actions = array(
|
|
'add',
|
|
'edit',
|
|
'delete'
|
|
);
|
|
|
|
public function init() {
|
|
parent::init();
|
|
|
|
// security check for valid models
|
|
if(isset($this->urlParams['Model']) && !in_array($this->urlParams['Model'], $this->getManagedModels())) {
|
|
user_error('ModelAdmin::init(): Invalid Model class', E_USER_ERROR);
|
|
}
|
|
|
|
Requirements::css('cms/css/ModelAdmin.css');
|
|
}
|
|
|
|
/**
|
|
* Return default link to this controller
|
|
*
|
|
* @todo We've specified this in Director::addRules(), why repeat?
|
|
*
|
|
* @return string
|
|
*/
|
|
public function Link() {
|
|
return 'admin/crm/' . implode('/', array_values(array_unique($this->urlParams)));
|
|
}
|
|
|
|
/**
|
|
* Create empty edit form (scaffolded from DataObject->getCMSFields() by default).
|
|
* Can be called either through {@link AddForm()} or directly through URL:
|
|
* "/myadminroute/add/MyModelClass"
|
|
*/
|
|
public function add($data) {
|
|
$className = (isset($data['ClassName'])) ? $data['ClassName'] : $this->urlParams['ClassName'];
|
|
|
|
if(!isset($className) || !in_array($data['ClassName'], $this->getManagedModels())) return false;
|
|
|
|
$form = $this->getEditForm($data['ClassName']);
|
|
return $form->forTemplate();
|
|
}
|
|
|
|
/**
|
|
* Edit forms (scaffolded from DataObject->getCMSFields() by default).
|
|
*
|
|
* @param array $data
|
|
* @param Form $form
|
|
*/
|
|
public function edit($data, $form) {
|
|
if(!isset($data['ClassName']) || !in_array($data['ClassName'], $this->getManagedModels())) return false;
|
|
|
|
// @todo generate editform
|
|
}
|
|
|
|
/**
|
|
* @todo documentation
|
|
*
|
|
* @param array $data
|
|
* @param Form $form
|
|
*/
|
|
public function save($data, $form) {
|
|
// @todo implementation
|
|
}
|
|
|
|
/**
|
|
* Allows to choose which record needs to be created.
|
|
*
|
|
* @return Form
|
|
*/
|
|
protected function AddForm() {
|
|
$models = $this->getManagedModels();
|
|
$modelMap = array();
|
|
foreach($models as $modelName) $modelMap[$modelName] = singleton($modelName)->singular_name();
|
|
|
|
$form = new Form(
|
|
$this,
|
|
'AddForm_add',
|
|
new FieldSet(
|
|
new DropdownField('ClassName', 'Type', $modelMap)
|
|
),
|
|
new FieldSet(
|
|
new FormAction('add', _t('GenericDataAdmin.CREATE'))
|
|
)
|
|
);
|
|
return $form;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @uses {@link SearchContext}
|
|
* @uses {@link SearchFilter}
|
|
* @return Form
|
|
*/
|
|
protected function getSearchForms() {
|
|
$modelClasses = $this->getManagedModels();
|
|
|
|
$forms = new DataObjectSet();
|
|
foreach($modelClasses as $modelClass) {
|
|
$modelObj = singleton($modelClass);
|
|
|
|
$form = $this->getSearchFormForModel($modelClass);
|
|
|
|
$forms->push(new ArrayData(array(
|
|
'Form' => $form,
|
|
'Title' => $modelObj->singular_name()
|
|
)));
|
|
}
|
|
|
|
return $forms;
|
|
}
|
|
|
|
/**
|
|
* Enter description here...
|
|
*
|
|
* @todo Add customizeable validator
|
|
*
|
|
* @param string $modelClass
|
|
*/
|
|
protected function getEditForm($modelClass) {
|
|
$modelObj = singleton($modelClass);
|
|
|
|
$fields = $this->getFieldsForModel($modelObj);
|
|
|
|
$actions = $this->getActionsForModel($modelObj);
|
|
|
|
$validator = $this->getValidatorForModel($modelObj);
|
|
|
|
$form = new Form(
|
|
$this,
|
|
'ModelEditForm',
|
|
$fields,
|
|
$actions,
|
|
$validator
|
|
);
|
|
|
|
return $form;
|
|
}
|
|
|
|
// ############# Utility Methods ##############
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
protected function getManagedModels() {
|
|
$models = $this->stat('managed_models');
|
|
if(!count($models)) user_error('ModelAdmin::getManagedModels():
|
|
You need to specify at least one DataObject subclass in $managed_models', E_USER_ERROR);
|
|
|
|
return $models;
|
|
}
|
|
|
|
/**
|
|
* Get all cms fields for the model
|
|
* (defaults to {@link DataObject->getCMSFields()}).
|
|
*
|
|
* @todo Make method hook customizeable
|
|
*
|
|
* @param DataObject $modelObj
|
|
* @return FieldSet
|
|
*/
|
|
protected function getFieldsForModel($modelObj) {
|
|
return $modelObj->getCMSFields();
|
|
}
|
|
|
|
/**
|
|
* Get all actions which are possible in this controller,
|
|
* and allowed by the model security.
|
|
*
|
|
* @todo Hook into model security once its is implemented
|
|
*
|
|
* @param DataObject $modelObj
|
|
* @return FieldSet
|
|
*/
|
|
protected function getActionsForModel($modelObj) {
|
|
$actions = new FieldSet(
|
|
new FormAction('save', _t('GenericDataAdmin.SAVE')),
|
|
new FormAction('delete', _t('GenericDataAdmin.DELETE'))
|
|
);
|
|
|
|
return $actions;
|
|
}
|
|
|
|
/**
|
|
* NOT IMPLEMENTED
|
|
* Get a valdidator for the model.
|
|
*
|
|
* @todo Hook into model security once its is implemented
|
|
*
|
|
* @param DataObject $modelObj
|
|
* @return FieldSet
|
|
*/
|
|
protected function getValidatorForModel($modelObj) {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Get a search form for a single {@link DataObject} subclass.
|
|
*
|
|
* @param string $modelClass
|
|
* @return FieldSet
|
|
*/
|
|
protected function getSearchFormForModel($modelClass) {
|
|
$context = singleton($modelClass)->getDefaultSearchContext();
|
|
|
|
$form = new Form(
|
|
$this,
|
|
"SearchForm_search_{$modelClass}",
|
|
$context->getSearchFields(),
|
|
new FieldSet(
|
|
new FormAction('search', _t('MemberTableField.SEARCH'))
|
|
)
|
|
);
|
|
//can't set generic search form as GET because of weirdness with FormObjectLink
|
|
//$form->setFormMethod('get');
|
|
return $form;
|
|
}
|
|
|
|
/**
|
|
* Overwrite the default form action with the path to the DataObject filter
|
|
* (relies on the search form having the specifically named id as 'SearchForm_DataObject')
|
|
*
|
|
* @todo extract hard-coded prefix and generate from Director settings
|
|
*/
|
|
function FormObjectLink($formName) {
|
|
$segments = explode('_', $formName);
|
|
if (count($segments) == 3) {
|
|
return Director::absoluteBaseURL()."admin/crm/{$segments[1]}/{$segments[2]}";
|
|
} elseif (count($segments) == 2) {
|
|
return Director::absoluteBaseURL()."admin/crm/{$segments[1]}";
|
|
} else {
|
|
return "?executeForm=$formName";
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Action to render a data object collection, using the model context to provide filters
|
|
* and paging.
|
|
*/
|
|
function search() {
|
|
$className = $this->urlParams['ClassName'];
|
|
if (in_array($className, $this->getManagedModels())) {
|
|
$model = singleton($className);
|
|
// @todo need to filter post vars
|
|
$searchKeys = array_intersect_key($_POST, $model->searchableFields());
|
|
$context = $model->getDefaultSearchContext();
|
|
$results = $context->getResultSet($searchKeys);
|
|
if ($results) {
|
|
echo "<table>";
|
|
foreach($results as $row) {
|
|
$uri = Director::absoluteBaseUrl();
|
|
echo "<tr id=\"{$uri}admin/crm/view/$className/$row->ID\">";
|
|
foreach($model->searchableFields() as $key=>$val) {
|
|
echo "<td>";
|
|
echo $row->getField($key);
|
|
echo "</td>";
|
|
}
|
|
echo "</tr>";
|
|
}
|
|
echo "</table>";
|
|
} else {
|
|
echo "<p>No results found</p>";
|
|
}
|
|
}
|
|
die();
|
|
}
|
|
|
|
/**
|
|
* View a generic model using a form object to render a partial HTML
|
|
* fragment to be embedded via Ajax calls.
|
|
*/
|
|
function view() {
|
|
$className = $this->urlParams['ClassName'];
|
|
$ID = $this->urlParams['ID'];
|
|
|
|
if (in_array($className, $this->getManagedModels())) {
|
|
|
|
$model = DataObject::get_by_id($className, $ID);
|
|
|
|
$fields = $model->getCMSFields();
|
|
|
|
$actions = new FieldSet(
|
|
new FormAction('save', 'Save')
|
|
);
|
|
|
|
$form = new Form($this, $className, $fields, $actions);
|
|
$form->makeReadonly();
|
|
$form->loadNonBlankDataFrom($model);
|
|
return $form->forTemplate();
|
|
}
|
|
}
|
|
|
|
|
|
|
|
}
|
|
?>
|