Class: iHRIS Module PersonPosition: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 17: | Line 17: | ||
==Methods== | ==Methods== | ||
===action_initialize()=== | ===action_initialize()=== | ||
Method called before the module is enabled for the first time. | Method called before the module is enabled for the first time. @param boolean -- returns true on success. false on error. | ||
@param boolean -- returns true on success. false on error. | |||
*Signature: public function action_initialize() | *Signature: public function action_initialize() | ||
===action_person_position()=== | ===action_person_position()=== | ||
*Signature: public function action_person_position($page) | *Signature: public function action_person_position($page) | ||
Parameters: | *Parameters: | ||
*$page | *$page | ||
===getLastPosition()=== | ===getLastPosition()=== | ||
Find and return the most recent position held by this person. | Find and return the most recent position held by this person. | ||
*Signature: public function getLastPosition($person) | *Signature: public function getLastPosition($person) | ||
* | *Parameters: | ||
Parameters: | |||
*$person | *$person | ||
*Returns: [[Class: I2CE_Form | I2CE_Form]]<br/>or null | |||
===getMethods()=== | ===getMethods()=== | ||
*Signature: static public function getMethods() | *Signature: static public function getMethods() | ||
===isActive_Person()=== | ===isActive_Person()=== | ||
Checks to see if the most recent position for this person is still active and doesn't have an end date | 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() | ||
for his/her position. | |||
@see getLastPosition() | |||
*Signature: public function isActive_Person($person) | *Signature: public function isActive_Person($person) | ||
*Parameters: | |||
*$person | |||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===isActive_PersonPosition()=== | ===isActive_PersonPosition()=== | ||
Checks to see if the most recent position for this person is still active and doesn't have an end date | 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() | ||
for his/her position. | |||
@see getLastPosition() | |||
*Signature: public function isActive_PersonPosition($pers_pos) | *Signature: public function isActive_PersonPosition($pers_pos) | ||
*Parameters: | |||
*$pers_pos | |||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===migrate()=== | ===migrate()=== | ||
Perform the migrate actions for this module | 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. | ||
This is for going from pre 3.2 versions where benefit data has | |||
been saved to the database. | |||
*Signature: protected function migrate() | *Signature: protected function migrate() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===migrate3212()=== | ===migrate3212()=== | ||
Perform the migrate actions for this module from 3.2.10 to 3.2.12 | 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. | ||
This is for going from pre 3.2 versions where benefit data has | |||
been saved to the database. | |||
*Signature: protected function migrate3212() | *Signature: protected function migrate3212() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
| Line 63: | Line 54: | ||
Upgrade this module if necessary | Upgrade this module if necessary | ||
*Signature: public function post_update($old_vers,$new_vers) | *Signature: public function post_update($old_vers,$new_vers) | ||
*Parameters: | |||
** [http://www.php.net/manual/en/language.types.string.php string ] $old_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 ] | ||
===pre_migrate()=== | ===pre_migrate()=== | ||
Perform any pre migrate actions for this module. | 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. | ||
This is for going from pre 3.2 versions where benefit data has | |||
been saved to the database. | |||
*Signature: protected function pre_migrate() | *Signature: protected function pre_migrate() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===pre_migrate3212()=== | ===pre_migrate3212()=== | ||
Perform any pre migrate actions for this module from 3.2.10 to 3.2.12 | 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. | ||
This is for going from pre 3.2 versions where benefit data has | |||
been saved to the database. | |||
*Signature: protected function pre_migrate3212() | *Signature: protected function pre_migrate3212() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===pre_upgrade()=== | ===pre_upgrade()=== | ||
Run the pre upgrade for this module. This can use the old config data before it | Run the pre upgrade for this module. This can use the old config data before it has been changed from the config. | ||
has been changed from the config. | |||
*Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage) | *Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage) | ||
*Parameters: | |||
** [http://www.php.net/manual/en/language.types.string.php string ] $old_vers | |||
** [http://www.php.net/manual/en/language.types.string.php string ] $new_vers | |||
** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $new_storage | |||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===upgrade()=== | ===upgrade()=== | ||
Run the upgrade function for this module. | Run the upgrade function for this module. | ||
*Signature: public function upgrade($old_vers,$new_vers) | *Signature: public function upgrade($old_vers,$new_vers) | ||
*Parameters: | |||
** [http://www.php.net/manual/en/language.types.string.php string ] $old_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 Fuzzy Methods== | ==Inherited Fuzzy Methods== | ||
===launchBackgroundProcess()=== | ===launchBackgroundProcess()=== | ||
Revision as of 22:42, 16 October 2009
This article desrcibes the class iHRIS_Module_PersonPosition.
- Extends the class: I2CE_Module.
- Location: Part of the module ihris-manage-PersonPosition in the package iHRIS Manage
- Source: Defined in the file modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: v3.2.6
@filesource Class iHRIS_Module_PersonPosition
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)
- 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.
- Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage)
- Parameters:
- string $old_vers
- string $new_vers
- I2CE_MagicDataNode $new_storage
- Returns: boolean
upgrade()
Run the upgrade function for this module.
- Signature: public function upgrade($old_vers,$new_vers)
- Parameters:
- Returns: boolean
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()
