Class: I2CE MagicDataTemplate

From IHRIS Wiki
Revision as of 16:01, 16 October 2009 by Litlfred (talk | contribs) (Created page with 'This article desrcibes the class '''I2CE_MagicDataTemplate'''which extends the class I2CE_TemplateMeister It is contained in the module [[iHRIS …')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This article desrcibes the class I2CE_MagicDataTemplatewhich extends the class I2CE_TemplateMeister It is contained in the module I2CE in the package I2CE The class is defined in the file: lib/I2CE_MagicDataTemplate.php I2CE_MagicDataTemplate @package I2CE @todo Better documentation.

Variables

$merges

$var protected array $merges;

  • Type: protected $merges

Methods

__construct()

I2CE_Template constructor method.

This constructor sets up the basic variables for all I2CE_Template objects.

  • Signature: public function __construct()

getConfigMetaData()

Gets the metadata of this config file in storage

  • Signature: public function getConfigMetaData($storage)
  • Returns: boolean true on sucess

Parameters:

getConfigPath()

Get the path to the current node in the configuration file. Used for error reporting.

@param $node DOMElement

  • Signature: protected function getConfigPath($node)
  • Returns: string The full configuration path

Parameters:

  • $node

getConfigurationTextContent()

Get the value in the <value> tag of a subnode specfiied by the name attribute

  • Signature: public function getConfigurationTextContent($nodeName,$node,$which)
  • Returns: mixed. Null on failure, a string (the content) on sucess

Parameters:

  • string $nodeName
  • domnode $node
    The node we wish to search under. Defaults to null meaning we search from the top node.
    • Default Value: null
  • int $which
    Which result we want. Defaults to zero
    • Default Value: 0

getDefaultStatus()

Get the default status variables.

  • Signature: public function getDefaultStatus()

getMerges()

Get the magic data paths whose status we are tracking. $retrurns array. Keys are paths values are the mergetype

  • Signature: public function getMerges()

getTextContent()

Get the text content of a node specified by its tag name

  • Signature: public function getTextContent($name,$node,$which)
  • Returns: mixed string on sucess, null on failure

Parameters:

  • string $name
    the name of the node we wish to find the text content for
  • domnode $node
    The node we wish to search under. Defaults to null meaning we search from the top node.
    • Default Value: null
  • int $which
    Which result we want. Defaults to zero.
    • Default Value: 0

processStatus()

Assumes that the template is valid. Set the status variables according to this node

  • Signature: public function processStatus($configNode,$currentStatus,$vers)

Parameters:

  • domnode $configNode
    A configuration or conigurationGroup node
  • $currentStatus
    • Default Value: null
  • $vers
    • Default Value: '0'

processValues()

Process values for a config node @param I2CE_MagicDataNode $data @param string $version . Defaults to '0' . The version of the currently loaded data in $storage responsible for this XML @param array of string $paths -- the current path into the $storage that we are using. Defaults to the empty array().

  • Signature: public function processValues($configNode,$storage,$status,$vers,$paths)
  • Returns: boolean. true on sucess

Parameters:

  • domnode $configNode
  • $storage
  • array $status
    If null, it defaults to the array set by getDefaultStatus(). The current status (of parent node)
    • Default Value: null
  • $vers
  • $paths

processValues_boolean_single()

Process the value of a configuration of type boolean and single valued

  • Signature: protected function processValues_boolean_single($value,$status)
  • Returns: mixed

Parameters:

processValues_delimited_many()

Process the value of a configuration of type delimited and many valued

  • Signature: protected function processValues_delimited_many($valueList,$status)
  • Returns: mixed

Parameters:

processValues_delimited_single()

Process the value of a configuration of type delimited and single valued

  • Signature: protected function processValues_delimited_single($value,$status)
  • Returns: mixed

Parameters:

processValues_list_many()

Process the value of a configuration of type list and many valued @param array $valueList

  • Signature: protected function processValues_list_many($value,$status)
  • Returns: mixed

Parameters:

processValues_list_single()

Process the value of a configuration of type list and single valued

  • Signature: protected function processValues_list_single($value,$status)
  • Returns: mixed

Parameters:

processValues_string_many()

Process the value of a configuration of type string and many valued

  • Signature: protected function processValues_string_many($valueList,$status)
  • Returns: mixed

Parameters:

processValues_string_single()

Process the value of a configuration of type string and single valued

  • Signature: protected function processValues_string_single($value,$status)
  • Returns: mixed

Parameters:

setConfigValues()

Sets the config values from the magic data template @param string $version . Defaults to '0' . The version of the currently loaded data in $storage responsible for this XML @param array of string $paths -- the current path into the $storage that we are using. Defaults to the empty array().

  • Signature: public function setConfigValues($config_group,$storage,$status,$vers,$paths)
  • Returns: boolean. Returns true on sucess. False if there was some data that

needs to be set in the administration/configuration page. Parameters:

  • domnode $config_group
    DomNode of <configurationGroup>
  • I2CE_MagicData $storage
  • array $status
  • $vers
    • Default Value: '0'
  • $paths
    • Default Value: array()

traversePaths()

  • Signature: protected function traversePaths($storage,$paths)

Parameters:

  • $storage
  • $paths

updateClassPath()

Update the storage object with the classfile and default classpath.

@param $storage I2CE_MagicDataNode @param $module string containing the short module name.

  • Signature: protected function updateClassPath($storage,$module)
  • Returns: boolean TRUE for success

Parameters:

  • $storage
    • Default Value: NULL
  • $module
    • Default Value: NULL

updatePaths()

Update the list of path elements in MagicData based on attributes of the element passed in: path Contents of this attribute specify an explicit path name If no path element is used then the contents of the name attribute are added to the path.

@param $node DOMElement

@param $paths array of strings

  • Signature: protected function updatePaths($node,$paths)
  • Returns: boolean TRUE if no error.

Parameters:

  • $node
    • Default Value: NULL
  • &$paths
    • Default Value: NULL

validate()

  • Signature: public function validate()

validateValues_string_single()

Valiedates the value of a configuration of type string and single valued

  • Signature: protected function validateValues_string_single($value,$status)
  • Returns: mixed

Parameters:

Inherited Variables

$$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

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Fuzzy Methods

action_person_scheduled_training_course()

This method is implemented by I2CE_Module_ColorPicker->processValues_color_triple_hex_single()

action_person_scheduled_training_course()

This method is implemented by I2CE_Module_ColorPicker->processValues_color_triple_hex_many()

action_person_scheduled_training_course()

This method is implemented by I2CE_Module_ColorPicker->processValues_color_triple_rgb_single()

action_person_scheduled_training_course()

This method is implemented by I2CE_Module_ColorPicker->processValues_color_triple_rgb_many()

action_person_scheduled_training_course()

This method is implemented by I2CE_Module_ColorPicker->processValues_color_hex_single()

action_person_scheduled_training_course()

This method is implemented by I2CE_Module_ColorPicker->processValues_color_hex_many()

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_MagicDataTemplate&oldid=4882"