Class: I2CE FormRelationship Template: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 35: | Line 35: | ||
==Methods== | ==Methods== | ||
===createExport()=== | ===createExport()=== | ||
Create an export node by appending on to the given configurationGroup node the values | Create an export node by appending on to the given configurationGroup node the values stored in the magic data. | ||
stored in the magic data. | |||
*Signature: public function createExport($configNode,$config,$pipe,$configType,$status) | *Signature: public function createExport($configNode,$config,$pipe,$configType,$status) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/class.domnode.php DOMNode ] $configNode<br/>A configurationGroup node. | ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $configNode <br/>A configurationGroup node. | ||
* [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $config<br/>The data we wish to store at this node | ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $config <br/>The data we wish to store at this node | ||
* [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $pipe<br/>A path component or an array of path components relative to the $config. If the pipe is a non-empty array, we export only the | ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $pipe <br/>A path component or an array of path components relative to the $config. If the pipe is a non-empty array, we export only the keys specifed by the lowest member of $pipe, if it exists. Otherwise, if the pipe is empty or null, we export all keys. Defaults to empty array | ||
**Default Value: null | ***Default Value: null | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $configType<br/>Defaults to the empty string. The configuration type to give the configuration node. | ** [http://www.php.net/manual/en/language.types.string.php string ] $configType <br/>Defaults to the empty string. The configuration type to give the configuration node. | ||
**Default Value: '' | ***Default Value: '' | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $status<br/>An array of status options we should set for this configuration node. Defaults to the empty array | ** [http://www.php.net/manual/en/language.types.array.php array ] $status <br/>An array of status options we should set for this configuration node. Defaults to the empty array | ||
**Default Value: array() | ***Default Value: array() | ||
===createExportNodeConfigurationGroup()=== | ===createExportNodeConfigurationGroup()=== | ||
Create an configurationGroup node by appending on to the given configurationGroup node the values | Create an configurationGroup node by appending on to the given configurationGroup node the values stored in the magic data at the specified $key. | ||
stored in the magic data at the specified $key. | |||
*Signature: public function createExportNodeConfigurationGroup($configNode,$config,$pipe,$key,$configType,$status) | *Signature: public function createExportNodeConfigurationGroup($configNode,$config,$pipe,$key,$configType,$status) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/class.domnode.php DOMNode ] $configNode<br/>A configurationGroup node. | ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $configNode <br/>A configurationGroup node. | ||
* [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $config<br/>The data we wish to store at this node | ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $config <br/>The data we wish to store at this node | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $pipe<br/>An array of path components relative to the $config. If the pipe is a non-empty array, we export only the | ** [http://www.php.net/manual/en/language.types.array.php array ] $pipe <br/>An array of path components relative to the $config. If the pipe is a non-empty array, we export only the keys specifed by the lowest member of $pipe, if it exists. Otherwise, if the pipe is empty, we export all keys | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $key<br/>The key. (Warning. It assumes it exists in the magic data!) | ** [http://www.php.net/manual/en/language.types.string.php string ] $key <br/>The key. (Warning. It assumes it exists in the magic data!) | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $configType<br/>Defaults to the empty string. The configuration type to give the configuration node. | ** [http://www.php.net/manual/en/language.types.string.php string ] $configType <br/>Defaults to the empty string. The configuration type to give the configuration node. | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $status<br/>An array of status options we should set for this configuration node. Defaults to the empty array | ** [http://www.php.net/manual/en/language.types.array.php array ] $status <br/>An array of status options we should set for this configuration node. Defaults to the empty array | ||
===getReportForm()=== | ===getReportForm()=== | ||
*Signature: static public function getReportForm($configNode) | *Signature: static public function getReportForm($configNode) | ||
Parameters: | *Parameters: | ||
*$configNode | *$configNode | ||
===getReportFormNode()=== | ===getReportFormNode()=== | ||
*Signature: static public function getReportFormNode($configNode) | *Signature: static public function getReportFormNode($configNode) | ||
Parameters: | *Parameters: | ||
*$configNode | *$configNode | ||
===getTemplate()=== | ===getTemplate()=== | ||
Gets a template. Also caches the results | Gets a template. Also caches the results | ||
*Signature: static public function getTemplate($type,$name) | *Signature: static public function getTemplate($type,$name) | ||
* | *Parameters: | ||
Parameters: | ** [http://www.php.net/manual/en/language.types.string.php string ] $type <br/>one of report, relationship or reportView. Defaults to null meaning we get everything under /modules/CustomReports | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $type<br/>one of report, relationship or reportView. Defaults to null meaning we get everything under /modules/CustomReports | ***Default Value: null | ||
**Default Value: null | ** [http://www.php.net/manual/en/language.types.string.php string ] $name <br/>Defaults to null meaning we get all the <$type>s of the specified name | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $name<br/>Defaults to null meaning we get all the <$type>s of the specified name | ***Default Value: null | ||
**Default Value: null | *Returns: I2CE_CustomReportTemplate<br/>on sucess | ||
==Inherited Variables== | ==Inherited Variables== | ||
===$merges=== | ===$merges=== | ||
Revision as of 23:41, 16 October 2009
This article desrcibes the class I2CE_FormRelationship_Template.
- Extends the class: I2CE_MagicDataTemplate.
- Location: Part of the module formRelationships in the package I2CE
- Source: Defined in the file modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php
- Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_FormRelationship_Template
Variables
$templates
An array of requested relationships templates I2CE_CustomReport_Template indexed by the type and then by name @protected static array $templates
- Type: static protected $templates
$types
An array index by configTypes. the values are arrays whose keys are fields with values the config types the fields are supposed to have
- Type: static protected y $types
$blanket
An array with keys config types such that all sub-nodes of a node with this configType will have the configType specified by the value associated to the key
- Type: static protected y $blanket
$required
an array with keys configTypes with values the required fields for that config type. will cause a failure if not present $var protecected static $required
- Type: static protected $required
$ensure
- Type: static protected $ensure
$permissions
- Type: static protected $permissions
Methods
createExport()
Create an export node by appending on to the given configurationGroup node the values stored in the magic data.
- Signature: public function createExport($configNode,$config,$pipe,$configType,$status)
- Parameters:
- DOMNode $configNode
A configurationGroup node. - I2CE_MagicDataNode $config
The data we wish to store at this node - mixed $pipe
A path component or an array of path components relative to the $config. If the pipe is a non-empty array, we export only the keys specifed by the lowest member of $pipe, if it exists. Otherwise, if the pipe is empty or null, we export all keys. Defaults to empty array- Default Value: null
- string $configType
Defaults to the empty string. The configuration type to give the configuration node.- Default Value:
- array $status
An array of status options we should set for this configuration node. Defaults to the empty array- Default Value: array()
- DOMNode $configNode
createExportNodeConfigurationGroup()
Create an configurationGroup node by appending on to the given configurationGroup node the values stored in the magic data at the specified $key.
- Signature: public function createExportNodeConfigurationGroup($configNode,$config,$pipe,$key,$configType,$status)
- Parameters:
- DOMNode $configNode
A configurationGroup node. - I2CE_MagicDataNode $config
The data we wish to store at this node - array $pipe
An array of path components relative to the $config. If the pipe is a non-empty array, we export only the keys specifed by the lowest member of $pipe, if it exists. Otherwise, if the pipe is empty, we export all keys - string $key
The key. (Warning. It assumes it exists in the magic data!) - string $configType
Defaults to the empty string. The configuration type to give the configuration node. - array $status
An array of status options we should set for this configuration node. Defaults to the empty array
- DOMNode $configNode
getReportForm()
- Signature: static public function getReportForm($configNode)
- Parameters:
- $configNode
getReportFormNode()
- Signature: static public function getReportFormNode($configNode)
- Parameters:
- $configNode
getTemplate()
Gets a template. Also caches the results
- Signature: static public function getTemplate($type,$name)
- Parameters:
- Returns: I2CE_CustomReportTemplate
on sucess
Inherited Variables
$merges
Theis protected variable is inherited from I2CE_MagicDataTemplate->$merges
$doc
Theis public variable is inherited from I2CE_TemplateMeister->$doc
$xpath
Theis protected variable is inherited from I2CE_TemplateMeister->$xpath
$user
Theis protected variable is inherited from I2CE_TemplateMeister->$user
$working_dir
Theis protected variable is inherited from I2CE_TemplateMeister->$working_dir
$loadOptions
Theis protected variable is inherited from I2CE_TemplateMeister->$loadOptions
$headers
Theis protected variable is inherited from I2CE_TemplateMeister->$headers
$verboseErrors
Theis protected variable is inherited from I2CE_TemplateMeister->$verboseErrors
Inherited Fuzzy Methods
processValues_color_triple_hex_single()
This method is inherited from I2CE_MagicDataTemplate->processValues_color_triple_hex_single()
processValues_color_triple_hex_many()
This method is inherited from I2CE_MagicDataTemplate->processValues_color_triple_hex_many()
processValues_color_triple_rgb_single()
This method is inherited from I2CE_MagicDataTemplate->processValues_color_triple_rgb_single()
processValues_color_triple_rgb_many()
This method is inherited from I2CE_MagicDataTemplate->processValues_color_triple_rgb_many()
processValues_color_hex_single()
This method is inherited from I2CE_MagicDataTemplate->processValues_color_hex_single()
processValues_color_hex_many()
This method is inherited from I2CE_MagicDataTemplate->processValues_color_hex_many()
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
