Class: iHRIS Module Application (Development): Difference between revisions
(Created page with '{{otherversions|Class: iHRIS_Module_Application}} This article describes the class ''iHRIS_Module_Application'' . *Extends the class: [[Class: I2CE_Module (Development) | I2CE_Mo…') |
No edit summary |
||
Line 2: | Line 2: | ||
This article describes the class ''iHRIS_Module_Application'' . | This article describes the class ''iHRIS_Module_Application'' . | ||
*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-Application|ihris-manage-Application]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] 4. | *Location: Part of the module [[iHRIS Manage Module List (Development)#ihris-manage-Application|ihris-manage-Application]] 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/ManageApplication/lib/iHRIS_Module_Application.php#L32 modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 32 | ||
*Author: Carl Leitner <litlfred@ibiblio.org> | *Author: Carl Leitner <litlfred@ibiblio.org> | ||
*Since: v3.2.2 | *Since: v3.2.2 | ||
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/ManageApplication/lib/iHRIS_Module_Application.php#L62 manage/modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 62 | ||
*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/ManageApplication/lib/iHRIS_Module_Application.php#L66 manage/modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 66 | ||
*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 | ||
==Methods== | ==Methods== | ||
===action_application()=== | ===action_application()=== | ||
*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/ManageApplication/lib/iHRIS_Module_Application.php#L246 manage/modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 246 | ||
*Signature: public function action_application($page) | *Signature: public function action_application($page) | ||
*Parameters: | *Parameters: | ||
Line 26: | Line 26: | ||
===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/ManageApplication/lib/iHRIS_Module_Application.php#L141 manage/modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 141 | ||
*Signature: public function action_initialize() | *Signature: public function action_initialize() | ||
===action_position_decision()=== | ===action_position_decision()=== | ||
*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/ManageApplication/lib/iHRIS_Module_Application.php#L238 manage/modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 238 | ||
*Signature: public function action_position_decision($page) | *Signature: public function action_position_decision($page) | ||
*Parameters: | *Parameters: | ||
**$page | **$page | ||
===action_position_interview()=== | ===action_position_interview()=== | ||
*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/ManageApplication/lib/iHRIS_Module_Application.php#L230 manage/modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 230 | ||
*Signature: public function action_position_interview($page) | *Signature: public function action_position_interview($page) | ||
*Parameters: | *Parameters: | ||
**$page | **$page | ||
===getHooks()=== | |||
Return the array of hooks available in this module. | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManageApplication/lib/iHRIS_Module_Application.php#L39 manage/modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 39 | |||
*Signature: static public function getHooks() | |||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ] | |||
===getMethods()=== | ===getMethods()=== | ||
*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/ManageApplication/lib/iHRIS_Module_Application.php#L218 manage/modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 218 | ||
*Signature: static public function getMethods() | *Signature: static public function getMethods() | ||
===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/ManageApplication/lib/iHRIS_Module_Application.php#L103 manage/modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 103 | ||
*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.4 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.4 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/ManageApplication/lib/iHRIS_Module_Application.php#L122 manage/modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 122 | ||
*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/ManageApplication/lib/iHRIS_Module_Application.php#L200 manage/modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 200 | ||
*Signature: public function post_update($old_vers,$new_vers) | *Signature: public function post_update($old_vers,$new_vers) | ||
*Parameters: | *Parameters: | ||
Line 61: | Line 66: | ||
===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/ManageApplication/lib/iHRIS_Module_Application.php#L75 manage/modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 75 | ||
*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.4 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.4 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/ManageApplication/lib/iHRIS_Module_Application.php#L88 manage/modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 88 | ||
*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/ManageApplication/lib/iHRIS_Module_Application.php#L172 manage/modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 172 | ||
*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 78: | Line 83: | ||
** [[Class: I2CE_MagicDataNode (Development) | I2CE_MagicDataNode]] $new_storage | ** [[Class: I2CE_MagicDataNode (Development) | I2CE_MagicDataNode]] $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 ] | ||
===validate_form_application()=== | |||
Checks to make sure all the required fields are valid for the application. | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManageApplication/lib/iHRIS_Module_Application.php#L49 manage/modules/ManageApplication/lib/iHRIS_Module_Application.php] on line 49 | |||
*Signature: public function validate_form_application($form) | |||
*Parameters: | |||
** [[Class: I2CE_Form (Development) | I2CE_Form]] $form | |||
==Inherited Methods== | ==Inherited Methods== | ||
===__construct()=== | ===__construct()=== | ||
Line 90: | Line 101: | ||
===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()=== | ||
Line 99: | Line 107: | ||
===getConfig()=== | ===getConfig()=== | ||
This public method is inherited from [[Class: I2CE_Module (Development)#getConfig() | I2CE_Module->getConfig()]] | This public method is inherited from [[Class: I2CE_Module (Development)#getConfig() | I2CE_Module->getConfig()]] | ||
===upgrade()=== | ===upgrade()=== |
Latest revision as of 08:26, 6 May 2015
This article describes the class iHRIS_Module_Application .
- Extends the class: I2CE_Module.
- Location: Part of the module ihris-manage-Application in the package iHRIS Manage 4.1-dev
- Source: Defined in the file modules/ManageApplication/lib/iHRIS_Module_Application.php on line 32
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: v3.2.2
@filesource Class iHRIS_Module_Application
Variables
$do_migrate
A flag to determine if migrate needs to be called during the upgrade method.
- Defined in manage/modules/ManageApplication/lib/iHRIS_Module_Application.php on line 62
- 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/ManageApplication/lib/iHRIS_Module_Application.php on line 66
- Type: protected boolean $do_migrate326
Methods
action_application()
- Defined in manage/modules/ManageApplication/lib/iHRIS_Module_Application.php on line 246
- Signature: public function action_application($page)
- Parameters:
- $page
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/ManageApplication/lib/iHRIS_Module_Application.php on line 141
- Signature: public function action_initialize()
action_position_decision()
- Defined in manage/modules/ManageApplication/lib/iHRIS_Module_Application.php on line 238
- Signature: public function action_position_decision($page)
- Parameters:
- $page
action_position_interview()
- Defined in manage/modules/ManageApplication/lib/iHRIS_Module_Application.php on line 230
- Signature: public function action_position_interview($page)
- Parameters:
- $page
getHooks()
Return the array of hooks available in this module.
- Defined in manage/modules/ManageApplication/lib/iHRIS_Module_Application.php on line 39
- Signature: static public function getHooks()
- Returns: array
getMethods()
- Defined in manage/modules/ManageApplication/lib/iHRIS_Module_Application.php on line 218
- 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.
- Defined in manage/modules/ManageApplication/lib/iHRIS_Module_Application.php on line 103
- Signature: protected function migrate()
- Returns: boolean
migrate326()
Perform the migrate actions for this module from 3.2.4 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/ManageApplication/lib/iHRIS_Module_Application.php on line 122
- Signature: protected function migrate326()
- Returns: boolean
post_update()
Upgrade this module if necessary
- Defined in manage/modules/ManageApplication/lib/iHRIS_Module_Application.php on line 200
- 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/ManageApplication/lib/iHRIS_Module_Application.php on line 75
- Signature: protected function pre_migrate()
- Returns: boolean
pre_migrate326()
Perform any pre migrate actions for this module from 3.2.4 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/ManageApplication/lib/iHRIS_Module_Application.php on line 88
- 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/ManageApplication/lib/iHRIS_Module_Application.php on line 172
- Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage)
- Parameters:
- string $old_vers
- string $new_vers
- I2CE_MagicDataNode $new_storage
- Returns: boolean
validate_form_application()
Checks to make sure all the required fields are valid for the application.
- Defined in manage/modules/ManageApplication/lib/iHRIS_Module_Application.php on line 49
- Signature: public function validate_form_application($form)
- Parameters:
- I2CE_Form $form
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()
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()