Class: iHRIS Module PersonLanguage: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
This article desrcibes the class '''iHRIS_Module_PersonLanguage''' | This article desrcibes the class '''iHRIS_Module_PersonLanguage'''. | ||
*Extends the class: [[Class: I2CE_Module | I2CE_Module]]. | |||
It is contained in the module [[iHRIS Module List#PersonLanguage|PersonLanguage]] in the package [https://launchpad.net/ihris-common iHRIS Common] | It is contained in the module [[iHRIS Module List#PersonLanguage|PersonLanguage]] in the package [https://launchpad.net/ihris-common iHRIS Common] | ||
| Line 29: | Line 30: | ||
been saved to the database. | been saved to the database. | ||
*Signature: protected function migrate() | *Signature: protected function 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 ] | ||
===post_update()=== | ===post_update()=== | ||
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()=== | ||
Perform any pre migrate actions for this module. | Perform any pre migrate actions for this module. | ||
| Line 42: | Line 43: | ||
been saved to the database. | been saved to the database. | ||
*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 21:25, 16 October 2009
This article desrcibes the class iHRIS_Module_PersonLanguage.
- Extends the class: I2CE_Module.
It is contained in the module PersonLanguage in the package iHRIS Common
The class is defined in the file: modules/Person/modules/Language/lib/iHRIS_Module_PersonLanguage.php
@filesource Class iHRIS_Module_PersonLanguage
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: v3.2
Variables
$do_migrate
@ var boolean A flag to determine if migrate needs to be called during the upgrade method.
- Type: protected $do_migrate
Methods
action_initialize()
Method called before the module is enabled for the first time. @param boolean -- returns true on success. false on error.
- Signature: public function action_initialize()
action_person_language()
- Signature: public function action_person_language($obj)
Parameters:
- $obj
getMethods()
- Signature: static public function getMethods()
migrate()
Perform the migrate actions for this module This is for going from pre 3.2 versions where benefit data has been saved to the database.
- 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()
Perform any pre migrate actions for this module. This is for going from pre 3.2 versions where benefit data has been saved to the database.
- 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()
