Class: iHRIS Module ManageJob (Development): Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
This article describes the class ''iHRIS_Module_ManageJob'' . | This article describes the class ''iHRIS_Module_ManageJob'' . | ||
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]]. | *Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]]. | ||
*Location: Part of the module [[iHRIS Manage Module List (Development)#ihris-manage-Job|ihris-manage-Job]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] 4. | *Location: Part of the module [[iHRIS Manage Module List (Development)#ihris-manage-Job|ihris-manage-Job]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] 4.1-dev | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManageJob/lib/iHRIS_Module_ManageJob.php#L31 modules/ManageJob/lib/iHRIS_Module_ManageJob.php] on line 31 | ||
*Author: Luke Duncan <lduncan@intrahealth.org> | *Author: Luke Duncan <lduncan@intrahealth.org> | ||
*Since: 3.2.3 | *Since: 3.2.3 | ||
| Line 10: | Line 10: | ||
===$do_migrate=== | ===$do_migrate=== | ||
A flag to determine if migrate needs to be called during the upgrade method. | A flag to determine if migrate needs to be called during the upgrade method. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManageJob/lib/iHRIS_Module_ManageJob.php#L36 manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php] on line 36 | ||
*Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $do_migrate | *Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $do_migrate | ||
===$do_migrate326=== | ===$do_migrate326=== | ||
A flag to determine if migrate326 needs to be called during the upgrade method. | A flag to determine if migrate326 needs to be called during the upgrade method. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManageJob/lib/iHRIS_Module_ManageJob.php#L40 manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php] on line 40 | ||
*Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $do_migrate326 | *Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $do_migrate326 | ||
| Line 21: | Line 21: | ||
===action_initialize()=== | ===action_initialize()=== | ||
Method called before the module is enabled for the first time. @param boolean -- returns true on success. false on error. | Method called before 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/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManageJob/lib/iHRIS_Module_ManageJob.php#L137 manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php] on line 137 | ||
*Signature: public function action_initialize() | *Signature: public function action_initialize() | ||
===migrate()=== | ===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. | 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. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManageJob/lib/iHRIS_Module_ManageJob.php#L76 manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php] on line 76 | ||
*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 ] | ||
===migrate326()=== | ===migrate326()=== | ||
Perform the migrate actions for this module from 3.2.5 to 3.2.6. This is for going from pre 3.2 versions where benefit data has been saved to the database. | Perform the migrate actions for this module from 3.2.5 to 3.2.6. This is for going from pre 3.2 versions where benefit data has been saved to the database. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManageJob/lib/iHRIS_Module_ManageJob.php#L117 manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php] on line 117 | ||
*Signature: protected function migrate326() | *Signature: protected function migrate326() | ||
*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 | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManageJob/lib/iHRIS_Module_ManageJob.php#L199 manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php] on line 199 | ||
*Signature: public function post_update($old_vers,$new_vers) | *Signature: public function post_update($old_vers,$new_vers) | ||
*Parameters: | *Parameters: | ||
| Line 43: | Line 43: | ||
===pre_migrate()=== | ===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. | 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. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManageJob/lib/iHRIS_Module_ManageJob.php#L48 manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php] on line 48 | ||
*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_migrate326()=== | ===pre_migrate326()=== | ||
Perform any pre migrate actions for this module from 3.2.5 to 3.2.6. This is for going from pre 3.2 versions where benefit data has been saved to the database. | Perform any pre migrate actions for this module from 3.2.5 to 3.2.6. This is for going from pre 3.2 versions where benefit data has been saved to the database. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManageJob/lib/iHRIS_Module_ManageJob.php#L61 manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php] on line 61 | ||
*Signature: protected function pre_migrate326() | *Signature: protected function pre_migrate326() | ||
*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 has been changed from the config. | Run the pre upgrade for this module. This can use the old config data before it has been changed from the config. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManageJob/lib/iHRIS_Module_ManageJob.php#L170 manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php] on line 170 | ||
*Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage) | *Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage) | ||
*Parameters: | *Parameters: | ||
| Line 72: | Line 72: | ||
===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 09:26, 6 May 2015
For other versions, see Class: iHRIS_Module_ManageJob (versions) .
This article describes the class iHRIS_Module_ManageJob .
- Extends the class: I2CE_Module.
- Location: Part of the module ihris-manage-Job in the package iHRIS Manage 4.1-dev
- Source: Defined in the file modules/ManageJob/lib/iHRIS_Module_ManageJob.php on line 31
- Author: Luke Duncan <lduncan@intrahealth.org>
- Since: 3.2.3
iHRIS_Module_ManageJob
Variables
$do_migrate
A flag to determine if migrate needs to be called during the upgrade method.
- Defined in manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php on line 36
- Type: protected boolean $do_migrate
$do_migrate326
A flag to determine if migrate326 needs to be called during the upgrade method.
- Defined in manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php on line 40
- Type: protected boolean $do_migrate326
Methods
action_initialize()
Method called before the module is enabled for the first time. @param boolean -- returns true on success. false on error.
- Defined in manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php on line 137
- Signature: public function action_initialize()
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.
- Defined in manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php on line 76
- Signature: protected function migrate()
- Returns: boolean
migrate326()
Perform the migrate actions for this module from 3.2.5 to 3.2.6. This is for going from pre 3.2 versions where benefit data has been saved to the database.
- Defined in manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php on line 117
- Signature: protected function migrate326()
- Returns: boolean
post_update()
Upgrade this module if necessary
- Defined in manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php on line 199
- Signature: public function post_update($old_vers,$new_vers)
- Parameters:
- Returns: boolean
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.
- Defined in manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php on line 48
- Signature: protected function pre_migrate()
- Returns: boolean
pre_migrate326()
Perform any pre migrate actions for this module from 3.2.5 to 3.2.6. This is for going from pre 3.2 versions where benefit data has been saved to the database.
- Defined in manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php on line 61
- Signature: protected function pre_migrate326()
- 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.
- Defined in manage/modules/ManageJob/lib/iHRIS_Module_ManageJob.php on line 170
- 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()
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()
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()
