Class: I2CE Swiss Default Leaf: Difference between revisions
No edit summary |
No edit summary |
||
| Line 12: | Line 12: | ||
==Methods== | ==Methods== | ||
===__construct()=== | ===__construct()=== | ||
Constructor | Constructor @param I2CE_MagicDataNode the storage for this swiss | ||
@param I2CE_MagicDataNode the storage for this swiss | |||
*Signature: public function __construct($storage,$factory,$name,$parent) | *Signature: public function __construct($storage,$factory,$name,$parent) | ||
Parameters: | *Parameters: | ||
*$storage | *$storage | ||
*$factory | *$factory | ||
*$name | *$name | ||
**Default Value: null | ***Default Value: null | ||
*$parent | *$parent | ||
**Default Value: null | ***Default Value: null | ||
===displayValues()=== | ===displayValues()=== | ||
*Signature: public function displayValues($contentNode,$transient_options,$action) | *Signature: public function displayValues($contentNode,$transient_options,$action) | ||
Parameters: | *Parameters: | ||
*$contentNode | *$contentNode | ||
*$transient_options | *$transient_options | ||
| Line 30: | Line 29: | ||
===processValues()=== | ===processValues()=== | ||
Called by updateValues() | Called by updateValues() | ||
*Signature: public function processValues($vals) | *Signature: public function processValues($vals) | ||
* | *Parameters: | ||
Parameters: | ** [http://www.php.net/manual/en/language.types.array.php array ] $vals <br/>an associateive array of values. Keys are of the form 'value_XXXXX_YYYY/ZZZZ where ZZZZ is a config path (no instance), YYYY is either 'many' or 'single', and XXXX is a data type (e.g. 'string') | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $vals<br/>an associateive array of values. Keys are of the form 'value_XXXXX_YYYY/ZZZZ | *Returns: false<br/>on failure | ||
===setValue_delimited_many()=== | ===setValue_delimited_many()=== | ||
*Signature: public function setValue_delimited_many($config,$val) | *Signature: public function setValue_delimited_many($config,$val) | ||
Parameters: | *Parameters: | ||
*$config | *$config | ||
*$val | *$val | ||
===setValue_delimited_single()=== | ===setValue_delimited_single()=== | ||
*Signature: public function setValue_delimited_single($config,$val) | *Signature: public function setValue_delimited_single($config,$val) | ||
Parameters: | *Parameters: | ||
*$config | *$config | ||
*$val | *$val | ||
===setValue_string_many()=== | ===setValue_string_many()=== | ||
Set the value at the magic data node associated to the path where the type of the value is a many valued string | Set the value at the magic data node associated to the path where the type of the value is a many valued string @param I2CE_MagicDataNode | ||
@param I2CE_MagicDataNode | |||
*Signature: public function setValue_string_many($config,$val) | *Signature: public function setValue_string_many($config,$val) | ||
* | *Parameters: | ||
Parameters: | |||
*$config | *$config | ||
* [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $val | ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $val | ||
*Returns: false<br/>on failure | |||
===updatePairs()=== | ===updatePairs()=== | ||
*Signature: protected function updatePairs($config,$val) | *Signature: protected function updatePairs($config,$val) | ||
Parameters: | *Parameters: | ||
*$config | *$config | ||
*$val | *$val | ||
Revision as of 23:42, 16 October 2009
This article desrcibes the class I2CE_Swiss_Default_Leaf.
- Extends the class: I2CE_Swiss_Default_Base.
- Location: Part of the module swissfactory in the package I2CE
- Source: Defined in the file modules/SwissFactory/lib/I2CE_Swiss_Default_Leaf.php
- Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_Swiss_Default_Leaf
Variables
$error
@var protected mixed $errors.
- Type: protected $error
Methods
__construct()
Constructor @param I2CE_MagicDataNode the storage for this swiss
- Signature: public function __construct($storage,$factory,$name,$parent)
- Parameters:
- $storage
- $factory
- $name
- Default Value: null
- $parent
- Default Value: null
displayValues()
- Signature: public function displayValues($contentNode,$transient_options,$action)
- Parameters:
- $contentNode
- $transient_options
- $action
processValues()
Called by updateValues()
- Signature: public function processValues($vals)
- Parameters:
- array $vals
an associateive array of values. Keys are of the form 'value_XXXXX_YYYY/ZZZZ where ZZZZ is a config path (no instance), YYYY is either 'many' or 'single', and XXXX is a data type (e.g. 'string')
- array $vals
- Returns: false
on failure
setValue_delimited_many()
- Signature: public function setValue_delimited_many($config,$val)
- Parameters:
- $config
- $val
setValue_delimited_single()
- Signature: public function setValue_delimited_single($config,$val)
- Parameters:
- $config
- $val
setValue_string_many()
Set the value at the magic data node associated to the path where the type of the value is a many valued string @param I2CE_MagicDataNode
- Signature: public function setValue_string_many($config,$val)
- Parameters:
- $config
- mixed $val
- Returns: false
on failure
updatePairs()
- Signature: protected function updatePairs($config,$val)
- Parameters:
- $config
- $val
Inherited Variables
$name
Theis protected variable is inherited from I2CE_Swiss->$name
$path
Theis protected variable is inherited from I2CE_Swiss->$path
$parent
Theis protected variable is inherited from I2CE_Swiss->$parent
$page
Theis protected variable is inherited from I2CE_Swiss->$page
$template
Theis protected variable is inherited from I2CE_Swiss->$template
$children
Theis protected variable is inherited from I2CE_Swiss->$children
Inherited Fuzzy Methods
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
Fuzzy Methods
editValue_string_single()
This method is implemented by I2CE_Module_SwissFactory->editValue_string_single()
editValue_string_many()
This method is implemented by I2CE_Module_SwissFactory->editValue_string_many()
editValue_delimited_single()
This method is implemented by I2CE_Module_SwissFactory->editValue_delimited_single()
editValue_delimited_many()
This method is implemented by I2CE_Module_SwissFactory->editValue_delimited_many()
editValue_boolean_single()
This method is implemented by I2CE_Module_SwissFactory->editValue_boolean_single()
editValue_boolean_many()
This method is implemented by I2CE_Module_SwissFactory->editValue_boolean_many()
editValue_list_single()
This method is implemented by I2CE_Module_SwissFactory->editValue_list_single()
editValue_list_many()
This method is implemented by I2CE_Module_SwissFactory->editValue_list_many()
viewValue_string_single()
This method is implemented by I2CE_Module_SwissFactory->viewValue_string_single()
viewValue_string_many()
This method is implemented by I2CE_Module_SwissFactory->viewValue_string_many()
viewValue_delimited_single()
This method is implemented by I2CE_Module_SwissFactory->viewValue_delimited_single()
viewValue_delimited_many()
This method is implemented by I2CE_Module_SwissFactory->viewValue_delimited_many()
viewValue_boolean_single()
This method is implemented by I2CE_Module_SwissFactory->viewValue_boolean_single()
viewValue_boolean_many()
This method is implemented by I2CE_Module_SwissFactory->viewValue_boolean_many()
viewValue_list_single()
This method is implemented by I2CE_Module_SwissFactory->viewValue_list_single()
viewValue_list_many()
This method is implemented by I2CE_Module_SwissFactory->viewValue_list_many()
