mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
8cc5625708
ENHANCEMENT Support for $field_labels in relation tabs created by DataObject->addScaffoldRelationFields() ENHANCEMENT Type checking and user errors for Tab and TabSet constructor arguments ENHANCEMENT Supporting titles in FieldSet->findOrMakeTab() git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@64073 467b73ca-7a2a-4603-9d3b-597d59a354a9
111 lines
3.1 KiB
PHP
111 lines
3.1 KiB
PHP
<?php
|
|
/**
|
|
* Defines a set of tabs in a form.
|
|
* The tabs are build with our standard tabstrip javascript library. By default, the HTML is
|
|
* generated using FieldHolder.
|
|
* @package forms
|
|
* @subpackage fields-structural
|
|
*/
|
|
class TabSet extends CompositeField {
|
|
|
|
/**
|
|
* @param string $name Identifier
|
|
* @param string $title (Optional) Natural language title of the tabset
|
|
* @param Tab|TabSet $unknown All further parameters are inserted as children into the TabSet
|
|
*/
|
|
public function __construct($name) {
|
|
$args = func_get_args();
|
|
|
|
$name = array_shift($args);
|
|
if(!is_string($name)) user_error('TabSet::__construct(): $name parameter to a valid string', E_USER_ERROR);
|
|
$this->name = $name;
|
|
|
|
$this->id = $name;
|
|
|
|
// Legacy handling: only assume second parameter as title if its a string,
|
|
// otherwise it might be a formfield instance
|
|
if(isset($args[0]) && is_string($args[0])) {
|
|
$title = array_shift($args);
|
|
}
|
|
$this->title = (isset($title)) ? $title : FormField::name_to_label($name);
|
|
|
|
if($args) foreach($args as $tab) {
|
|
$isValidArg = (is_object($tab) && (!($tab instanceof Tab) || !($tab instanceof TabSet)));
|
|
if(!$isValidArg) user_error('TabSet::__construct(): Parameter not a valid Tab instance', E_USER_ERROR);
|
|
|
|
$tab->setTabSet($this);
|
|
}
|
|
|
|
parent::__construct($args);
|
|
}
|
|
|
|
public function id() {
|
|
if($this->tabSet) return $this->tabSet->id() . '_' . $this->id . '_set';
|
|
else return $this->id;
|
|
}
|
|
|
|
/**
|
|
* Returns a tab-strip and the associated tabs.
|
|
* The HTML is a standardised format, containing a <ul;
|
|
*/
|
|
public function FieldHolder() {
|
|
Requirements::javascript(THIRDPARTY_DIR . "/loader.js");
|
|
Requirements::javascript(THIRDPARTY_DIR . "/prototype.js");
|
|
Requirements::javascript(THIRDPARTY_DIR . "/behaviour.js");
|
|
Requirements::javascript(THIRDPARTY_DIR . "/prototype_improvements.js");
|
|
Requirements::javascript(THIRDPARTY_DIR . "/tabstrip/tabstrip.js");
|
|
Requirements::css(THIRDPARTY_DIR . "/tabstrip/tabstrip.css");
|
|
|
|
return $this->renderWith("TabSetFieldHolder");
|
|
}
|
|
|
|
/**
|
|
* Return a dataobject set of all this classes tabs
|
|
*/
|
|
public function Tabs() {
|
|
return $this->children;
|
|
}
|
|
public function setTabs($children){
|
|
$this->children = $children;
|
|
}
|
|
|
|
public function setTabSet($val) {
|
|
$this->tabSet = $val;
|
|
}
|
|
public function getTabSet() {
|
|
if(isset($this->tabSet)) return $this->tabSet;
|
|
}
|
|
|
|
/**
|
|
* Returns the named tab
|
|
*/
|
|
public function fieldByName($name) {
|
|
foreach($this->children as $child) {
|
|
if($name == $child->Name || $name == $child->id) return $child;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add a new child field to the end of the set.
|
|
*/
|
|
public function push($field) {
|
|
parent::push($field);
|
|
$field->setTabSet($this);
|
|
}
|
|
public function insertBefore($field, $insertBefore) {
|
|
parent::insertBefore($field, $insertBefore);
|
|
$field->setTabSet($this);
|
|
}
|
|
|
|
public function insertBeforeRecursive($field, $insertBefore, $level) {
|
|
$level = parent::insertBeforeRecursive($field, $insertBefore, $level+1);
|
|
if ($level === 0) $field->setTabSet($this);
|
|
return $level;
|
|
}
|
|
|
|
public function removeByName( $tabName, $dataFieldOnly = false ) {
|
|
parent::removeByName( $tabName, $dataFieldOnly );
|
|
}
|
|
}
|
|
?>
|