Class: I2CE FormRelationship Template (4.0.2)

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

For other versions, see Class: I2CE_FormRelationship_Template (versions) .

This article describes the class I2CE_FormRelationship_Template .

Extends the class: I2CE_MagicDataTemplate.
Location: Part of the module formRelationships in the package I2CE 4.0.2-release
Source: Defined in the file modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php on line 29
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

Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php on line 35
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

Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php on line 88
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

Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php on line 110
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

Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php on line 126
Type: static protected $required

$ensure

Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php on line 132
Type: static protected $ensure

$permissions

Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php on line 139
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.

Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php on line 187
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()

createExportNodeConfigurationGroup()

Create an configurationGroup node by appending on to the given configurationGroup node the values stored in the magic data at the specified $key.

Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php on line 158
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

getReportForm()

Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php on line 263
Signature: static public function getReportForm($configNode)
Parameters:
- $configNode

getReportFormNode()

Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php on line 241
Signature: static public function getReportFormNode($configNode)
Parameters:
- $configNode

getTemplate()

Gets a template. Also caches the results

Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php on line 45
Signature: static public function getTemplate($type,$name)
Parameters:
- string $type
  one of report, relationship or reportView. Defaults to null meaning we get everything under /modules/CustomReports
  - Default Value: null
- string $name
  Defaults to null meaning we get all the <$type>s of the specified name
  - Default Value: null
Returns: I2CE_CustomReportTemplate
on sucess