Class: iHRIS Module PersonID (Development)

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

This article describes the class iHRIS_Module_PersonID .

• Extends the class: I2CE_Module.
• Location: Part of the module PersonID in the package iHRIS Common 4.1-dev
• Source: Defined in the file modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v3.2

@filesource Class iHRIS_Module_PersonID

Variables

$do_migrate

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

• Defined in common/modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php on line 38
• Type: protected boolean $do_migrate

Methods

action_initialize()

Method called before the module is enabled for the first time.

• Defined in common/modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php on line 78
• Signature: public function action_initialize()
• Returns: boolean

action_person_id()

• Defined in common/modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php on line 154
• Signature: public function action_person_id($obj)
• Parameters:
  • $obj

getHooks()

Return the array of hooks available in this module.

• Defined in common/modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php on line 147
• Signature: static public function getHooks()
• Returns: array

getMethods()

• Defined in common/modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php on line 137
• Signature: static public function getMethods()

migrate()

Perform the migrate actions for this module.

• Defined in common/modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php on line 57
• Signature: protected function migrate()
• Returns: boolean;

post_update()

Upgrade this module if necessary

• Defined in common/modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php on line 122
• Signature: public function post_update($old_vers,$new_vers)
• Parameters:
  • string $old_vers
  • string $new_vers
• Returns: boolean

pre_migrate()

Run the pre migrate for this module. This can use the old config data before it has been changed from the config.

• Defined in common/modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php on line 45
• 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.

• Defined in common/modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php on line 107
• 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_person_id()

Perform extra validation for the person_id form. Make sure the date of issue is before the date of expiration.

• Defined in common/modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php on line 167
• Signature: public function validate_form_person_id($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()