Class: I2CE Module Tags (Development): Difference between revisions

From IHRIS Wiki
(Created page with '{{otherversions|Class: I2CE_Module_Tags}} This article describes the class ''I2CE_Module_Tags'' . *Extends the class: I2CE_Module. *Locatio…')
 
No edit summary
 
Line 2: Line 2:
This article describes the class ''I2CE_Module_Tags'' .
This article describes the class ''I2CE_Module_Tags'' .
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]].
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]].
*Location: Part of the module [[I2CE Module List (Development)#Tags|Tags]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev
*Location: Part of the module [[I2CE Module List (Development)#Tags|Tags]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L33 modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 33
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L33 modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 33
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
*Since: Demo-v1.a
*Since: Demo-v1.a
Line 9: Line 9:
==Variables==
==Variables==
===$pluralForms===
===$pluralForms===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L270 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 270
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L274 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 274
*Type: protected $pluralForms
*Type: protected $pluralForms


===$node===
===$node===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L432 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 432
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L436 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 436
*Type: static protected $node
*Type: static protected $node


===$page===
===$page===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L433 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 433
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L437 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 437
*Type: static protected $page
*Type: static protected $page


Line 23: Line 23:
===_processModules()===
===_processModules()===
Process any module directives on the page. removes any nodes that refer to non-enabled/non-existent modules. @param DOMNode a node we wish to process modules under the given node.
Process any module directives on the page. removes any nodes that refer to non-enabled/non-existent modules. @param DOMNode a node we wish to process modules under the given node.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L85 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 85
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L85 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 85
*Signature: protected function _processModules($node)
*Signature: protected function _processModules($node)
*Parameters:
*Parameters:
Line 29: Line 29:
***Default Value: null
***Default Value: null
===addArgument()===
===addArgument()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L365 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 365
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L369 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 369
*Signature: static protected function addArgument($args,$arg,$append)
*Signature: static protected function addArgument($args,$arg,$append)
*Parameters:
*Parameters:
Line 36: Line 36:
**&$append  
**&$append  
===callModuleFunction()===
===callModuleFunction()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L461 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 461
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L465 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 465
*Signature: static public function callModuleFunction($module,$func,$argument,$templatefunction,$default_category)
*Signature: static public function callModuleFunction($module,$func,$argument,$templatefunction,$default_category)
*Parameters:
*Parameters:
Line 47: Line 47:
***Default Value: 'DISPLAY'
***Default Value: 'DISPLAY'
===cleanUpPrintF()===
===cleanUpPrintF()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L306 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 306
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L310 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 310
*Signature: protected function cleanUpPrintF($template,$node)
*Signature: protected function cleanUpPrintF($template,$node)
*Parameters:
*Parameters:
Line 53: Line 53:
**$node  
**$node  
===extractPrintFArgs()===
===extractPrintFArgs()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L272 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 272
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L276 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 276
*Signature: protected function extractPrintFArgs($text)
*Signature: protected function extractPrintFArgs($text)
*Parameters:
*Parameters:
Line 59: Line 59:
===getArguments()===
===getArguments()===
Process an argument string to return an array of argments
Process an argument string to return an array of argments
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L444 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 444
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L448 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 448
*Signature: static public function getArguments($page,$node,$arg,$templatefunction)
*Signature: static public function getArguments($page,$node,$arg,$templatefunction)
*Parameters:
*Parameters:
Line 69: Line 69:
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===getHooks()===
===getHooks()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L36 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 36
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L36 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 36
*Signature: static public function getHooks()
*Signature: static public function getHooks()
===getPluralForm()===
===getPluralForm()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L321 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 321
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L325 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 325
*Signature: public function getPluralForm($module,$args)
*Signature: public function getPluralForm($module,$args)
*Parameters:
*Parameters:
Line 78: Line 78:
**$args  
**$args  
===printf()===
===printf()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L333 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 333
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L337 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 337
*Signature: public function printf()
*Signature: public function printf()
===processDisplayValues()===
===processDisplayValues()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L187 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 187
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L189 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 189
*Signature: protected function processDisplayValues()
*Signature: protected function processDisplayValues()
===processModules()===
===processModules()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L65 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 65
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L65 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 65
*Signature: public function processModules($page)
*Signature: public function processModules($page)
*Parameters:
*Parameters:
**$page  
**$page  
===processPrintFs()===
===processPrintFs()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L209 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 209
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L213 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 213
*Signature: protected function processPrintFs()
*Signature: protected function processPrintFs()
===processScripts()===
===processScripts()===
Process any script directives on the page. @param I2CE_Template $template Basically we move any <script> tags from the body (which were inserted by templates) to the header.  There is some additional functionality: if the body attribute is set, then that script is the javascript for the event with that value. e.g. <script body='onscoll'>alert('annoying hello')</script> will result in an alert box being displayed anytime the page is scrolled.  Specifically we set the body node to have attribute 'event' with value the content of the script. <p/> If the src attribute is set with a relative file path, then it will serve up the file with the file dump utility. Nothing is done with the value of a  body attribute if the src attribute is present.
Process any script directives on the page. @param I2CE_Template $template Basically we move any <script> tags from the body (which were inserted by templates) to the header.  There is some additional functionality: if the body attribute is set, then that script is the javascript for the event with that value. e.g. <script body='onscoll'>alert('annoying hello')</script> will result in an alert box being displayed anytime the page is scrolled.  Specifically we set the body node to have attribute 'event' with value the content of the script. <p/> If the src attribute is set with a relative file path, then it will serve up the file with the file dump utility. Nothing is done with the value of a  body attribute if the src attribute is present.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L997 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 997
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L1001 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 1001
*Signature: protected function processScripts()
*Signature: protected function processScripts()
===processTags()===
===processTags()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L44 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 44
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L44 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 44
*Signature: public function processTags($page)
*Signature: public function processTags($page)
*Parameters:
*Parameters:
**$page  
**$page  
===setPage()===
===setPage()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L60 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 60
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php#L60 i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php] on line 60
*Signature: static public function setPage($page)
*Signature: static public function setPage($page)
*Parameters:
*Parameters:
Line 120: Line 120:
===action_initialize()===
===action_initialize()===
This public method is inherited from [[Class: I2CE_Module (Development)#action_initialize() | I2CE_Module->action_initialize()]]
This public method is inherited from [[Class: I2CE_Module (Development)#action_initialize() | I2CE_Module->action_initialize()]]
===getCLIHooks()===
This public method is inherited from [[Class: I2CE_Module (Development)#getCLIHooks() | I2CE_Module->getCLIHooks()]]


===getCLIMethods()===
===getCLIMethods()===

Latest revision as of 09:16, 6 May 2015


This article describes the class I2CE_Module_Tags .

The module that adds in an image data type I2CE_Module_Tags @todo better documentation

Variables

$pluralForms

$node

$page

Methods

_processModules()

Process any module directives on the page. removes any nodes that refer to non-enabled/non-existent modules. @param DOMNode a node we wish to process modules under the given node.

addArgument()

callModuleFunction()

  • Defined in i2ce/modules/TemplateData/modules/Tags/I2CE_Module_Tags.php on line 465
  • Signature: static public function callModuleFunction($module,$func,$argument,$templatefunction,$default_category)
  • Parameters:
    • $module
    • $func
    • &$argument
    • $templatefunction
      • Default Value: false
    • $default_category
      • Default Value: 'DISPLAY'

cleanUpPrintF()

extractPrintFArgs()

getArguments()

Process an argument string to return an array of argments

getHooks()

getPluralForm()

printf()

processDisplayValues()

processModules()

processPrintFs()

processScripts()

Process any script directives on the page. @param I2CE_Template $template Basically we move any <script> tags from the body (which were inserted by templates) to the header. There is some additional functionality: if the body attribute is set, then that script is the javascript for the event with that value. e.g. <script body='onscoll'>alert('annoying hello')</script> will result in an alert box being displayed anytime the page is scrolled. Specifically we set the body node to have attribute 'event' with value the content of the script.

If the src attribute is set with a relative file path, then it will serve up the file with the file dump utility. Nothing is done with the value of a body attribute if the src attribute is present.

processTags()

setPage()

Inherited Methods

__construct()

This public method is inherited from I2CE_Module->__construct()

action_configure()

This public method is inherited from I2CE_Module->action_configure()

action_disable()

This public method is inherited from I2CE_Module->action_disable()

action_enable()

This public method is inherited from I2CE_Module->action_enable()

action_initialize()

This public method is inherited from I2CE_Module->action_initialize()

getCLIMethods()

This public method is inherited from I2CE_Module->getCLIMethods()

getConfig()

This public method is inherited from I2CE_Module->getConfig()

getMethods()

This public method is inherited from I2CE_Module->getMethods()

post_update()

This public method is inherited from I2CE_Module->post_update()

pre_upgrade()

This public method is inherited from I2CE_Module->pre_upgrade()

upgrade()

This public method is inherited from I2CE_Module->upgrade()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Fuzzy Methods

launchBackgroundProcess()

This method is inherited from I2CE_Module->launchBackgroundProcess()

launchBackgroundPHPScript()

This method is inherited from I2CE_Module->launchBackgroundPHPScript()

launchBackgroundPage()

This method is inherited from I2CE_Module->launchBackgroundPage()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()