Class: iHRIS Module PersonPosition

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

This article desrcibes the class iHRIS_Module_PersonPosition which extends the class I2CE_Module It is contained in the module ihris-manage-PersonPosition in the package iHRIS Manage

The class is defined in the file: modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php

@subpackage Manage

@author Carl Leitner <litlfred@ibiblio.org>

@version v3.2.6

@since v3.2.6

@filesource

Class iHRIS_Module_PersonPosition


@access public

Variables

$do_migrate

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

  • Type: protected n $do_migrate

$do_migrate3212

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

  • Type: protected n $do_migrate3212

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)
  • Returns: I2CE_Form or null

Parameters:

  • $person

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)
  • Returns: boolean

Parameters:

  • $person

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)
  • Returns: boolean

Parameters:

  • $pers_pos

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)
  • Returns: boolean

Parameters:

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.

  • Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage)
  • Returns: boolean

Parameters:

upgrade()

Run the upgrade function for this module.

  • Signature: public function upgrade($old_vers,$new_vers)
  • 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()