Class: iHRIS PersonPosition: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
This article desrcibes the class '''iHRIS_PersonPosition''' | This article desrcibes the class '''iHRIS_PersonPosition'''. | ||
*Extends the class: [[Class: I2CE_Form | I2CE_Form]]. | |||
It is contained in the module [[iHRIS Module List#ihris-manage-PersonPosition|ihris-manage-PersonPosition]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] | It is contained in the module [[iHRIS Module List#ihris-manage-PersonPosition|ihris-manage-PersonPosition]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] | ||
| Line 27: | Line 28: | ||
*Signature: public function __construct($form,$id) | *Signature: public function __construct($form,$id) | ||
Parameters: | Parameters: | ||
* [http://www.php.net/manual/en/language.types.string.php string] $form<br/>The name of this form | * [http://www.php.net/manual/en/language.types.string.php string ] $form<br/>The name of this form | ||
* integer $id | * integer $id | ||
**Default Value: 0 | **Default Value: 0 | ||
| Line 35: | Line 36: | ||
@param $position of the form "postion|$id" | @param $position of the form "postion|$id" | ||
*Signature: static public function getIds($position) | *Signature: static public function getIds($position) | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array] | *Returns: [http://www.php.net/manual/en/language.types.array.php array ] | ||
Parameters: | Parameters: | ||
*$position | *$position | ||
| Line 45: | Line 46: | ||
List all the options from the gender array. | List all the options from the gender array. | ||
*Signature: static public function listStatusOptions($form) | *Signature: static public function listStatusOptions($form) | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array] | *Returns: [http://www.php.net/manual/en/language.types.array.php array ] | ||
Parameters: | Parameters: | ||
* [http://www.php.net/manual/en/language.types.string.php string] $form<br/>The form we wish to lookup by | * [http://www.php.net/manual/en/language.types.string.php string ] $form<br/>The form we wish to lookup by | ||
===lookupStatus()=== | ===lookupStatus()=== | ||
Lookup the given value from the gender array. | Lookup the given value from the gender array. | ||
*Signature: static public function lookupStatus($id,$form) | *Signature: static public function lookupStatus($id,$form) | ||
*Returns: [http://www.php.net/manual/en/language.types.string.php string] | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] | ||
Parameters: | Parameters: | ||
* integer $id | * integer $id | ||
* [http://www.php.net/manual/en/language.types.string.php string] $form<br/>Not used for this method. | * [http://www.php.net/manual/en/language.types.string.php string ] $form<br/>Not used for this method. | ||
**Default Value: "" | **Default Value: "" | ||
===validate()=== | ===validate()=== | ||
Revision as of 21:27, 16 October 2009
This article desrcibes the class iHRIS_PersonPosition.
- Extends the class: I2CE_Form.
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_PersonPosition.php
@subpackage Manage @copyright Copyright © 2007, 2008 IntraHealth International, Inc. Object for dealing with positions assigned to people. @subpackage Manage
- Author: Luke Duncan <lduncan@intrahealth.org>
- Since: v1.0.0
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 y $stati
Methods
__construct()
Create a new instance of a person position.
- Signature: public function __construct($form,$id)
Parameters:
- string $form
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)
- Returns: array
Parameters:
- $position
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)
- Returns: array
Parameters:
- string $form
The form we wish to lookup by
lookupStatus()
Lookup the given value from the gender array.
- Signature: static public function lookupStatus($id,$form)
- Returns: string
Parameters:
- integer $id
- string $form
Not used for this method.- Default Value: ""
validate()
Checks to make sure all the required fields are valid.
- Signature: public function validate($page)
Parameters:
- I2CE_Template &$page
Inherited Variables
$children
Theis public variable is inherited from I2CE_Form->$children
$fields
Theis protected variable is inherited from I2CE_Form->$fields
$parent
Theis protected variable is inherited from I2CE_Form->$parent
$id
Theis protected variable is inherited from I2CE_Form->$id
$attributes
Theis protected variable is inherited from I2CE_Form->$attributes
$parent_forms
Theis protected variable is inherited from I2CE_Form->$parent_forms
Inherited Fuzzy Methods
isNumeric()
This method is inherited from I2CE_Form->isNumeric()
getLimitStyles()
This method is inherited from I2CE_Form->getLimitStyles()
checkLimit()
This method is inherited from I2CE_Form->checkLimit()
checkWhereClause()
This method is inherited from I2CE_Form->checkWhereClause()
createCheckFunction()
This method is inherited from I2CE_Form->createCheckFunction()
createCheckLimitString()
This method is inherited from I2CE_Form->createCheckLimitString()
generateLimit()
This method is inherited from I2CE_Form->generateLimit()
generateWhereClause()
This method is inherited from I2CE_Form->generateWhereClause()
processLimit()
This method is inherited from I2CE_Form->processLimit()
getDisplayedExistingLimit()
This method is inherited from I2CE_Form->getDisplayedExistingLimit()
isComponentized()
This method is inherited from I2CE_Form->isComponentized()
addChild()
This method is inherited from I2CE_Form->addChild()
getChildIds()
This method is inherited from I2CE_Form->getChildIds()
getStorage()
This method is inherited from I2CE_Form->getStorage()
isWritable()
This method is inherited from I2CE_Form->isWritable()
populate()
This method is inherited from I2CE_Form->populate()
populateChild()
This method is inherited from I2CE_Form->populateChild()
populateChildren()
This method is inherited from I2CE_Form->populateChildren()
populateFirst()
This method is inherited from I2CE_Form->populateFirst()
populateHistory()
This method is inherited from I2CE_Form->populateHistory()
populateLast()
This method is inherited from I2CE_Form->populateLast()
delete()
This method is inherited from I2CE_Form->delete()
save()
This method is inherited from I2CE_Form->save()
setChangeType()
This method is inherited from I2CE_Form->setChangeType()
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
Fuzzy Methods
isActive()
This method is implemented by iHRIS_Module_PersonPosition->isActive_PersonPosution()
