2007-07-19 12:40:28 +02:00
< ? php
/**
* Base class for all fields that contain other fields .
* Implements sequentialisation - so that when we ' re saving / loading data , we can populate
* a tabbed form properly . All of the children are stored in $this -> children
2008-01-09 05:18:36 +01:00
* @ package forms
* @ subpackage fields - structural
2007-07-19 12:40:28 +02:00
*/
class CompositeField extends FormField {
protected $children ;
/**
* Set to true when this field is a readonly field
*/
protected $readonly ;
/**
* @ var $columnCount int Toggle different css - rendering for multiple columns
* ( " onecolumn " , " twocolumns " , " threecolumns " ) . The content is determined
* by the $children - array , so wrap all items you want to have grouped in a
* column inside a CompositeField .
* Caution : Please make sure that this variable actually matches the
* count of your $children .
*/
protected $columnCount = null ;
public function __construct ( $children = null ) {
if ( is_a ( $children , 'FieldSet' )) {
$this -> children = $children ;
} elseif ( is_array ( $children )) {
$this -> children = new FieldSet ( $children );
} else {
$children = is_array ( func_get_args ()) ? func_get_args () : array ();
$this -> children = new FieldSet ( $children );
}
2008-09-11 02:02:49 +02:00
$this -> children -> setContainerField ( $this );
2008-08-20 06:41:55 +02:00
2007-07-19 12:40:28 +02:00
Object :: __construct ();
}
/**
* Returns all the sub - fields , suitable for <% control FieldSet %>
*/
public function FieldSet () {
return $this -> children ;
}
public function setID ( $id ) {
$this -> id = $id ;
}
2007-10-18 03:05:52 +02:00
public function Field () {
return $this -> FieldHolder ();
}
2008-08-20 06:41:55 +02:00
/**
* Accessor method for $this -> children
* @ return FieldSet
*/
public function getChildren () {
return $this -> children ;
}
2007-07-19 12:40:28 +02:00
/**
* Returns the fields nested inside another DIV
*/
function FieldHolder () {
$fs = $this -> FieldSet ();
$idAtt = isset ( $this -> id ) ? " id= \" { $this -> id } \" " : '' ;
$className = ( $this -> columnCount ) ? " field CompositeField { $this -> extraClass () } multicolumn " : " field CompositeField { $this -> extraClass () } " ;
2007-10-18 03:05:52 +02:00
$content = " <div class= \" $className\ " $idAtt > \n " ;
2007-07-19 12:40:28 +02:00
foreach ( $fs as $subfield ) {
if ( $this -> columnCount ) {
$className = " column { $this -> columnCount } " ;
if ( ! next ( $fs )) $className .= " lastcolumn " ;
2007-10-18 03:05:52 +02:00
$content .= " \n <div class= \" { $className } \" > \n " . $subfield -> FieldHolder () . " \n </div> \n " ;
2007-07-19 12:40:28 +02:00
} else if ( $subfield ){
2007-10-18 03:05:52 +02:00
$content .= " \n " . $subfield -> FieldHolder () . " \n " ;
2007-07-19 12:40:28 +02:00
}
}
2007-10-18 03:05:52 +02:00
$content .= " </div> \n " ;
2007-07-19 12:40:28 +02:00
return $content ;
2007-09-16 18:05:05 +02:00
}
/**
* Returns the fields in the restricted field holder inside a DIV .
*/
function SmallFieldHolder () { //return $this->FieldHolder();
$fs = $this -> FieldSet ();
$idAtt = isset ( $this -> id ) ? " id= \" { $this -> id } \" " : '' ;
$className = ( $this -> columnCount ) ? " field CompositeField { $this -> extraClass () } multicolumn " : " field CompositeField { $this -> extraClass () } " ;
$content = " <div class= \" $className\ " $idAtt > " ;
foreach ( $fs as $subfield ) { //echo ' subf'.$subfield->Name();
if ( $this -> columnCount ) {
$className = " column { $this -> columnCount } " ;
if ( ! next ( $fs )) $className .= " lastcolumn " ;
$content .= " <div class= \" { $className } \" > " . $subfield -> FieldHolder () . " </div> " ;
} else if ( $subfield ){
$content .= $subfield -> SmallFieldHolder () . " " ;
}
}
$content .= " </div> " ;
2007-07-19 12:40:28 +02:00
2007-09-16 18:05:05 +02:00
return $content ;
}
2007-07-19 12:40:28 +02:00
/**
* Add all of the non - composite fields contained within this field to the list .
* Sequentialisation is used when connecting the form to its data source
*/
2008-08-12 04:58:48 +02:00
public function collateDataFields ( & $list , $saveableOnly = false ) {
2007-07-19 12:40:28 +02:00
foreach ( $this -> children as $field ) {
if ( is_object ( $field )) {
2008-08-12 04:58:48 +02:00
if ( $field -> isComposite ()) $field -> collateDataFields ( $list , $saveableOnly );
if ( $saveableOnly ) {
$isIncluded = ( $field -> hasData () && ! $field -> isReadonly () && ! $field -> isDisabled ());
} else {
$isIncluded = ( $field -> hasData ());
}
if ( $isIncluded ) {
2007-07-19 12:40:28 +02:00
$name = $field -> Name ();
if ( $name ) {
$formName = ( isset ( $this -> form )) ? $this -> form -> FormName () : '(unknown form)' ;
if ( isset ( $list [ $name ])) user_error ( " collateDataFields() I noticed that a field called ' $name ' appears twice in your form: ' { $formName } '. One is a ' { $field -> class } ' and the other is a ' { $list [ $name ] -> class } ' " , E_USER_ERROR );
$list [ $name ] = $field ;
}
}
}
}
}
function setForm ( $form ) {
foreach ( $this -> children as $f ) if ( is_object ( $f )) $f -> setForm ( $form );
parent :: setForm ( $form );
}
function setColumnCount ( $columnCount ) {
$this -> columnCount = $columnCount ;
}
function isComposite () { return true ; }
function hasData () { return false ; }
2008-01-06 22:55:27 +01:00
public function fieldByName ( $name ) {
return $this -> children -> fieldByName ( $name );
}
2007-07-19 12:40:28 +02:00
/**
* Add a new child field to the end of the set .
*/
public function push ( FormField $field ) {
2008-09-11 02:02:49 +02:00
//$this->rootFieldSet()->removeByName($field->Name());
2007-07-19 12:40:28 +02:00
$this -> children -> push ( $field );
}
public function insertBefore ( $field , $insertBefore ) {
2008-09-11 02:02:49 +02:00
//$this->rootFieldSet()->removeByName($field->Name());
2007-09-16 18:05:05 +02:00
return $this -> children -> insertBefore ( $field , $insertBefore );
}
public function insertBeforeRecursive ( $field , $insertBefore , $level = 0 ) {
2008-09-11 02:02:49 +02:00
//$this->rootFieldSet()->removeByName($field->Name());
2007-09-16 18:05:05 +02:00
return $this -> children -> insertBeforeRecursive ( $field , $insertBefore , $level + 1 );
2007-07-19 12:40:28 +02:00
}
public function removeByName ( $fieldName ) {
$this -> children -> removeByName ( $fieldName );
}
public function replaceField ( $fieldName , $newField ) {
return $this -> children -> replaceField ( $fieldName , $newField );
}
/**
* Return a readonly version of this field . Keeps the composition but returns readonly
* versions of all the children
*/
public function performReadonlyTransformation () {
$newChildren = new FieldSet ();
foreach ( $this -> children as $idx => $child ) {
if ( is_object ( $child )) $child = $child -> transform ( new ReadonlyTransformation ());
$newChildren -> push ( $child , $idx );
}
$this -> children = $newChildren ;
$this -> readonly = true ;
return $this ;
}
/**
* Return a readonly version of this field . Keeps the composition but returns readonly
* versions of all the children
*/
public function performDisabledTransformation ( $trans ) {
$newChildren = new FieldSet ();
if ( $this -> children ) foreach ( $this -> children as $idx => $child ) {
if ( is_object ( $child )) {
$child = $child -> transform ( $trans );
}
$newChildren -> push ( $child , $idx );
}
$this -> children = $newChildren ;
$this -> readonly = true ;
return $this ;
}
2007-11-23 02:10:19 +01:00
2007-07-19 12:40:28 +02:00
function IsReadonly () {
return $this -> readonly ;
}
function debug () {
2007-09-14 20:05:21 +02:00
$result = " $this->class ( $this->name ) <ul> " ;
2007-07-19 12:40:28 +02:00
foreach ( $this -> children as $child ) {
$result .= " <li> " . Debug :: text ( $child ) . " </li> " ;
}
$result .= " </ul> " ;
return $result ;
}
2007-08-23 07:47:54 +02:00
function validate ( $validator ){
$valid = true ;
foreach ( $this -> children as $idx => $child ){
$valid = ( $child -> validate ( $validator ) && $valid );
}
return $valid ;
}
2007-07-19 12:40:28 +02:00
}
?>