Class: iHRIS Module PersonID: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
This article desrcibes the class '''iHRIS_Module_PersonID''' | This article desrcibes the class '''iHRIS_Module_PersonID'''. | ||
*Extends the class: [[Class: I2CE_Module | I2CE_Module]]. | |||
It is contained in the module [[iHRIS Module List#PersonID|PersonID]] in the package [https://launchpad.net/ihris-common iHRIS Common] | It is contained in the module [[iHRIS Module List#PersonID|PersonID]] in the package [https://launchpad.net/ihris-common iHRIS Common] | ||
| Line 17: | Line 18: | ||
Method called before the module is enabled for the first time. | Method called before the module is enabled for the first time. | ||
*Signature: public function action_initialize() | *Signature: public function action_initialize() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===action_person_id()=== | ===action_person_id()=== | ||
*Signature: public function action_person_id($obj) | *Signature: public function action_person_id($obj) | ||
| Line 31: | Line 32: | ||
Upgrade this module if necessary | Upgrade this module if necessary | ||
*Signature: public function post_update($old_vers,$new_vers) | *Signature: public function post_update($old_vers,$new_vers) | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
Parameters: | 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 ] $old_vers | ||
* [http://www.php.net/manual/en/language.types.string.php string] $new_vers | * [http://www.php.net/manual/en/language.types.string.php string ] $new_vers | ||
===pre_migrate()=== | ===pre_migrate()=== | ||
Run the pre migrate for this module. This can use the old config data before | Run the pre migrate for this module. This can use the old config data before | ||
it has been changed from the config. | it has been changed from the config. | ||
*Signature: protected function pre_migrate() | *Signature: protected function pre_migrate() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===pre_upgrade()=== | ===pre_upgrade()=== | ||
Run the pre upgrade for this module. This can use the old config data before it | Run the pre upgrade for this module. This can use the old config data before it | ||
has been changed from the config. | has been changed from the config. | ||
*Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage) | *Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage) | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
Parameters: | 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 ] $old_vers | ||
* [http://www.php.net/manual/en/language.types.string.php string] $new_vers | * [http://www.php.net/manual/en/language.types.string.php string ] $new_vers | ||
* [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $new_storage | * [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $new_storage | ||
==Inherited Fuzzy Methods== | ==Inherited Fuzzy Methods== | ||
Revision as of 22:25, 16 October 2009
This article desrcibes the class iHRIS_Module_PersonID.
- Extends the class: I2CE_Module.
It is contained in the module PersonID in the package iHRIS Common
The class is defined in the file: modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php
@filesource Class iHRIS_Module_PersonID
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: v3.2
Variables
$do_migrate
A flag to determin if migrate needs to be called during the upgrade method.
- Type: protected n $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)
- Returns: boolean
Parameters:
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)
- Returns: boolean
Parameters:
- string $old_vers
- string $new_vers
- I2CE_MagicDataNode $new_storage
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()
