Class: iHRIS Module PersonID: Difference between revisions
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
This article | This article describes the class ''iHRIS_Module_PersonID''. | ||
*Extends the class: [[Class: I2CE_Module | I2CE_Module]]. | *Extends the class: [[Class: I2CE_Module | I2CE_Module]]. | ||
*Parent Classses: [[Class: I2CE_Module | I2CE_Module]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]] | *Parent Classses: [[Class: I2CE_Module | I2CE_Module]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]] |
Revision as of 11:39, 19 October 2009
This article describes the class iHRIS_Module_PersonID.
- Extends the class: I2CE_Module.
- Parent Classses: I2CE_Module I2CE_Fuzzy
- Location: Part of the module PersonID in the package iHRIS Common
- Source: Defined in the file modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: v3.2
@filesource Class iHRIS_Module_PersonID
Variables
$do_migrate
A flag to determin if migrate needs to be called during the upgrade method.
- Type: protected boolean $do_migrate
Methods
action_initialize()
Method called before the module is enabled for the first time.
- Signature: public function action_initialize()
- Returns: boolean
action_person_id()
- Signature: public function action_person_id($obj)
- Parameters:
- $obj
getMethods()
- Signature: static public function getMethods()
migrate()
Perform the migrate actions for this module.
- Signature: protected function migrate()
- Returns: boolean;
post_update()
Upgrade this module if necessary
- Signature: public function post_update($old_vers,$new_vers)
- Parameters:
- Returns: boolean
pre_migrate()
Run the pre migrate for this module. This can use the old config data before it has been changed from the config.
- Signature: protected function pre_migrate()
- Returns: boolean
pre_upgrade()
Run the pre upgrade for this module. This can use the old config data before it has been changed from the config.
- Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage)
- Parameters:
- string $old_vers
- string $new_vers
- I2CE_MagicDataNode $new_storage
- Returns: boolean
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()
conflict_external()
This public method is inherited from I2CE_Module->conflict_external()
getCLIHooks()
This public method is inherited from I2CE_Module->getCLIHooks()
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()
requirement_external()
This public method is inherited from I2CE_Module->requirement_external()
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()