Class: iHRIS Module Benefit (4.0.5)

For other versions, see Class: iHRIS_Module_Benefit (versions) .

This article describes the class iHRIS_Module_Benefit .

• Extends the class: I2CE_Module.
• Location: Part of the module ihris-manage-Benefit in the package iHRIS Manage 4.0.5-release
• Source: Defined in the file modules/Benefit/lib/iHRIS_Module_Benefit.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v3.2.6

@filesource Class iHRIS_Module_Benefit

Variables

$do_migrate

A flag to determine if migrate needs to be called during the upgrade method.

• Defined in manage/modules/Benefit/lib/iHRIS_Module_Benefit.php on line 39
• Type: protected boolean $do_migrate

$do_migrate329

A flag to determine if migrate329 needs to be called during the upgrade method.

• Defined in manage/modules/Benefit/lib/iHRIS_Module_Benefit.php on line 43
• Type: protected boolean $do_migrate329

Methods

action_benefit()

• Defined in manage/modules/Benefit/lib/iHRIS_Module_Benefit.php on line 227
• Signature: public function action_benefit($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/Benefit/lib/iHRIS_Module_Benefit.php on line 137
• Signature: public function action_initialize()

getMethods()

• Defined in manage/modules/Benefit/lib/iHRIS_Module_Benefit.php on line 219
• 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/Benefit/lib/iHRIS_Module_Benefit.php on line 80
• Signature: protected function migrate()
• Returns: boolean

migrate329()

Perform the migrate actions for this module from 3.2.8 to 3.2.9 This is for going from pre 3.2 versions where benefit data has been saved to the database.

• Defined in manage/modules/Benefit/lib/iHRIS_Module_Benefit.php on line 117
• Signature: protected function migrate329()
• Returns: boolean

post_update()

Upgrade this module if necessary

• Defined in manage/modules/Benefit/lib/iHRIS_Module_Benefit.php on line 198
• Signature: public function post_update($old_vers,$new_vers)
• Parameters:
  • string $old_vers
  • string $new_vers
• 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/Benefit/lib/iHRIS_Module_Benefit.php on line 51
• Signature: protected function pre_migrate()
• Returns: boolean

pre_migrate329()

Perform any pre migrate actions for this module to upgrade from 3.2.8 to 3.2.9. This is for going from pre 3.2 versions where benefit data has been saved to the database.

• Defined in manage/modules/Benefit/lib/iHRIS_Module_Benefit.php on line 65
• Signature: protected function pre_migrate329()
• 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/Benefit/lib/iHRIS_Module_Benefit.php on line 169
• 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()

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()

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()