Class: I2CE Module FormStorageEntry (Development): Difference between revisions
(Created page with '{{otherversions|Class: I2CE_Module_FormStorageEntry}} This article describes the class ''I2CE_Module_FormStorageEntry'' . *Extends the class: [[Class: I2CE_Module (Development) |…') |
No edit summary |
||
Line 2: | Line 2: | ||
This article describes the class ''I2CE_Module_FormStorageEntry'' . | This article describes the class ''I2CE_Module_FormStorageEntry'' . | ||
*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)#forms-storage-entry|forms-storage-entry]] in the package [https://launchpad.net/i2ce I2CE] 4. | *Location: Part of the module [[I2CE Module List (Development)#forms-storage-entry|forms-storage-entry]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php#L33 modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php] on line 33 | ||
*Author: Carl Leitner <litlfred@ibiblio.org> | *Author: Carl Leitner <litlfred@ibiblio.org> | ||
*Since: v3.2.69 | *Since: v3.2.69 | ||
Line 10: | Line 10: | ||
===action_initialize()=== | ===action_initialize()=== | ||
Method called when the module is enabled for the first time. @param boolean -- returns true on success. false on error. | Method called when the module is enabled for the first time. @param boolean -- returns true on success. false on error. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php#L40 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php] on line 40 | ||
*Signature: public function action_initialize() | *Signature: public function action_initialize() | ||
===addBlobValue()=== | ===addBlobValue()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php#L60 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php] on line 60 | ||
*Signature: private function addBlobValue() | *Signature: private function addBlobValue() | ||
===addCreationDate()=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php#L115 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php] on line 115 | |||
*Signature: protected function addCreationDate() | |||
===addParentFormColumnToRecordTable()=== | ===addParentFormColumnToRecordTable()=== | ||
Adds in the parent form column to the record table | Adds in the parent form column to the record table | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php#L199 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php] on line 199 | ||
*Signature: protected function addParentFormColumnToRecordTable($table) | *Signature: protected function addParentFormColumnToRecordTable($table) | ||
*Parameters: | *Parameters: | ||
Line 24: | Line 27: | ||
===createIndexOnLastEntry()=== | ===createIndexOnLastEntry()=== | ||
Checks to make sure there is the given index on the last_entry. If it does not exist it adds it. | Checks to make sure there is the given index on the last_entry. If it does not exist it adds it. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php#L160 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php] on line 160 | ||
*Signature: protected function createIndexOnLastEntry($index_name,$fields) | *Signature: protected function createIndexOnLastEntry($index_name,$fields) | ||
*Parameters: | *Parameters: | ||
Line 31: | Line 34: | ||
===dropColumnFromTable()=== | ===dropColumnFromTable()=== | ||
Drop a column from the indicated table | Drop a column from the indicated table | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php#L141 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php] on line 141 | ||
*Signature: protected function dropColumnFromTable($column,$table) | *Signature: protected function dropColumnFromTable($column,$table) | ||
*Parameters: | *Parameters: | ||
Line 38: | Line 41: | ||
===upgrade()=== | ===upgrade()=== | ||
Upgrade module method | Upgrade module method | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php#L77 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php] on line 77 | ||
*Signature: public function upgrade($old_vers,$new_vers) | *Signature: public function upgrade($old_vers,$new_vers) | ||
*Parameters: | *Parameters: | ||
Line 55: | Line 58: | ||
===action_enable()=== | ===action_enable()=== | ||
This public method is inherited from [[Class: I2CE_Module (Development)#action_enable() | I2CE_Module->action_enable()]] | This public method is inherited from [[Class: I2CE_Module (Development)#action_enable() | I2CE_Module->action_enable()]] | ||
===getCLIMethods()=== | ===getCLIMethods()=== |
Latest revision as of 08:15, 6 May 2015
This article describes the class I2CE_Module_FormStorageEntry .
- Extends the class: I2CE_Module.
- Location: Part of the module forms-storage-entry in the package I2CE 4.1-dev
- Source: Defined in the file modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php on line 33
- 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.
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php on line 40
- Signature: public function action_initialize()
addBlobValue()
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php on line 60
- Signature: private function addBlobValue()
addCreationDate()
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php on line 115
- Signature: protected function addCreationDate()
addParentFormColumnToRecordTable()
Adds in the parent form column to the record table
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php on line 199
- Signature: protected function addParentFormColumnToRecordTable($table)
- Parameters:
- string $table
the table to fixup the parent columns on. Defaulst to 'record'- Default Value: 'record'
- string $table
createIndexOnLastEntry()
Checks to make sure there is the given index on the last_entry. If it does not exist it adds it.
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php on line 160
- Signature: protected function createIndexOnLastEntry($index_name,$fields)
- Parameters:
dropColumnFromTable()
Drop a column from the indicated table
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php on line 141
- Signature: protected function dropColumnFromTable($column,$table)
- Parameters:
upgrade()
Upgrade module method
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageEntry/lib/I2CE_Module_FormStorageEntry.php on line 77
- Signature: public function upgrade($old_vers,$new_vers)
- Parameters:
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()
getCLIMethods()
This public method is inherited from I2CE_Module->getCLIMethods()
getConfig()
This public method is inherited from I2CE_Module->getConfig()
getHooks()
This public method is inherited from I2CE_Module->getHooks()
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()
_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()