Class: iHRIS Module PersonID

From IHRIS Wiki
Revision as of 21:19, 16 October 2009 by Litlfred (talk | contribs)

This article desrcibes the class iHRIS_Module_PersonID which extends the class I2CE_Module It is contained in the module PersonID in the package iHRIS Common

The class is defined in the file: modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php

@author Carl Leitner <litlfred@ibiblio.org>

@version v3.2

@since v3.2

@filesource

Class iHRIS_Module_PersonID


@access public

Variables

$do_migrate

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

  • Type: protected n $do_migrate

Methods

action_initialize()

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

  • Signature: public function action_initialize()
  • Returns: boolean

action_person_id()

  • Signature: public function action_person_id($obj)

Parameters:

  • $obj

getMethods()

  • Signature: static public function getMethods()

migrate()

Perform the migrate actions for this module.

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

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

  • 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:

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