mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
8d670283c9
As ModelAdmin puts classes directly into links, a namespaced class has its \s turned into /s, breaking the links. This escapes them by converting each \ to a -, then converting them back when loading.
459 lines
14 KiB
PHP
459 lines
14 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 SearchContext
|
|
*
|
|
* @package cms
|
|
* @subpackage core
|
|
*/
|
|
abstract class ModelAdmin extends LeftAndMain {
|
|
|
|
static $url_rule = '/$ModelClass/$Action';
|
|
|
|
/**
|
|
* List of all managed {@link DataObject}s in this interface.
|
|
*
|
|
* Simple notation with class names only:
|
|
* <code>
|
|
* array('MyObjectClass','MyOtherObjectClass')
|
|
* </code>
|
|
*
|
|
* Extended notation with options (e.g. custom titles):
|
|
* <code>
|
|
* array(
|
|
* 'MyObjectClass' => array('title' => "Custom title")
|
|
* )
|
|
* </code>
|
|
*
|
|
* Available options:
|
|
* - 'title': Set custom titles for the tabs or dropdown names
|
|
*
|
|
* @var array|string
|
|
*/
|
|
public static $managed_models = null;
|
|
|
|
public static $allowed_actions = array(
|
|
'ImportForm',
|
|
'SearchForm',
|
|
);
|
|
|
|
public static $url_handlers = array(
|
|
'$ModelClass/$Action' => 'handleAction'
|
|
);
|
|
|
|
/**
|
|
* @var String
|
|
*/
|
|
protected $modelClass;
|
|
|
|
/**
|
|
* Change this variable if you don't want the Import from CSV form to appear.
|
|
* This variable can be a boolean or an array.
|
|
* If array, you can list className you want the form to appear on. i.e. array('myClassOne','myClasstwo')
|
|
*/
|
|
public $showImportForm = true;
|
|
|
|
/**
|
|
* List of all {@link DataObject}s which can be imported through
|
|
* a subclass of {@link BulkLoader} (mostly CSV data).
|
|
* By default {@link CsvBulkLoader} is used, assuming a standard mapping
|
|
* of column names to {@link DataObject} properties/relations.
|
|
*
|
|
* e.g. "BlogEntry" => "BlogEntryCsvBulkLoader"
|
|
*
|
|
* @var array
|
|
*/
|
|
public static $model_importers = null;
|
|
|
|
/**
|
|
* Amount of results showing on a single page.
|
|
*
|
|
* @var int
|
|
*/
|
|
public static $page_length = 30;
|
|
|
|
/**
|
|
* Initialize the model admin interface. Sets up embedded jquery libraries and requisite plugins.
|
|
*/
|
|
public function init() {
|
|
parent::init();
|
|
|
|
$models = $this->getManagedModels();
|
|
|
|
if($this->request->param('ModelClass')) {
|
|
$this->modelClass = $this->unsanitiseClassName($this->request->param('ModelClass'));
|
|
} else {
|
|
reset($models);
|
|
$this->modelClass = key($models);
|
|
}
|
|
|
|
// security check for valid models
|
|
if(!array_key_exists($this->modelClass, $models)) {
|
|
user_error('ModelAdmin::init(): Invalid Model class', E_USER_ERROR);
|
|
}
|
|
|
|
Requirements::javascript(FRAMEWORK_ADMIN_DIR . '/javascript/ModelAdmin.js');
|
|
}
|
|
|
|
public function Link($action = null) {
|
|
if(!$action) $action = $this->sanitiseClassName($this->modelClass);
|
|
return parent::Link($action);
|
|
}
|
|
|
|
function getEditForm($id = null, $fields = null) {
|
|
$list = $this->getList();
|
|
$exportButton = new GridFieldExportButton('before');
|
|
$exportButton->setExportColumns($this->getExportFields());
|
|
$listField = GridField::create(
|
|
$this->sanitiseClassName($this->modelClass),
|
|
false,
|
|
$list,
|
|
$fieldConfig = GridFieldConfig_RecordEditor::create($this->stat('page_length'))
|
|
->addComponent($exportButton)
|
|
->removeComponentsByType('GridFieldFilterHeader')
|
|
->addComponents(new GridFieldPrintButton('before'))
|
|
);
|
|
|
|
// Validation
|
|
if(singleton($this->modelClass)->hasMethod('getCMSValidator')) {
|
|
$detailValidator = singleton($this->modelClass)->getCMSValidator();
|
|
$listField->getConfig()->getComponentByType('GridFieldDetailForm')->setValidator($detailValidator);
|
|
}
|
|
|
|
$form = new Form(
|
|
$this,
|
|
'EditForm',
|
|
new FieldList($listField),
|
|
new FieldList()
|
|
);
|
|
$form->addExtraClass('cms-edit-form cms-panel-padded center');
|
|
$form->setTemplate($this->getTemplatesWithSuffix('_EditForm'));
|
|
$form->setFormAction(Controller::join_links($this->Link($this->sanitiseClassName($this->modelClass)), 'EditForm'));
|
|
$form->setAttribute('data-pjax-fragment', 'CurrentForm');
|
|
|
|
$this->extend('updateEditForm', $form);
|
|
|
|
return $form;
|
|
}
|
|
|
|
/**
|
|
* Define which fields are used in the {@link getEditForm} GridField export.
|
|
* By default, it uses the summary fields from the model definition.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getExportFields() {
|
|
return singleton($this->modelClass)->summaryFields();
|
|
}
|
|
|
|
/**
|
|
* @return SearchContext
|
|
*/
|
|
public function getSearchContext() {
|
|
$context = singleton($this->modelClass)->getDefaultSearchContext();
|
|
|
|
// Namespace fields, for easier detection if a search is present
|
|
foreach($context->getFields() as $field) $field->setName(sprintf('q[%s]', $field->getName()));
|
|
foreach($context->getFilters() as $filter) $filter->setFullName(sprintf('q[%s]', $filter->getFullName()));
|
|
|
|
$this->extend('updateSearchContext', $context);
|
|
|
|
return $context;
|
|
}
|
|
|
|
/**
|
|
* @return Form
|
|
*/
|
|
public function SearchForm() {
|
|
$context = $this->getSearchContext();
|
|
$form = new Form($this, "SearchForm",
|
|
$context->getSearchFields(),
|
|
new FieldList(
|
|
Object::create('FormAction', 'search', _t('MemberTableField.APPLY FILTER', 'Apply Filter'))
|
|
->setUseButtonTag(true)->addExtraClass('ss-ui-action-constructive'),
|
|
Object::create('ResetFormAction','clearsearch', _t('ModelAdmin.RESET','Reset'))
|
|
->setUseButtonTag(true)
|
|
),
|
|
new RequiredFields()
|
|
);
|
|
$form->setFormMethod('get');
|
|
$form->setFormAction($this->Link($this->sanitiseClassName($this->modelClass)));
|
|
$form->addExtraClass('cms-search-form');
|
|
$form->disableSecurityToken();
|
|
$form->loadDataFrom($this->request->getVars());
|
|
|
|
$this->extend('updateSearchForm', $form);
|
|
|
|
return $form;
|
|
}
|
|
|
|
public function getList() {
|
|
$context = $this->getSearchContext();
|
|
$params = $this->request->requestVar('q');
|
|
$list = $context->getResults($params);
|
|
|
|
$this->extend('updateList', $list);
|
|
|
|
return $list;
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns managed models' create, search, and import forms
|
|
* @uses SearchContext
|
|
* @uses SearchFilter
|
|
* @return SS_List of forms
|
|
*/
|
|
protected function getManagedModelTabs() {
|
|
$models = $this->getManagedModels();
|
|
$forms = new ArrayList();
|
|
|
|
foreach($models as $class => $options) {
|
|
$forms->push(new ArrayData(array (
|
|
'Title' => $options['title'],
|
|
'ClassName' => $class,
|
|
'Link' => $this->Link($this->sanitiseClassName($class)),
|
|
'LinkOrCurrent' => ($class == $this->modelClass) ? 'current' : 'link'
|
|
)));
|
|
}
|
|
|
|
return $forms;
|
|
}
|
|
|
|
/**
|
|
* Sanitise a model class' name for inclusion in a link
|
|
* @return string
|
|
*/
|
|
protected function sanitiseClassName($class) {
|
|
return str_replace('\\', '-', $class);
|
|
}
|
|
|
|
/**
|
|
* Unsanitise a model class' name from a URL param
|
|
* @return string
|
|
*/
|
|
protected function unsanitiseClassName($class) {
|
|
return str_replace('-', '\\', $class);
|
|
}
|
|
|
|
/**
|
|
* @return array Map of class name to an array of 'title' (see {@link $managed_models})
|
|
*/
|
|
function getManagedModels() {
|
|
$models = $this->stat('managed_models');
|
|
if(is_string($models)) {
|
|
$models = array($models);
|
|
}
|
|
if(!count($models)) {
|
|
user_error(
|
|
'ModelAdmin::getManagedModels():
|
|
You need to specify at least one DataObject subclass in public static $managed_models.
|
|
Make sure that this property is defined, and that its visibility is set to "public"',
|
|
E_USER_ERROR
|
|
);
|
|
}
|
|
|
|
// Normalize models to have their model class in array key
|
|
foreach($models as $k => $v) {
|
|
if(is_numeric($k)) {
|
|
$models[$v] = array('title' => singleton($v)->i18n_singular_name());
|
|
unset($models[$k]);
|
|
}
|
|
}
|
|
|
|
return $models;
|
|
}
|
|
|
|
/**
|
|
* Returns all importers defined in {@link self::$model_importers}.
|
|
* If none are defined, we fall back to {@link self::managed_models}
|
|
* with a default {@link CsvBulkLoader} class. In this case the column names of the first row
|
|
* in the CSV file are assumed to have direct mappings to properties on the object.
|
|
*
|
|
* @return array Map of model class names to importer instances
|
|
*/
|
|
function getModelImporters() {
|
|
$importerClasses = $this->stat('model_importers');
|
|
|
|
// fallback to all defined models if not explicitly defined
|
|
if(is_null($importerClasses)) {
|
|
$models = $this->getManagedModels();
|
|
foreach($models as $modelName => $options) {
|
|
$importerClasses[$modelName] = 'CsvBulkLoader';
|
|
}
|
|
}
|
|
|
|
$importers = array();
|
|
foreach($importerClasses as $modelClass => $importerClass) {
|
|
$importers[$modelClass] = new $importerClass($modelClass);
|
|
}
|
|
|
|
return $importers;
|
|
}
|
|
|
|
/**
|
|
* Generate a CSV import form for a single {@link DataObject} subclass.
|
|
*
|
|
* @return Form
|
|
*/
|
|
public function ImportForm() {
|
|
$modelName = $this->modelClass;
|
|
// check if a import form should be generated
|
|
if(!$this->showImportForm || (is_array($this->showImportForm) && !in_array($modelName,$this->showImportForm))) {
|
|
return false;
|
|
}
|
|
|
|
$importers = $this->getModelImporters();
|
|
if(!$importers || !isset($importers[$modelName])) return false;
|
|
|
|
if(!singleton($modelName)->canCreate(Member::currentUser())) return false;
|
|
|
|
$fields = new FieldList(
|
|
new HiddenField('ClassName', _t('ModelAdmin.CLASSTYPE'), $modelName),
|
|
new FileField('_CsvFile', false)
|
|
);
|
|
|
|
// get HTML specification for each import (column names etc.)
|
|
$importerClass = $importers[$modelName];
|
|
$importer = new $importerClass($modelName);
|
|
$spec = $importer->getImportSpec();
|
|
$specFields = new ArrayList();
|
|
foreach($spec['fields'] as $name => $desc) {
|
|
$specFields->push(new ArrayData(array('Name' => $name, 'Description' => $desc)));
|
|
}
|
|
$specRelations = new ArrayList();
|
|
foreach($spec['relations'] as $name => $desc) {
|
|
$specRelations->push(new ArrayData(array('Name' => $name, 'Description' => $desc)));
|
|
}
|
|
$specHTML = $this->customise(array(
|
|
'ModelName' => Convert::raw2att($modelName),
|
|
'Fields' => $specFields,
|
|
'Relations' => $specRelations,
|
|
))->renderWith('ModelAdmin_ImportSpec');
|
|
|
|
$fields->push(new LiteralField("SpecFor{$modelName}", $specHTML));
|
|
$fields->push(new CheckboxField('EmptyBeforeImport', 'Clear Database before import', false));
|
|
|
|
$actions = new FieldList(
|
|
new FormAction('import', _t('ModelAdmin.IMPORT', 'Import from CSV'))
|
|
);
|
|
|
|
$form = new Form(
|
|
$this,
|
|
"ImportForm",
|
|
$fields,
|
|
$actions
|
|
);
|
|
$form->setFormAction(Controller::join_links($this->Link($this->sanitiseClassName($this->modelClass)), 'ImportForm'));
|
|
|
|
$this->extend('updateImportForm', $form);
|
|
|
|
return $form;
|
|
}
|
|
|
|
/**
|
|
* Imports the submitted CSV file based on specifications given in
|
|
* {@link self::model_importers}.
|
|
* Redirects back with a success/failure message.
|
|
*
|
|
* @todo Figure out ajax submission of files via jQuery.form plugin
|
|
*
|
|
* @param array $data
|
|
* @param Form $form
|
|
* @param SS_HTTPRequest $request
|
|
*/
|
|
function import($data, $form, $request) {
|
|
if(!$this->showImportForm || (is_array($this->showImportForm) && !in_array($this->modelClass,$this->showImportForm))) {
|
|
return false;
|
|
}
|
|
|
|
$importers = $this->getModelImporters();
|
|
$loader = $importers[$this->modelClass];
|
|
|
|
// File wasn't properly uploaded, show a reminder to the user
|
|
if(
|
|
empty($_FILES['_CsvFile']['tmp_name']) ||
|
|
file_get_contents($_FILES['_CsvFile']['tmp_name']) == ''
|
|
) {
|
|
$form->sessionMessage(_t('ModelAdmin.NOCSVFILE', 'Please browse for a CSV file to import'), 'good');
|
|
$this->redirectBack();
|
|
return false;
|
|
}
|
|
|
|
if (!empty($data['EmptyBeforeImport']) && $data['EmptyBeforeImport']) { //clear database before import
|
|
$loader->deleteExistingRecords = true;
|
|
}
|
|
$results = $loader->load($_FILES['_CsvFile']['tmp_name']);
|
|
|
|
$message = '';
|
|
if($results->CreatedCount()) $message .= _t(
|
|
'ModelAdmin.IMPORTEDRECORDS', "Imported {count} records.",
|
|
array('count' => $results->CreatedCount())
|
|
);
|
|
if($results->UpdatedCount()) $message .= _t(
|
|
'ModelAdmin.UPDATEDRECORDS', "Updated {count} records.",
|
|
array('count' => $results->UpdatedCount())
|
|
);
|
|
if($results->DeletedCount()) $message .= _t(
|
|
'ModelAdmin.DELETEDRECORDS', "Deleted {count} records.",
|
|
array('count' => $results->DeletedCount())
|
|
);
|
|
if(!$results->CreatedCount() && !$results->UpdatedCount()) $message .= _t('ModelAdmin.NOIMPORT', "Nothing to import");
|
|
|
|
$form->sessionMessage($message, 'good');
|
|
$this->redirectBack();
|
|
}
|
|
|
|
/**
|
|
* @return ArrayList
|
|
*/
|
|
public function Breadcrumbs($unlinked = false) {
|
|
$items = parent::Breadcrumbs($unlinked);
|
|
|
|
// Show the class name rather than ModelAdmin title as root node
|
|
$models = $this->getManagedModels();
|
|
$items[0]->Title = $models[$this->modelClass]['title'];
|
|
$items[0]->Link = $this->Link($this->sanitiseClassName($this->modelClass));
|
|
|
|
return $items;
|
|
}
|
|
|
|
/**
|
|
* overwrite the static page_length of the admin panel,
|
|
* should be called in the project _config file.
|
|
*/
|
|
static function set_page_length($length){
|
|
self::$page_length = $length;
|
|
}
|
|
|
|
/**
|
|
* Return the static page_length of the admin, default as 30
|
|
*/
|
|
static function get_page_length(){
|
|
return self::$page_length;
|
|
}
|
|
|
|
}
|