|
|
| (15 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_FormRelationship_Template''.
| | #REDIRECT [[Class: I2CE_FormRelationship_Template (4.1.7)]] |
| *Extends the class: [[Class: I2CE_MagicDataTemplate | I2CE_MagicDataTemplate]].
| |
| *Parent Classses: [[Class: I2CE_MagicDataTemplate | I2CE_MagicDataTemplate]] [[Class: I2CE_TemplateMeister | I2CE_TemplateMeister]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
| |
| *Location: Part of the module [[I2CE Module List#formRelationships|formRelationships]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php 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 array $types
| |
| *Type: static protected static $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 array $blanket
| |
| *Type: static protected static $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:
| |
| ** [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
| |
| ** [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
| |
| ** [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: ''
| |
| ** [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()
| |
| ===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:
| |
| ** [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
| |
| ** [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 ] $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
| |
| ===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:
| |
| ** [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
| |
| ** [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
| |
| *Returns: I2CE_CustomReportTemplate<br/>on sucess
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
