|
|
| (12 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_TemplateMeister''.
| | #REDIRECT [[Class: I2CE_TemplateMeister (4.1.7)]] |
| *Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]].
| |
| *Child Classes:
| |
| ** [[Class: I2CE_MagicDataTemplate | I2CE_MagicDataTemplate]]
| |
| *** [[Class: I2CE_CustomReport_Template | I2CE_CustomReport_Template]]
| |
| *** [[Class: I2CE_MagicDataTemplate_YAML | I2CE_MagicDataTemplate_YAML]]
| |
| *** [[Class: I2CE_FormRelationship_Template | I2CE_FormRelationship_Template]]
| |
| *** [[Class: I2CE_MagicDataExport_Template | I2CE_MagicDataExport_Template]]
| |
| ** [[Class: I2CE_Template | I2CE_Template]]
| |
| *Location: Part of the module [[I2CE Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L33 lib/I2CE_TemplateMeister.php] on line 33
| |
| The I2CE_Template class that all display pages use.
| |
| ==Variables==
| |
| ===$doc===
| |
| The top level DOM document that all methods work with.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L38 i2ce/lib/I2CE_TemplateMeister.php] on line 38
| |
| *Type: public [http://www.php.net/manual/en/class.domdocument.php DOMDocument ] $doc
| |
| | |
| ===$xpath===
| |
| The XPath object used for search for DOM nodes in the document.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L43 i2ce/lib/I2CE_TemplateMeister.php] on line 43
| |
| *Type: protected [http://www.php.net/manual/en/class.domxpath.php DOMXPath ] $xpath
| |
| | |
| ===$user===
| |
| The user who is accessing this template
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L49 i2ce/lib/I2CE_TemplateMeister.php] on line 49
| |
| *Type: protected [[Class: I2CE_User | I2CE_User]] $user
| |
| | |
| ===$working_dir===
| |
| The working directory for the document. Used for validation and document creation.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L55 i2ce/lib/I2CE_TemplateMeister.php] on line 55
| |
| *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $working_dir
| |
| | |
| ===$loadOptions===
| |
| the load options used when loading XML templates
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L192 i2ce/lib/I2CE_TemplateMeister.php] on line 192
| |
| *Type: protected integer $loadOptions
| |
| | |
| ===$headers===
| |
| @var protected array $header of string. The header strings.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L227 i2ce/lib/I2CE_TemplateMeister.php] on line 227
| |
| *Type: protected $headers
| |
| | |
| ===$verboseErrors===
| |
| the verbosity of errors for validation
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L822 i2ce/lib/I2CE_TemplateMeister.php] on line 822
| |
| *Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $verboseErrors
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| I2CE_Template constructor method. This constructor sets up the basic variables for all I2CE_Template objects.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L108 i2ce/lib/I2CE_TemplateMeister.php] on line 108
| |
| *Signature: public function __construct()
| |
| ===_loadFile()===
| |
| Helper method. Load a file into the spectified document as XML
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L572 i2ce/lib/I2CE_TemplateMeister.php] on line 572
| |
| *Signature: protected function _loadFile($doc,$contentfile)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domdocument.php DOMDocument ] $doc
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $contentfile <br/>the file to load
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>False on failure,
| |
| ===_loadText()===
| |
| Helper method. Load text into the spectified document as XML @param string $contentfile the file to load
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L595 i2ce/lib/I2CE_TemplateMeister.php] on line 595
| |
| *Signature: protected function _loadText($doc,$text,$setEncoding)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domdocument.php DOMDocument ] $doc
| |
| **$text
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $setEncoding <br/>Defaults to true. If true, set the encoding to be that of the docuemnt. Only useful as false for loading root template files
| |
| ***Default Value: true
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>False on failure,
| |
| ===addFile()===
| |
| Load and add the template file to the document
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L672 i2ce/lib/I2CE_TemplateMeister.php] on line 672
| |
| *Signature: public function addFile($contentfile,$tag,$relative_node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $contentfile
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $tag
| |
| ***Default Value: "div"
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $relative_node <br/>if non null gets the element relative to that node. Defaults to null
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]<br/>the node just created @see loadFile @see replaceNode
| |
| ===addHeader()===
| |
| Add a header for this tempalte. If not set we user 'Content-type: text/xml; charset=utf-8'
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L207 i2ce/lib/I2CE_TemplateMeister.php] on line 207
| |
| *Signature: public function addHeader($header)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $header
| |
| ===addText()===
| |
| Add a string of text to the document and replace the node with the same id attribute.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L911 i2ce/lib/I2CE_TemplateMeister.php] on line 911
| |
| *Signature: public function addText($text,$tag,$relative_node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $text
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $tag <br/>Defaults to "div."
| |
| ***Default Value: "div"
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $relative_node <br/>if non null gets the element relative to that node. Defaults to null
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]<br/>the node created
| |
| ===addTextNode()===
| |
| Add a string of text to the node with the given id attribute.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L771 i2ce/lib/I2CE_TemplateMeister.php] on line 771
| |
| *Signature: public function addTextNode($id,$text,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $id <br/>string an id, or a DOMNode
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $text @param $node if non null gets the element relative to that node. Defaults to null
| |
| **$node
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]<br/>the node just created
| |
| ===appendElementById()===
| |
| Create and append an element to the given node by id. @param DOMNode $parent
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L745 i2ce/lib/I2CE_TemplateMeister.php] on line 745
| |
| *Signature: public function appendElementById($parent_id,$tag,$attr,$value,$node)
| |
| *Parameters:
| |
| **$parent_id
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $tag
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $attr
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $value @param $node if non null gets the element relative to that node. Defaults to null
| |
| ***Default Value: ""
| |
| **$node
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]
| |
| ===appendElementByNode()===
| |
| Create and append an element to the given node by id.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L758 i2ce/lib/I2CE_TemplateMeister.php] on line 758
| |
| *Signature: public function appendElementByNode($parent,$tag,$attr,$value,$before)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $parent
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $tag
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $attr
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $value
| |
| ***Default Value: ""
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $before <br/>defaults to false
| |
| ***Default Value: false
| |
| *Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]
| |
| ===appendFileById()===
| |
| This will load the given template and append it to the node with the given id attribute.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L692 i2ce/lib/I2CE_TemplateMeister.php] on line 692
| |
| *Signature: public function appendFileById($contentfile,$tag,$parent_id,$before,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $contentfile
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $tag
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $parent_id
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $before <br/>If set the file will be appended as the first child instead of the last. @param $node if non null gets the element relative to that node. Defaults to null @see loadFile @see appendNodeById
| |
| ***Default Value: false
| |
| **$node
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]
| |
| ===appendFileByName()===
| |
| This will load the given template and append it to the node with the given name attribute at the given occurrence.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L708 i2ce/lib/I2CE_TemplateMeister.php] on line 708
| |
| *Signature: public function appendFileByName($contentfile,$tag,$parent_name,$occurrence,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $contentfile
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $tag
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $parent_name
| |
| ** integer $occurrence @param $node if non null gets the element relative to that node. Defaults to null
| |
| ***Default Value: 0
| |
| **$node
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]@see loadFile @see appendNodeByName
| |
| ===appendFileByNode()===
| |
| This will load the given Template and append it to the given node.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L719 i2ce/lib/I2CE_TemplateMeister.php] on line 719
| |
| *Signature: public function appendFileByNode($contentfile,$tag,$parent)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $contentfile
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $tag <br/>The tagname we of the top-level imported node we wish to append. if null, we import all nodes
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $parent
| |
| *Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]<br/>if $tag is non-null, then it is the appended node, otherwise it is the parent node
| |
| ===appendNode()===
| |
| Append a node to the given parent node if it exists.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L514 i2ce/lib/I2CE_TemplateMeister.php] on line 514
| |
| *Signature: public function appendNode($node,$parent,$before)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $parent
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $before <br/>If set then the node will be appended as the first child instead of the last.
| |
| ***Default Value: false
| |
| ===appendNodeById()===
| |
| Append a node to the node with the given id attribute.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L451 i2ce/lib/I2CE_TemplateMeister.php] on line 451
| |
| *Signature: public function appendNodeById($node,$id,$before,$relative_node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $id
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $before <br/>If set then the node will be appended as the first child instead of the last.
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $relative_node <br/>if non null gets the element relative to that node. Defaults to null
| |
| ***Default Value: null
| |
| ===appendNodeByName()===
| |
| Append a node to the give occurrence of the node with the given name attribute.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L464 i2ce/lib/I2CE_TemplateMeister.php] on line 464
| |
| *Signature: public function appendNodeByName($node,$name,$occurrence,$relative_node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name
| |
| ** integer $occurrence @param $relative_node if non null gets the element relative to that node. Defaults to null
| |
| **$relative_node
| |
| ***Default Value: null
| |
| ===appendNodesByName()===
| |
| Append a node to the give occurrence of the node with the given name attribute.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L481 i2ce/lib/I2CE_TemplateMeister.php] on line 481
| |
| *Signature: public function appendNodesByName($nodes,$name,$occurrence,$before,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $nodes <br/>array of DOMNode or a DOMNodeList
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name
| |
| ** integer $occurrence <br/>which occurence of $name to use. If $occurrence is negative then it will return the occurence offset from the end. Example: -1 returns the last occurence.
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $before <br/>If set then the node will be appended as the first child instead of the last. @param $node if non null gets the element relative to that node. Defaults to null
| |
| ***Default Value: false
| |
| **$node
| |
| ***Default Value: null
| |
| ===appendTextById()===
| |
| Add a string of text to the document and append it to the node with the given id attribute.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L923 i2ce/lib/I2CE_TemplateMeister.php] on line 923
| |
| *Signature: public function appendTextById($text,$tag,$parent_id,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $text
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $tag
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $parent_id @param $node if non null gets the element relative to that node. Defaults to null
| |
| **$node
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]<br/>the node just created
| |
| ===appendTextByName()===
| |
| Add a string of text to the document and append it to the node with the given name attribute of the given occurrence.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L937 i2ce/lib/I2CE_TemplateMeister.php] on line 937
| |
| *Signature: public function appendTextByName($text,$tag,$parent_name,$occurrence,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $text
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $tag
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $parent_name
| |
| ** integer $occurrence @param $node if non null gets the element relative to that node. Defaults to null
| |
| **$node
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]<br/>the node just created
| |
| ===changeAttributesOnNodes()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L1044 i2ce/lib/I2CE_TemplateMeister.php] on line 1044
| |
| *Signature: public function changeAttributesOnNodes($old,$new,$node)
| |
| *Parameters:
| |
| **$old
| |
| **$new
| |
| **$node
| |
| ***Default Value: null
| |
| ===clearHeaders()===
| |
| Clear all headers currently set for this template.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L213 i2ce/lib/I2CE_TemplateMeister.php] on line 213
| |
| *Signature: public function clearHeaders()
| |
| ===createElement()===
| |
| Create an element to be added to this page. Create a new element in the document with the given attributes and return the node to be added where needed.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L367 i2ce/lib/I2CE_TemplateMeister.php] on line 367
| |
| *Signature: public function createElement($element_name,$attributes,$value)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $element_name
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $attributes
| |
| ***Default Value: array()
| |
| **$value
| |
| ***Default Value: ""
| |
| ===createTextNode()===
| |
| Create a text node
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L952 i2ce/lib/I2CE_TemplateMeister.php] on line 952
| |
| *Signature: public function createTextNode($text)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $text <br/>the value of the text node
| |
| ===evaluate()===
| |
| evaluates an Xpath expression on the document
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L962 i2ce/lib/I2CE_TemplateMeister.php] on line 962
| |
| *Signature: public function evaluate($qry,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $qry <br/>an xpath query
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node <br/>If non null, the node at wich we we start the query
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
| |
| ===findAndRemoveNodes()===
| |
| Find and remove nodes. Search the document xpath for any matching nodes and remove them from the document.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L552 i2ce/lib/I2CE_TemplateMeister.php] on line 552
| |
| *Signature: public function findAndRemoveNodes($xpath,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $xpath @param $node if non null gets the element relative to that node. Defaults to null
| |
| **$node
| |
| ***Default Value: null
| |
| ===findTemplate()===
| |
| This method finds the location of a template file.If the file is not an absolute file path, it searches the class path 'XML' This method searches the template directory path from the global configuration array for the given template. If it exists it returns the full path to the file and if not it returns false. It seaches the path backwards so that later directories can override package versions of files.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L85 i2ce/lib/I2CE_TemplateMeister.php] on line 85
| |
| *Signature: public function findTemplate($template,$raise_error)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $template <br/>The name of the template file.
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $raise_error <br/>Defaults to true. Raise error if template is not found
| |
| ***Default Value: true
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
| |
| ===getDisplay()===
| |
| Returns the displayed page as a (tidy!) string
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L242 i2ce/lib/I2CE_TemplateMeister.php] on line 242
| |
| *Signature: public function getDisplay()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getDoc()===
| |
| Get the DOM for the template
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L354 i2ce/lib/I2CE_TemplateMeister.php] on line 354
| |
| *Signature: public function getDoc()
| |
| *Returns: [http://www.php.net/manual/en/class.domdocument.php DOMDocument ]
| |
| ===getElementById()===
| |
| Searches the DOM XPath for the given id. returns the first match found.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L268 i2ce/lib/I2CE_TemplateMeister.php] on line 268
| |
| *Signature: public function getElementById($id,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $id @param $node if non null gets the element relative to that node. Defaults to null
| |
| **$node
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]
| |
| ===getElementByName()===
| |
| Searches the DOM XPath for the given name attribute. This searches the document for the given name attribute. It returns whatever occurrence is requested. If $occurrence is negative then it will return the occurence offset from the end. Example: -1 returns the last occurence. If $occurence is null it returns a DOMNodeList
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L295 i2ce/lib/I2CE_TemplateMeister.php] on line 295
| |
| *Signature: public function getElementByName($name,$occurrence,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name
| |
| ** integer $occurrence @param $node if non null gets the element relative to that node. Defaults to null
| |
| **$node
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]
| |
| ===getElementByTagName()===
| |
| Searches the DOM XPath for the given tag name This searches the document for the given tagname . It returns whatever occurrence is requested. If $occurrence is negative then it will return the occurence offset from the end. Example: -1 returns the last occurence. If $occurence is null it returns a DOMNodeList
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L330 i2ce/lib/I2CE_TemplateMeister.php] on line 330
| |
| *Signature: public function getElementByTagName($tagname,$occurrence,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $tagname
| |
| ** integer $occurrence @param $node if non null gets the element relative to that node. Defaults to null
| |
| **$node
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]
| |
| ===getHeaders()===
| |
| Get the headers for this page.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L221 i2ce/lib/I2CE_TemplateMeister.php] on line 221
| |
| *Signature: public function getHeaders()
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of string
| |
| ===getUser()===
| |
| Get the user for this template
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L68 i2ce/lib/I2CE_TemplateMeister.php] on line 68
| |
| *Signature: public function getUser()
| |
| *Returns: [[Class: I2CE_User | I2CE_User]]<br/>$user or false if non has been set
| |
| ===importText()===
| |
| Add a string of text to the document.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L786 i2ce/lib/I2CE_TemplateMeister.php] on line 786
| |
| *Signature: public function importText($text,$tag)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $text
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $tag <br/>Defaults to "div." If null, all top-level nodes are returned in an array
| |
| ***Default Value: "div"
| |
| *Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]<br/>or array od DOMNodes null on failure
| |
| ===loadFile()===
| |
| Load a template file into the current document. This will load the given template file into the current document. It will only load based on the surrounding tag name given. It doesn't place the given node into the document yet, just makes it available for use.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L642 i2ce/lib/I2CE_TemplateMeister.php] on line 642
| |
| *Signature: public function loadFile($contentfile,$tag)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $contentfile
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $tag <br/>If non-null it is the tagname of a toplevel node we wish to import. if null, we import all nodes.
| |
| ***Default Value: "div"
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>DOMNode -- the node just created if $tag was non-nill. array if $tag was null consisting of the imported nodes.
| |
| ===loadRootFile()===
| |
| Creates a new document and loads the root file used for this template.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L130 i2ce/lib/I2CE_TemplateMeister.php] on line 130
| |
| *Signature: public function loadRootFile($root_file)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $root_file
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>false on failure
| |
| ===loadRootText()===
| |
| Creates a new document and loads the input text
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L164 i2ce/lib/I2CE_TemplateMeister.php] on line 164
| |
| *Signature: public function loadRootText($text)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $text
| |
| *Returns: boolean.<br/>false on failure
| |
| ===prepareDisplay()===
| |
| Called to prepare the display.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L234 i2ce/lib/I2CE_TemplateMeister.php] on line 234
| |
| *Signature: public function prepareDisplay()
| |
| ===processArgs()===
| |
| Process any arguments sent to the page
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L155 i2ce/lib/I2CE_TemplateMeister.php] on line 155
| |
| *Signature: public function processArgs($args)
| |
| *Parameters:
| |
| **$args
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on sucess. false on failure
| |
| ===query()===
| |
| Run an Xpath query on the document
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L978 i2ce/lib/I2CE_TemplateMeister.php] on line 978
| |
| *Signature: public function query($qry,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $qry <br/>an xpath query
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node <br/>If non null, the node at wich we we start the query
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/class.domnodelist.php DOMNodeList ]
| |
| ===raiseError()===
| |
| A raise error method for template that behaves like I2CE::raiseError, except it also displays what is calling the I2CE_Template methods. Raises an error and redirect the user for any critical errors. The default redirect will go to the home page for the site. @param string/mixed $message The error message.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L1003 i2ce/lib/I2CE_TemplateMeister.php] on line 1003
| |
| *Signature: protected function raiseError($message,$type,$redirect)
| |
| *Parameters:
| |
| **$message
| |
| ** integer $type <br/>The error type.
| |
| ***Default Value: E_USER_NOTICE
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $redirect <br/>The page to redirect to for critical errors. @global array
| |
| ***Default Value: ""
| |
| ===reIdNodes()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L1039 i2ce/lib/I2CE_TemplateMeister.php] on line 1039
| |
| *Signature: public function reIdNodes($old_name,$new_name,$node)
| |
| *Parameters:
| |
| **$old_name
| |
| **$new_name
| |
| **$node
| |
| ***Default Value: null
| |
| ===removeNode()===
| |
| Remove the given node from the document.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L538 i2ce/lib/I2CE_TemplateMeister.php] on line 538
| |
| *Signature: public function removeNode($node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node
| |
| ===removeNodeById()===
| |
| Remove a node with the given id attribute.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L530 i2ce/lib/I2CE_TemplateMeister.php] on line 530
| |
| *Signature: public function removeNodeById($id,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $id @param $node if non null gets the element relative to that node. Defaults to null
| |
| **$node
| |
| ***Default Value: null
| |
| ===renameNodes()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L1035 i2ce/lib/I2CE_TemplateMeister.php] on line 1035
| |
| *Signature: public function renameNodes($old_name,$new_name,$node)
| |
| *Parameters:
| |
| **$old_name
| |
| **$new_name
| |
| **$node
| |
| ***Default Value: null
| |
| ===replaceNode()===
| |
| Replace a node based on the id attribute. Finds a node with the same id attribute as the one in the node passed to this method and replaces it.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L435 i2ce/lib/I2CE_TemplateMeister.php] on line 435
| |
| *Signature: public function replaceNode($node,$relative_node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $relative_node <br/>if non null gets the element relative to that node. Defaults to null
| |
| ***Default Value: null
| |
| ===setAttribute()===
| |
| Sets an attribute on the given node ID and xpath. Finds a given node by ID and then searches the given xpath and then adds or replaces the given attribute.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L396 i2ce/lib/I2CE_TemplateMeister.php] on line 396
| |
| *Signature: public function setAttribute($attr,$value,$id,$xpath,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $attr
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $value
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $id <br/>If non-null we perform our xpath query relative to the node with this id
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $xpath <br/>Defaults to null, in which case we set the attribute of the node by id. If non-null, we change the attribute of every node found by the xpath query which is searched relative to the the node with the given id. @param $node if non null gets the element by id relative to that node. Defaults to null
| |
| ***Default Value: null
| |
| **$node
| |
| ***Default Value: null
| |
| ===setLoadOptions()===
| |
| Set the load options used when loading XML templates. If not called, we use the load options = LIBXML_DTDVALID & & LIBXML_DTDATTR @param integer options.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L199 i2ce/lib/I2CE_TemplateMeister.php] on line 199
| |
| *Signature: public function setLoadOptions($options)
| |
| *Parameters:
| |
| **$options
| |
| ===setNodeAttribute()===
| |
| Sets an attribute on the given node.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L419 i2ce/lib/I2CE_TemplateMeister.php] on line 419
| |
| *Signature: public function setNodeAttribute($attr,$value,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $attr
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $value
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node
| |
| ===setUser()===
| |
| Set the user for this template
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L60 i2ce/lib/I2CE_TemplateMeister.php] on line 60
| |
| *Signature: public function setUser($user)
| |
| *Parameters:
| |
| ** [[Class: I2CE_User | I2CE_User]] $user
| |
| ***Default Value: false
| |
| ===setVerboseErrors()===
| |
| Set the verbosity of errors for validation
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L814 i2ce/lib/I2CE_TemplateMeister.php] on line 814
| |
| *Signature: public function setVerboseErrors($verbose)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $verbose
| |
| ===setWorkingDir()===
| |
| Set the working directory for the document. Used for validation and document creation.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L121 i2ce/lib/I2CE_TemplateMeister.php] on line 121
| |
| *Signature: public function setWorkingDir($working_dir)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $working_dir
| |
| ===validate()===
| |
| Validates the XML of this template.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L827 i2ce/lib/I2CE_TemplateMeister.php] on line 827
| |
| *Signature: public function validate()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on sucess
| |
| ===xmlError()===
| |
| Prints an XML error nicely. Based on http://us3.php.net/manual/en/function.libxml-get-errors.php
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_TemplateMeister.php#L861 i2ce/lib/I2CE_TemplateMeister.php] on line 861
| |
| *Signature: public function xmlError($error,$ret_string)
| |
| *Parameters:
| |
| ** LIBXmlError $error <br/>or array or LIBXMLError
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $ret_string <br/>Defaults to false in which it raises an error for the errors . If true, we return a string. if a string, it returns a string with the this value at the begining.
| |
| ***Default Value: false
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ==Inherited Methods==
| |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
