2007-07-19 12:40:28 +02:00
|
|
|
<?php
|
2008-01-09 05:18:36 +01:00
|
|
|
/**
|
|
|
|
|
* Dropdown-like field that gives you a tree of items, using ajax.
|
|
|
|
|
* @package forms
|
|
|
|
|
* @subpackage fields-relational
|
|
|
|
|
*/
|
2007-07-19 12:40:28 +02:00
|
|
|
class TreeDropdownField extends FormField {
|
|
|
|
|
protected $sourceObject, $keyField, $labelField, $filterFunc;
|
|
|
|
|
protected $treeBaseID = 0;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Create a new tree dropdown field.
|
|
|
|
|
* @param name The name of the field.
|
|
|
|
|
* @param title The label of the field.
|
2008-01-13 23:06:51 +01:00
|
|
|
* @param sourceObject The object-type to list in the tree. Must be a 'hierachy' object.
|
2007-07-19 12:40:28 +02:00
|
|
|
* @param keyField The column of that object-type to return as the field value. Defaults to ID
|
|
|
|
|
* @param labelField The column to show as the human-readable value in the tree. Defaults to Title
|
|
|
|
|
*/
|
|
|
|
|
function __construct($name, $title, $sourceObject = "Group", $keyField = "ID", $labelField = "Title") {
|
|
|
|
|
$this->sourceObject = $sourceObject;
|
|
|
|
|
$this->keyField = $keyField;
|
|
|
|
|
$this->labelField = $labelField;
|
|
|
|
|
parent::__construct($name, $title);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function setFilterFunction($filterFunc) {
|
|
|
|
|
$this->filterFunc = $filterFunc;
|
|
|
|
|
}
|
|
|
|
|
/**
|
|
|
|
|
* Set the root node of the tree. Defaults to 0, ie, the whole tree
|
|
|
|
|
*/
|
|
|
|
|
function setTreeBaseID($treeBaseID) {
|
|
|
|
|
$this->treeBaseID = $treeBaseID;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function Field() {
|
2008-11-12 05:31:33 +01:00
|
|
|
Requirements::css(SAPPHIRE_DIR . '/css/TreeDropdownField.css');
|
ENHANCEMENT Introduced constants for system paths like /sapphire in preparation for a more flexible directory reorganisation. Instead of hardcoding your path, please use the following constants: BASE_PATH, BASE_URL, SAPPHIRE_DIR, SAPPHIRE_PATH, CMS_DIR, CMS_PATH, THIRDPARTY_DIR, THIRDPARTY_PATH, ASSETS_DIR, ASSETS_PATH, THEMES_DIR, THEMES_PATH
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@63154 467b73ca-7a2a-4603-9d3b-597d59a354a9
2008-09-27 18:02:38 +02:00
|
|
|
Requirements::javascript(THIRDPARTY_DIR . "/tree/tree.js");
|
|
|
|
|
Requirements::css(THIRDPARTY_DIR . "/tree/tree.css");
|
2009-03-10 23:08:52 +01:00
|
|
|
Requirements::add_i18n_javascript(SAPPHIRE_DIR . '/javascript/lang');
|
ENHANCEMENT Introduced constants for system paths like /sapphire in preparation for a more flexible directory reorganisation. Instead of hardcoding your path, please use the following constants: BASE_PATH, BASE_URL, SAPPHIRE_DIR, SAPPHIRE_PATH, CMS_DIR, CMS_PATH, THIRDPARTY_DIR, THIRDPARTY_PATH, ASSETS_DIR, ASSETS_PATH, THEMES_DIR, THEMES_PATH
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@63154 467b73ca-7a2a-4603-9d3b-597d59a354a9
2008-09-27 18:02:38 +02:00
|
|
|
Requirements::javascript(SAPPHIRE_DIR . "/javascript/TreeSelectorField.js");
|
2007-07-19 12:40:28 +02:00
|
|
|
|
|
|
|
|
if($this->value) {
|
2009-01-08 00:00:54 +01:00
|
|
|
$record = $this->getByKey($this->value);
|
2008-11-10 04:51:35 +01:00
|
|
|
$title = ($record) ? $record->Title : _t('DropdownField.CHOOSE', "(Choose)", PR_MEDIUM, 'Start-value of a dropdown');
|
2007-07-19 12:40:28 +02:00
|
|
|
} else {
|
2007-10-25 04:47:45 +02:00
|
|
|
$title = _t('DropdownField.CHOOSE', "(Choose)", PR_MEDIUM, 'Start-value of a dropdown');
|
2007-07-19 12:40:28 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
$id = $this->id();
|
|
|
|
|
|
2008-12-04 23:38:32 +01:00
|
|
|
$classes = "TreeDropdownField single";
|
|
|
|
|
if($this->extraClass()) $classes .= ' ' . $this->extraClass();
|
|
|
|
|
|
2007-07-19 12:40:28 +02:00
|
|
|
return <<<HTML
|
2008-12-04 23:38:32 +01:00
|
|
|
<div id="TreeDropdownField_$id" class="$classes"><input id="$id" type="hidden" name="$this->name" value="$this->value" /><span class="items">$title</span><a href="#" title="open" class="editLink"> </a></div>
|
2007-07-19 12:40:28 +02:00
|
|
|
HTML;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Return the site tree
|
|
|
|
|
*/
|
|
|
|
|
function gettree() {
|
|
|
|
|
if($this->treeBaseID) $obj = DataObject::get_by_id($this->sourceObject, $this->treeBaseID);
|
|
|
|
|
else $obj = singleton($this->sourceObject);
|
|
|
|
|
|
|
|
|
|
if($this->filterFunc) $obj->setMarkingFilterFunction($this->filterFunc);
|
|
|
|
|
else if($this->sourceObject == 'Folder') $obj->setMarkingFilter('ClassName', 'Folder');
|
|
|
|
|
$obj->markPartialTree();
|
|
|
|
|
|
|
|
|
|
// If we've already got values selected, make sure that we've got them in our tree
|
|
|
|
|
if($_REQUEST['forceValues']) {
|
|
|
|
|
$forceValues = split(" *, *", trim($_REQUEST['forceValues']));
|
|
|
|
|
foreach($forceValues as $value) {
|
|
|
|
|
$obj->markToExpose($this->getByKey($value));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
$eval = '"<li id=\"selector-' . $this->name . '-$child->' . $this->keyField . '\" class=\"$child->class" . $child->markingClasses() . "\"><a>" . $child->' . $this->labelField . ' . "</a>"';
|
|
|
|
|
echo $obj->getChildrenAsUL("class=\"tree\"", $eval, null, true);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Return a subtree via Ajax
|
|
|
|
|
*/
|
|
|
|
|
public function getsubtree() {
|
2009-01-08 00:00:54 +01:00
|
|
|
$obj = $this->getByKey($_REQUEST['SubtreeRootID']);
|
2007-07-19 12:40:28 +02:00
|
|
|
|
|
|
|
|
if(!$obj) user_error("Can't find database record $this->sourceObject with $this->keyField = $_REQUEST[SubtreeRootID]", E_USER_ERROR);
|
2009-01-08 00:00:54 +01:00
|
|
|
|
2007-07-19 12:40:28 +02:00
|
|
|
if($this->filterFunc) $obj->setMarkingFilterFunction($this->filterFunc);
|
2009-01-08 00:00:54 +01:00
|
|
|
else if($this->sourceObject == 'Folder') $obj->setMarkingFilter('ClassName', 'Folder');
|
2007-07-19 12:40:28 +02:00
|
|
|
$obj->markPartialTree();
|
|
|
|
|
|
|
|
|
|
$eval = '"<li id=\"selector-' . $this->name . '-$child->' . $this->keyField . '\" class=\"$child->class" . $child->markingClasses() . "\"><a>" . $child->' . $this->labelField . ' . "</a>"';
|
|
|
|
|
$tree = $obj->getChildrenAsUL("", $eval, null, true);
|
|
|
|
|
echo substr(trim($tree), 4,-5);
|
|
|
|
|
}
|
|
|
|
|
|
2009-05-01 07:07:41 +02:00
|
|
|
/**
|
|
|
|
|
* @return DataObject
|
|
|
|
|
*/
|
2007-07-19 12:40:28 +02:00
|
|
|
public function getByKey($key) {
|
|
|
|
|
if($this->keyField == 'ID') {
|
|
|
|
|
return DataObject::get_by_id($this->sourceObject, $key);
|
|
|
|
|
} else {
|
2009-01-08 00:00:54 +01:00
|
|
|
$SQL_key = Convert::raw2sql($key);
|
|
|
|
|
return DataObject::get_one($this->sourceObject, "\"$this->keyField\" = '$SQL_key'");
|
2007-07-19 12:40:28 +02:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Return the stack of values to be traversed to find the given key in the database
|
|
|
|
|
*/
|
|
|
|
|
public function getstack() {
|
2009-01-08 00:00:54 +01:00
|
|
|
$page = $this->getByKey($_REQUEST['SubtreeRootID']);
|
2007-07-19 12:40:28 +02:00
|
|
|
|
|
|
|
|
while($page->ParentID) {
|
|
|
|
|
echo $ids[] = $page->ID;
|
|
|
|
|
$page = $page->Parent;
|
|
|
|
|
}
|
|
|
|
|
$ids[] = $page->ID;
|
|
|
|
|
echo implode(",", array_reverse($ids));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function performReadonlyTransformation() {
|
|
|
|
|
$fieldName = $this->labelField;
|
2009-05-01 07:07:41 +02:00
|
|
|
if($this->value) {
|
|
|
|
|
$obj = ($this->getByKey($this->value)) ? $this->getByKey($this->value)->$fieldName : '';
|
|
|
|
|
} else {
|
|
|
|
|
$obj = null;
|
|
|
|
|
}
|
2007-07-19 12:40:28 +02:00
|
|
|
$source = array(
|
2009-05-01 07:07:41 +02:00
|
|
|
$this->value => $obj
|
2007-07-19 12:40:28 +02:00
|
|
|
);
|
|
|
|
|
$field = new LookupField($this->name, $this->title, $source);
|
|
|
|
|
$field->setValue($this->value);
|
|
|
|
|
$field->setForm($this->form);
|
2008-08-12 04:58:48 +02:00
|
|
|
$field->setReadonly(true);
|
2007-07-19 12:40:28 +02:00
|
|
|
return $field;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
2009-02-02 00:49:53 +01:00
|
|
|
?>
|
