silverstripe-framework/Forms/TreeDropdownField.php

570 lines
16 KiB
PHP
Raw Normal View History

<?php
namespace SilverStripe\Forms;
2016-09-09 08:43:05 +02:00
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Core\Convert;
use SilverStripe\Core\Config\Config;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\Hierarchy\Hierarchy;
use SilverStripe\View\Requirements;
use SilverStripe\View\ViewableData;
use Exception;
use InvalidArgumentException;
2016-06-23 01:37:22 +02:00
/**
2014-08-15 08:53:05 +02:00
* Dropdown-like field that allows you to select an item from a hierarchical
* AJAX-expandable tree.
2014-08-15 08:53:05 +02:00
*
* Creates a field which opens a dropdown (actually a div via javascript
* included for you) which contains a tree with the ability to select a singular
* item for the value of the field. This field has the ability to store one-to-one
* joins related to hierarchy or a hierarchy based filter.
2014-08-15 08:53:05 +02:00
*
* **Note:** your source object must use an implementation of hierarchy for this
* field to generate the tree correctly, e.g. {@link Group}, {@link SiteTree} etc.
2014-08-15 08:53:05 +02:00
*
* All operations are carried out through javascript and provides no fallback
* to non JS.
2014-08-15 08:53:05 +02:00
*
* <b>Usage</b>.
2014-08-15 08:53:05 +02:00
*
* <code>
* static $has_one = array(
* 'RightContent' => 'SiteTree'
* );
2014-08-15 08:53:05 +02:00
*
* function getCMSFields() {
* ...
* $treedropdownfield = new TreeDropdownField("RightContentID", "Choose a page to show on the right:", "SiteTree");
* ..
* }
* </code>
2014-08-15 08:53:05 +02:00
*
* This will generate a tree allowing the user to expand and contract subsections
* to find the appropriate page to save to the field.
2014-08-15 08:53:05 +02:00
*
* Caution: The form field does not include any JavaScript or CSS when used outside of the CMS context,
* since the required frontend dependencies are included through CMS bundling.
*
2012-06-20 23:59:16 +02:00
* @see TreeMultiselectField for the same implementation allowing multiple selections
* @see DropdownField for a simple dropdown field.
* @see CheckboxSetField for multiple selections through checkboxes.
* @see OptionsetField for single selections via radiobuttons.
*/
class TreeDropdownField extends FormField {
2014-08-15 08:53:05 +02:00
private static $url_handlers = array(
'$Action!/$ID' => '$Action'
);
2014-08-15 08:53:05 +02:00
private static $allowed_actions = array(
'tree'
);
2014-08-15 08:53:05 +02:00
/**
* @ignore
*/
protected $sourceObject, $keyField, $labelField, $filterCallback,
$disableCallback, $searchCallback, $baseID = 0;
2012-03-07 22:07:40 +01:00
/**
* @var string default child method in Hierarchy->getChildrenAsUL
2012-03-07 22:07:40 +01:00
*/
protected $childrenMethod = 'AllChildrenIncludingDeleted';
2014-08-15 08:53:05 +02:00
/**
* @var string default child counting method in Hierarchy->getChildrenAsUL
*/
protected $numChildrenMethod = 'numChildren';
/**
* Used by field search to leave only the relevant entries
*/
protected $searchIds = null, $showSearch, $searchExpanded = array();
2014-08-15 08:53:05 +02:00
/**
2014-08-15 08:53:05 +02:00
* CAVEAT: for search to work properly $labelField must be a database field,
* or you need to setSearchFunction.
*
* @param string $name the field name
* @param string $title the field label
* @param string|array $sourceObject The object-type to list in the tree. This could
* be one of the following:
* - A DataObject class name with the {@link Hierarchy} extension.
* - An array of key/value pairs, like a {@link DropdownField} source. In
* this case, the field will act like show a flat list of tree items,
* without any hierarchy. This is most useful in conjunction with
* {@link TreeMultiselectField}, for presenting a set of checkboxes in
* a compact view. Note, that all value strings must be XML encoded
* safely prior to being passed in.
*
2014-08-15 08:53:05 +02:00
* @param string $keyField to field on the source class to save as the
* field value (default ID).
2014-08-15 08:53:05 +02:00
* @param string $labelField the field name to show as the human-readable
* value on the tree (default Title).
2014-08-15 08:53:05 +02:00
* @param bool $showSearch enable the ability to search the tree by
* entering the text in the input field.
*/
2016-06-23 01:37:22 +02:00
public function __construct($name, $title = null, $sourceObject = 'SilverStripe\\Security\\Group', $keyField = 'ID',
$labelField = 'TreeTitle', $showSearch = true
2013-01-11 09:59:33 +01:00
) {
$this->sourceObject = $sourceObject;
$this->keyField = $keyField;
$this->labelField = $labelField;
$this->showSearch = $showSearch;
//Extra settings for Folders
if ($sourceObject == 'SilverStripe\\Assets\\Folder') {
$this->childrenMethod = 'ChildFolders';
$this->numChildrenMethod = 'numChildFolders';
}
2014-08-15 08:53:05 +02:00
$this->addExtraClass('single');
parent::__construct($name, $title);
}
2014-08-15 08:53:05 +02:00
/**
2014-08-15 08:53:05 +02:00
* Set the ID of the root node of the tree. This defaults to 0 - i.e.
* displays the whole tree.
*
* @param int $ID
2016-06-23 01:37:22 +02:00
* @return $this
*/
public function setTreeBaseID($ID) {
$this->baseID = (int) $ID;
return $this;
}
2014-08-15 08:53:05 +02:00
/**
2014-08-15 08:53:05 +02:00
* Set a callback used to filter the values of the tree before
* displaying to the user.
*
* @param callback $callback
2016-06-23 01:37:22 +02:00
* @return $this
*/
public function setFilterFunction($callback) {
if(!is_callable($callback, true)) {
throw new InvalidArgumentException('TreeDropdownField->setFilterCallback(): not passed a valid callback');
}
2014-08-15 08:53:05 +02:00
$this->filterCallback = $callback;
return $this;
}
/**
2014-08-15 08:53:05 +02:00
* Set a callback used to disable checkboxes for some items in the tree
*
* @param callback $callback
2016-06-23 01:37:22 +02:00
* @return $this
*/
public function setDisableFunction($callback) {
if(!is_callable($callback, true)) {
throw new InvalidArgumentException('TreeDropdownField->setDisableFunction(): not passed a valid callback');
}
2014-08-15 08:53:05 +02:00
$this->disableCallback = $callback;
return $this;
}
2014-08-15 08:53:05 +02:00
/**
2014-08-15 08:53:05 +02:00
* Set a callback used to search the hierarchy globally, even before
* applying the filter.
*
* @param callback $callback
2016-06-23 01:37:22 +02:00
* @return $this
*/
public function setSearchFunction($callback) {
if(!is_callable($callback, true)) {
throw new InvalidArgumentException('TreeDropdownField->setSearchFunction(): not passed a valid callback');
}
2014-08-15 08:53:05 +02:00
$this->searchCallback = $callback;
return $this;
}
public function getShowSearch() {
return $this->showSearch;
}
/**
2016-06-23 01:37:22 +02:00
* @param bool $bool
* @return $this
*/
public function setShowSearch($bool) {
$this->showSearch = $bool;
return $this;
}
/**
2016-06-23 01:37:22 +02:00
* @param string $method The parameter to ChildrenMethod to use when calling Hierarchy->getChildrenAsUL in
* {@link Hierarchy}. The method specified determines the structure of the returned list. Use "ChildFolders"
* in place of the default to get a drop-down listing with only folders, i.e. not including the child elements in
* the currently selected folder. setNumChildrenMethod() should be used as well for proper functioning.
2014-08-15 08:53:05 +02:00
*
* See {@link Hierarchy} for a complete list of possible methods.
2016-06-23 01:37:22 +02:00
* @return $this
*/
public function setChildrenMethod($method) {
$this->childrenMethod = $method;
2013-01-08 18:32:40 +01:00
return $this;
}
/**
2016-06-23 01:37:22 +02:00
* @param string $method The parameter to numChildrenMethod to use when calling Hierarchy->getChildrenAsUL in
* {@link Hierarchy}. Should be used in conjunction with setChildrenMethod().
*
2016-06-23 01:37:22 +02:00
* @return $this
*/
public function setNumChildrenMethod($method) {
$this->numChildrenMethod = $method;
return $this;
}
/**
2016-06-23 01:37:22 +02:00
* @param array $properties
* @return string
*/
public function Field($properties = array()) {
$item = DataObject::singleton($this->sourceObject);
$emptyTitle = _t(
'DropdownField.CHOOSE_MODEL',
'(Choose {name})',
['name' => $item->i18n_singular_name()]
);
$record = $this->Value() ? $this->objectForKey($this->Value()) : null;
if($record instanceof ViewableData) {
$title = $record->obj($this->labelField)->forTemplate();
} elseif($record) {
$title = Convert::raw2xml($record->{$this->labelField});
}
else {
$title = $emptyTitle;
}
// TODO Implement for TreeMultiSelectField
$metadata = array(
2014-08-15 08:53:05 +02:00
'id' => $record ? $record->ID : null,
'ClassName' => $record ? $record->ClassName : $this->sourceObject
);
$properties = array_merge(
$properties,
array(
'Title' => $title,
'EmptyTitle' => $emptyTitle,
'Metadata' => ($metadata) ? Convert::raw2json($metadata) : null,
)
);
return parent::Field($properties);
}
public function extraClass() {
return implode(' ', array(parent::extraClass(), ($this->showSearch ? "searchable" : null)));
}
2014-08-15 08:53:05 +02:00
/**
* Get the whole tree of a part of the tree via an AJAX request.
*
2016-09-09 08:43:05 +02:00
* @param HTTPRequest $request
* @return string
2016-06-23 01:37:22 +02:00
* @throws Exception
*/
2016-09-09 08:43:05 +02:00
public function tree(HTTPRequest $request) {
// Array sourceObject is an explicit list of values - construct a "flat tree"
if(is_array($this->sourceObject)) {
$output = "<ul class=\"tree\">\n";
foreach($this->sourceObject as $k => $v) {
$output .= '<li id="selector-' . $this->name . '-' . $k . '"><a>' . $v . '</a>';
}
$output .= "</ul>";
return $output;
}
2014-08-15 08:53:05 +02:00
// Regular source specification
$isSubTree = false;
$this->search = $request->requestVar('search');
$id = (is_numeric($request->latestParam('ID')))
? (int)$request->latestParam('ID')
: (int)$request->requestVar('ID');
/** @var DataObject|Hierarchy $obj */
$obj = null;
if($id && !$request->requestVar('forceFullTree')) {
$obj = DataObject::get_by_id($this->sourceObject, $id);
$isSubTree = true;
if(!$obj) {
throw new Exception (
"TreeDropdownField->tree(): the object #$id of type $this->sourceObject could not be found"
);
}
} else {
if($this->baseID) {
$obj = DataObject::get_by_id($this->sourceObject, $this->baseID);
}
2014-08-15 08:53:05 +02:00
if(!$this->baseID || !$obj) {
$obj = DataObject::singleton($this->sourceObject);
}
}
2014-08-15 08:53:05 +02:00
// pre-process the tree - search needs to operate globally, not locally as marking filter does
if ($this->search) {
$this->populateIDs();
}
2014-08-15 08:53:05 +02:00
if ($this->filterCallback || $this->search) {
$obj->setMarkingFilterFunction(array($this, "filterMarking"));
}
$obj->markPartialTree(
$nodeCountThreshold = 30,
$context = null,
$this->childrenMethod,
$this->numChildrenMethod
);
2014-08-15 08:53:05 +02:00
// allow to pass values to be selected within the ajax request
if( isset($_REQUEST['forceValue']) || $this->value ) {
$forceValue = ( isset($_REQUEST['forceValue']) ? $_REQUEST['forceValue'] : $this->value);
$values = preg_split('/,\s*/', $forceValue);
if ($values) {
foreach($values as $value) {
if(!$value || $value == 'unchanged') {
continue;
}
$obj->markToExpose($this->objectForKey($value));
}
}
}
$self = $this;
$titleFn = function(&$child) use(&$self) {
/** @var DataObject|Hierarchy $child */
$keyField = $self->keyField;
$labelField = $self->labelField;
return sprintf(
'<li id="selector-%s-%s" data-id="%s" class="class-%s %s %s"><a rel="%d">%s</a>',
Convert::raw2xml($self->getName()),
Convert::raw2xml($child->$keyField),
Convert::raw2xml($child->$keyField),
Convert::raw2xml($child->class),
Convert::raw2xml($child->markingClasses($self->numChildrenMethod)),
($self->nodeIsDisabled($child)) ? 'disabled' : '',
(int)$child->ID,
$child->obj($labelField)->forTemplate()
);
};
// Limit the amount of nodes shown for performance reasons.
// Skip the check if we're filtering the tree, since its not clear how many children will
// match the filter criteria until they're queried (and matched up with previously marked nodes).
$nodeThresholdLeaf = Config::inst()->get('SilverStripe\\ORM\\Hierarchy\\Hierarchy', 'node_threshold_leaf');
if($nodeThresholdLeaf && !$this->filterCallback && !$this->search) {
$className = $this->sourceObject;
$nodeCountCallback = function($parent, $numChildren) use($className, $nodeThresholdLeaf) {
if( $className === 'SilverStripe\\CMS\\Model\\SiteTree'
&& $parent->ID
&& $numChildren > $nodeThresholdLeaf
) {
return sprintf(
'<ul><li><span class="item">%s</span></li></ul>',
_t('LeftAndMain.TooManyPages', 'Too many pages')
);
}
return null;
2014-08-15 08:53:05 +02:00
};
} else {
$nodeCountCallback = null;
}
if($isSubTree) {
$html = $obj->getChildrenAsUL(
"",
$titleFn,
null,
2014-08-15 08:53:05 +02:00
true,
$this->childrenMethod,
$this->numChildrenMethod,
true, // root call
null,
$nodeCountCallback
);
return substr(trim($html), 4, -5);
} else {
$html = $obj->getChildrenAsUL(
'class="tree"',
$titleFn,
null,
2014-08-15 08:53:05 +02:00
true,
$this->childrenMethod,
$this->numChildrenMethod,
true, // root call
null,
$nodeCountCallback
);
return $html;
}
}
/**
* Marking public function for the tree, which combines different filters sensibly.
* If a filter function has been set, that will be called. And if search text is set,
* filter on that too. Return true if all applicable conditions are true, false otherwise.
*
* @param mixed $node
* @return bool
*/
public function filterMarking($node) {
if ($this->filterCallback && !call_user_func($this->filterCallback, $node)) return false;
if ($this->search != "") {
return isset($this->searchIds[$node->ID]) && $this->searchIds[$node->ID] ? true : false;
}
2014-08-15 08:53:05 +02:00
return true;
}
/**
* Marking a specific node in the tree as disabled
* @param $node
* @return boolean
*/
public function nodeIsDisabled($node) {
return ($this->disableCallback && call_user_func($this->disableCallback, $node));
}
/**
2016-06-23 01:37:22 +02:00
* @param string $field
* @return $this
*/
public function setLabelField($field) {
$this->labelField = $field;
2013-01-08 18:32:40 +01:00
return $this;
}
/**
* @return String
*/
public function getLabelField() {
return $this->labelField;
}
/**
2016-06-23 01:37:22 +02:00
* @param string $field
* @return $this
*/
public function setKeyField($field) {
$this->keyField = $field;
2013-01-08 18:32:40 +01:00
return $this;
}
/**
* @return String
*/
public function getKeyField() {
return $this->keyField;
}
/**
2016-06-23 01:37:22 +02:00
* @param string $class
* @return $this
*/
public function setSourceObject($class) {
$this->sourceObject = $class;
2013-01-08 18:32:40 +01:00
return $this;
}
/**
* @return String
*/
public function getSourceObject() {
return $this->sourceObject;
}
2014-08-15 08:53:05 +02:00
/**
* Populate $this->searchIds with the IDs of the pages matching the searched parameter and their parents.
* Reverse-constructs the tree starting from the leaves. Initially taken from CMSSiteTreeFilter, but modified
* with pluggable search function.
*/
protected function populateIDs() {
// get all the leaves to be displayed
if ($this->searchCallback) {
$res = call_user_func($this->searchCallback, $this->sourceObject, $this->labelField, $this->search);
} else {
$sourceObject = $this->sourceObject;
$filters = array();
if(singleton($sourceObject)->hasDatabaseField($this->labelField)) {
$filters["{$this->labelField}:PartialMatch"] = $this->search;
} else {
if(singleton($sourceObject)->hasDatabaseField('Title')) {
$filters["Title:PartialMatch"] = $this->search;
}
if(singleton($sourceObject)->hasDatabaseField('Name')) {
$filters["Name:PartialMatch"] = $this->search;
}
2014-08-15 08:53:05 +02:00
}
if(empty($filters)) {
throw new InvalidArgumentException(sprintf(
'Cannot query by %s.%s, not a valid database column',
$sourceObject,
$this->labelField
));
}
$res = DataObject::get($this->sourceObject)->filterAny($filters);
}
2014-08-15 08:53:05 +02:00
if( $res ) {
// iteratively fetch the parents in bulk, until all the leaves can be accessed using the tree control
foreach($res as $row) {
if ($row->ParentID) $parents[$row->ParentID] = true;
$this->searchIds[$row->ID] = true;
}
$sourceObject = $this->sourceObject;
while (!empty($parents)) {
$items = DataObject::get($sourceObject)
->filter("ID",array_keys($parents));
$parents = array();
foreach($items as $item) {
if ($item->ParentID) $parents[$item->ParentID] = true;
$this->searchIds[$item->ID] = true;
$this->searchExpanded[$item->ID] = true;
}
}
}
}
/**
* Get the object where the $keyField is equal to a certain value
*
* @param string|int $key
* @return DataObject
*/
protected function objectForKey($key) {
return DataObject::get($this->sourceObject)
->filter($this->keyField, $key)
->first();
}
/**
* Changes this field to the readonly field.
*/
public function performReadonlyTransformation() {
/** @var TreeDropdownField_Readonly $copy */
$copy = $this->castedCopy('SilverStripe\\Forms\\TreeDropdownField_Readonly');
$copy->setKeyField($this->keyField);
$copy->setLabelField($this->labelField);
$copy->setSourceObject($this->sourceObject);
2014-08-15 08:53:05 +02:00
return $copy;
}
2014-08-15 08:53:05 +02:00
}