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

From IHRIS Wiki
(Created page with '{{otherversions|Class: I2CE_Module_CachedForms}} This article describes the class ''I2CE_Module_CachedForms'' . *Extends the class: [[Class: I2CE_Module (Development) | I2CE_Modu…')
 
No edit summary
 
Line 2: Line 2:
This article describes the class ''I2CE_Module_CachedForms'' .
This article describes the class ''I2CE_Module_CachedForms'' .
*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)#CachedForms|CachedForms]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev
*Location: Part of the module [[I2CE Module List (Development)#CachedForms|CachedForms]] 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/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L30 modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 30
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L30 modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 30
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_Module_CachedForms
I2CE_Module_CachedForms
==Methods==
==Methods==
===cachedTableReference()===
===cachedTableReference()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L170 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 170
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L224 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 224
*Signature: static public function cachedTableReference($fieldObj)
*Signature: static public function cachedTableReference($fieldObj)
*Parameters:
*Parameters:
**$fieldObj  
**$fieldObj  
===dropTable_hook()===
Hooked method to drop a cached table
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L91 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 91
*Signature: public function dropTable_hook($args)
*Parameters:
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $args <br/>an array of two elements whose first element is a form object, the second is the user
===formIsDirty()===
===formIsDirty()===
Checks to see if a form as dirty (needs to be cached)
Checks to see if a form as dirty (needs to be cached)
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L149 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 149
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L203 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 203
*Signature: static public function formIsDirty($form)
*Signature: static public function formIsDirty($form)
*Parameters:
*Parameters:
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $form <br/>Either a form object or a strgin.
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $form <br/>Either a form object or a strgin.
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===getCLIHooks()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L56 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 56
*Signature: static public function getCLIHooks()
===getCLIMethods()===
===getCLIMethods()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L41 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 41
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L41 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 41
*Signature: static public function getCLIMethods()
*Signature: static public function getCLIMethods()
===getHooks()===
===getHooks()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L48 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 48
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L48 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 48
*Signature: static public function getHooks()
*Signature: static public function getHooks()
===getMethods()===
===getMethods()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L32 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 32
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L32 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 32
*Signature: static public function getMethods()
*Signature: static public function getMethods()
===globalUpdate_hook()===
Hooked method to marks a form as dirty (needs to be cached).
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L64 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 64
*Signature: public function globalUpdate_hook($args)
*Parameters:
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $args <br/>an array of two elements whose first element is a form object, the second is the user
===markFormClean()===
===markFormClean()===
Marks a form as clean (does not need to be cached) if the dirty time does not exceed the given time stamp
Marks a form as clean (does not need to be cached) if the dirty time does not exceed the given time stamp
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L115 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 115
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L169 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 169
*Signature: static public function markFormClean($args,$timestamp)
*Signature: static public function markFormClean($args,$timestamp)
*Parameters:
*Parameters:
Line 41: Line 50:
===markFormDirty()===
===markFormDirty()===
Marks a form as dirty (needs to be cached).
Marks a form as dirty (needs to be cached).
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L86 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 86
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L140 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 140
*Signature: static public function markFormDirty($form,$timestamp)
*Signature: static public function markFormDirty($form,$timestamp)
*Parameters:
*Parameters:
Line 49: Line 58:
===markFormDirty_hook()===
===markFormDirty_hook()===
Hooked method to marks a form as dirty (needs to be cached).
Hooked method to marks a form as dirty (needs to be cached).
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L69 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 69
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L115 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 115
*Signature: public function markFormDirty_hook($args)
*Signature: public function markFormDirty_hook($args)
*Parameters:
*Parameters:
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $args <br/>an array of two elements whose first element is a form object, the second is the user
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $args <br/>an array of two elements whose first element is a form object, the second is the user
===refreshCaches()===
===refreshCaches()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L174 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 174
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php#L228 i2ce/modules/Forms/modules/CachedForms/lib/I2CE_Module_CachedForms.php] on line 228
*Signature: public function refreshCaches()
*Signature: public function refreshCaches()
==Inherited Methods==
==Inherited Methods==

Latest revision as of 09:15, 6 May 2015


This article describes the class I2CE_Module_CachedForms .

I2CE_Module_CachedForms

Methods

cachedTableReference()

dropTable_hook()

Hooked method to drop a cached table

formIsDirty()

Checks to see if a form as dirty (needs to be cached)

getCLIMethods()

getHooks()

getMethods()

globalUpdate_hook()

Hooked method to marks a form as dirty (needs to be cached).

markFormClean()

Marks a form as clean (does not need to be cached) if the dirty time does not exceed the given time stamp

markFormDirty()

Marks a form as dirty (needs to be cached).

markFormDirty_hook()

Hooked method to marks a form as dirty (needs to be cached).

refreshCaches()

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()

getConfig()

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

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()