Class: I2CE Module FormStorageEntry: Difference between revisions

From IHRIS Wiki
No edit summary
 
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article desrcibes the class ''I2CE_Module_FormStorageEntry''.
#REDIRECT [[Class: I2CE_Module_FormStorageEntry (4.1.7)]]
*Extends the class: [[Class: I2CE_Module | I2CE_Module]].
*Location: Part of the module [[iHRIS Module List#forms-storage-entry|forms-storage-entry]] in the package [https://launchpad.net/i2ce I2CE]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php]
*Author: Carl Leitner <litlfred@ibiblio.org>
*Since: v3.2.69
@filesource Class I2CE_Module_FormStorageEntry
==Methods==
===action_initialize()===
Method called when the module is enabled for the first time. @param boolean -- returns true on success. false on error.
*Signature: public function action_initialize()
===addBlobValue()===
*Signature: private function addBlobValue()
===addParentFormColumnToRecordTable()===
Adds in the parent form column to the record table
*Signature: protected function addParentFormColumnToRecordTable($table)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $table <br/>the table to fixup the parent columns on.  Defaulst to 'record'
***Default Value: 'record'
===createIndexOnLastEntry()===
Checks to make sure there is the given index on the last_entry.  If it does not exist it adds it.
*Signature: protected function createIndexOnLastEntry($index_name,$fields)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $index_name
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $fields <br/>Either a string or array of string, the fields we want to make an index on If the field names need backtics, you are required to provide them
===dropColumnFromTable()===
Drop a column from the indicated table
*Signature: protected function dropColumnFromTable($column,$table)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $column
** [http://www.php.net/manual/en/language.types.string.php string ] $table
===upgrade()===
Upgrade module method
*Signature: public function upgrade($old_vers,$new_vers)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $old_vers
** [http://www.php.net/manual/en/language.types.string.php string ] $new_vers
==Inherited Methods==
===__construct()===
This public method is inherited from [[Class: I2CE_Module#__construct() | I2CE_Module->__construct()]]
 
===action_configure()===
This public method is inherited from [[Class: I2CE_Module#action_configure() | I2CE_Module->action_configure()]]
 
===action_disable()===
This public method is inherited from [[Class: I2CE_Module#action_disable() | I2CE_Module->action_disable()]]
 
===action_enable()===
This public method is inherited from [[Class: I2CE_Module#action_enable() | I2CE_Module->action_enable()]]
 
===conflict_external()===
This public method is inherited from [[Class: I2CE_Module#conflict_external() | I2CE_Module->conflict_external()]]
 
===getCLIHooks()===
This public method is inherited from [[Class: I2CE_Module#getCLIHooks() | I2CE_Module->getCLIHooks()]]
 
===getCLIMethods()===
This public method is inherited from [[Class: I2CE_Module#getCLIMethods() | I2CE_Module->getCLIMethods()]]
 
===getConfig()===
This public method is inherited from [[Class: I2CE_Module#getConfig() | I2CE_Module->getConfig()]]
 
===getHooks()===
This public method is inherited from [[Class: I2CE_Module#getHooks() | I2CE_Module->getHooks()]]
 
===getMethods()===
This public method is inherited from [[Class: I2CE_Module#getMethods() | I2CE_Module->getMethods()]]
 
===post_update()===
This public method is inherited from [[Class: I2CE_Module#post_update() | I2CE_Module->post_update()]]
 
===pre_upgrade()===
This public method is inherited from [[Class: I2CE_Module#pre_upgrade() | I2CE_Module->pre_upgrade()]]
 
===requirement_external()===
This public method is inherited from [[Class: I2CE_Module#requirement_external() | I2CE_Module->requirement_external()]]
 
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Fuzzy Methods==
===launchBackgroundProcess()===
This method is inherited from [[Class: I2CE_Module#launchBackgroundProcess() | I2CE_Module->launchBackgroundProcess()]]
 
===launchBackgroundPHPScript()===
This method is inherited from [[Class: I2CE_Module#launchBackgroundPHPScript() | I2CE_Module->launchBackgroundPHPScript()]]
 
===launchBackgroundPage()===
This method is inherited from [[Class: I2CE_Module#launchBackgroundPage() | I2CE_Module->launchBackgroundPage()]]
 
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
 
 
[[Category:Class Documentation]]

Latest revision as of 09:43, 23 August 2013