Class: iHRIS Module PersonPosition: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 2: Line 2:
*Extends the class: [[Class: I2CE_Module | I2CE_Module]].
*Extends the class: [[Class: I2CE_Module | I2CE_Module]].
*Parent Classses:  [[Class: I2CE_Module | I2CE_Module]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
*Parent Classses:  [[Class: I2CE_Module | I2CE_Module]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
*Location: Part of the module [[iHRIS Module List#ihris-manage-PersonPosition|ihris-manage-PersonPosition]] in the package [https://launchpad.net/ihris-manage iHRIS Manage]
*Location: Part of the module [[iHRIS Manage Module List#ihris-manage-PersonPosition|ihris-manage-PersonPosition]] in the package [https://launchpad.net/ihris-manage iHRIS Manage]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.0-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.0-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php]
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
Line 82: Line 82:
** [http://www.php.net/manual/en/language.types.string.php string ] $new_vers
** [http://www.php.net/manual/en/language.types.string.php string ] $new_vers
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
==Inherited Methods==
===__construct()===
This public method is inherited from [[Class: I2CE_Module#__construct() | I2CE_Module->__construct()]]
===action_configure()===
This public method is inherited from [[Class: I2CE_Module#action_configure() | I2CE_Module->action_configure()]]
===action_disable()===
This public method is inherited from [[Class: I2CE_Module#action_disable() | I2CE_Module->action_disable()]]
===action_enable()===
This public method is inherited from [[Class: I2CE_Module#action_enable() | I2CE_Module->action_enable()]]
===conflict_external()===
This public method is inherited from [[Class: I2CE_Module#conflict_external() | I2CE_Module->conflict_external()]]
===getCLIHooks()===
This public method is inherited from [[Class: I2CE_Module#getCLIHooks() | I2CE_Module->getCLIHooks()]]
===getCLIMethods()===
This public method is inherited from [[Class: I2CE_Module#getCLIMethods() | I2CE_Module->getCLIMethods()]]
===getConfig()===
This public method is inherited from [[Class: I2CE_Module#getConfig() | I2CE_Module->getConfig()]]
===getHooks()===
This public method is inherited from [[Class: I2CE_Module#getHooks() | I2CE_Module->getHooks()]]
===requirement_external()===
This public method is inherited from [[Class: I2CE_Module#requirement_external() | I2CE_Module->requirement_external()]]
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Fuzzy Methods==
===launchBackgroundProcess()===
This method is inherited from [[Class: I2CE_Module#launchBackgroundProcess() | I2CE_Module->launchBackgroundProcess()]]
===launchBackgroundPHPScript()===
This method is inherited from [[Class: I2CE_Module#launchBackgroundPHPScript() | I2CE_Module->launchBackgroundPHPScript()]]
===launchBackgroundPage()===
This method is inherited from [[Class: I2CE_Module#launchBackgroundPage() | I2CE_Module->launchBackgroundPage()]]
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]




[[Category:Class Documentation]]
[[Category:Class Documentation]]

Revision as of 12:12, 19 October 2009

This article describes the class iHRIS_Module_PersonPosition.

@filesource Class iHRIS_Module_PersonPosition

Variables

$do_migrate

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

$do_migrate3212

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

Methods

action_initialize()

Method called before the module is enabled for the first time. @param boolean -- returns true on success. false on error.

  • Signature: public function action_initialize()

action_person_position()

  • Signature: public function action_person_position($page)
  • Parameters:
    • $page

getLastPosition()

Find and return the most recent position held by this person.

  • Signature: public function getLastPosition($person)
  • Parameters:
    • $person
  • Returns: I2CE_Form
    or null

getMethods()

  • Signature: static public function getMethods()

isActive_Person()

Checks to see if the most recent position for this person is still active and doesn't have an end date for his/her position. @see getLastPosition()

  • Signature: public function isActive_Person($person)
  • Parameters:
    • $person
  • Returns: boolean

isActive_PersonPosition()

Checks to see if the most recent position for this person is still active and doesn't have an end date for his/her position. @see getLastPosition()

  • Signature: public function isActive_PersonPosition($pers_pos)
  • Parameters:
    • $pers_pos
  • Returns: boolean

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.

  • Signature: protected function migrate()
  • Returns: boolean

migrate3212()

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

  • Signature: protected function migrate3212()
  • Returns: boolean

post_update()

Upgrade this module if necessary

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

  • Signature: protected function pre_migrate()
  • Returns: boolean

pre_migrate3212()

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

  • Signature: protected function pre_migrate3212()
  • 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.

upgrade()

Run the upgrade function for this module.

  • Signature: public function upgrade($old_vers,$new_vers)
  • Parameters:
  • Returns: boolean