Class: iHRIS PersonPosition: Difference between revisions

From IHRIS Wiki
No edit summary
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article describes the class ''iHRIS_PersonPosition''.
#REDIRECT [[Class: iHRIS_PersonPosition (4.1.7)]]
*Extends the class: [[Class: I2CE_Form | I2CE_Form]].
*Location: Part of the module [[iHRIS 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_PersonPosition.php modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php]
*Author: Luke Duncan <lduncan@intrahealth.org>
*Since: v1.0.0
@copyright Copyright &copy; 2007, 2008 IntraHealth International, Inc.    Object for dealing with positions assigned to people.
==Form Fields==
This class is a [[Class: I2CE_Form |form class]] and provides the following [[Class: I2CE_FormField |form fields]]
==position==
The form field ''position'' is implemented by [[Class: I2CE_FormField_MAP |MAP ]]
==start_date==
The form field ''start_date'' is implemented by [[Class: I2CE_FormField_DATE_YMD |DATE_YMD ]]
==end_date==
The form field ''end_date'' is implemented by [[Class: I2CE_FormField_DATE_YMD |DATE_YMD ]]
==reason==
The form field ''reason'' is implemented by [[Class: I2CE_FormField_MAP |MAP ]]
==Constants==
===iHRIS_PersonPosition::STATUS_EMPLOYED===
Constant value for employed
Defined as: 1
===iHRIS_PersonPosition::STATUS_NOT_EMPLOYED===
Constant value for not employed
Defined as: 2
==Variables==
===$stati===
Employment Status
*Type: static public [http://www.php.net/manual/en/language.types.array.php array ] $stati
 
==Methods==
===__construct()===
Create a new instance of a person position.
*Signature: public function __construct($form,$id)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The name of this form
** integer $id
***Default Value: 0
===getIds()===
Return the record id and the parent id for the person position record for the given position. @param $position of the form "postion|$id"
*Signature: static public function getIds($position)
*Parameters:
**$position
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===getLastSalary()===
*Signature: public function getLastSalary()
===getSalaryGradeID()===
*Signature: public function getSalaryGradeID()
===listStatusOptions()===
List all the options from the gender array.
*Signature: static public function listStatusOptions($form)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The  form we wish to lookup by
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===lookupStatus()===
Lookup the given value from the gender array.
*Signature: static public function lookupStatus($id,$form)
*Parameters:
** integer $id
** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>Not used for this method.
***Default Value: ""
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===validate()===
Checks to make sure all the required fields are valid.
*Signature: public function validate($page)
*Parameters:
** [[Class: I2CE_Template | I2CE_Template]] &$page
==Fuzzy Methods==
===isActive()===
This method is implemented by [[Class: iHRIS_Module_PersonPosition#isActive_PersonPosution() | iHRIS_Module_PersonPosition->isActive_PersonPosution() ]]
 
 
[[Category:Class Documentation]]

Latest revision as of 09:07, 23 August 2013