Class: iHRIS PersonPosition: Difference between revisions
No edit summary |
No edit summary |
||
Line 2: | Line 2: | ||
*Extends the class: [[Class: I2CE_Form | I2CE_Form]]. | *Extends the class: [[Class: I2CE_Form | I2CE_Form]]. | ||
*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] | *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. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L35 modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 35 | ||
*Author: Luke Duncan <lduncan@intrahealth.org> | *Author: Luke Duncan <lduncan@intrahealth.org> | ||
*Since: v1.0.0 | *Since: v1.0.0 | ||
Line 26: | Line 26: | ||
===$stati=== | ===$stati=== | ||
Employment Status | Employment Status | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L150 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 150 | |||
*Type: static public [http://www.php.net/manual/en/language.types.array.php array ] $stati | *Type: static public [http://www.php.net/manual/en/language.types.array.php array ] $stati | ||
Line 31: | Line 32: | ||
===__construct()=== | ===__construct()=== | ||
Create a new instance of a person position. | Create a new instance of a person position. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L43 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 43 | |||
*Signature: public function __construct($form,$id) | *Signature: public function __construct($form,$id) | ||
*Parameters: | *Parameters: | ||
Line 38: | Line 40: | ||
===getIds()=== | ===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" | Return the record id and the parent id for the person position record for the given position. @param $position of the form "postion|$id" | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L89 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 89 | |||
*Signature: static public function getIds($position) | *Signature: static public function getIds($position) | ||
*Parameters: | *Parameters: | ||
Line 43: | Line 46: | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ] | *Returns: [http://www.php.net/manual/en/language.types.array.php array ] | ||
===getLastSalary()=== | ===getLastSalary()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L63 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 63 | |||
*Signature: public function getLastSalary() | *Signature: public function getLastSalary() | ||
===getSalaryGradeID()=== | ===getSalaryGradeID()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L126 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 126 | |||
*Signature: public function getSalaryGradeID() | *Signature: public function getSalaryGradeID() | ||
===listStatusOptions()=== | ===listStatusOptions()=== | ||
List all the options from the gender array. | List all the options from the gender array. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L167 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 167 | |||
*Signature: static public function listStatusOptions($form) | *Signature: static public function listStatusOptions($form) | ||
*Parameters: | *Parameters: | ||
Line 54: | Line 60: | ||
===lookupStatus()=== | ===lookupStatus()=== | ||
Lookup the given value from the gender array. | Lookup the given value from the gender array. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L159 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 159 | |||
*Signature: static public function lookupStatus($id,$form) | *Signature: static public function lookupStatus($id,$form) | ||
*Parameters: | *Parameters: | ||
Line 62: | Line 69: | ||
===validate()=== | ===validate()=== | ||
Checks to make sure all the required fields are valid. | Checks to make sure all the required fields are valid. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L54 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 54 | |||
*Signature: public function validate($page) | *Signature: public function validate($page) | ||
*Parameters: | *Parameters: |
Revision as of 09:21, 10 November 2009
This article describes the class iHRIS_PersonPosition.
- Extends the class: I2CE_Form.
- Location: Part of the module ihris-manage-PersonPosition in the package iHRIS Manage
- Source: Defined in the file modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php on line 35
- Author: Luke Duncan <lduncan@intrahealth.org>
- Since: v1.0.0
@copyright Copyright © 2007, 2008 IntraHealth International, Inc. Object for dealing with positions assigned to people.
Form Fields
This class is a form class and provides the following form fields
position
The form field position is implemented by MAP
start_date
The form field start_date is implemented by DATE_YMD
end_date
The form field end_date is implemented by DATE_YMD
reason
The form field reason is implemented by 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
- Defined in manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php on line 150
- Type: static public array $stati
Methods
__construct()
Create a new instance of a person position.
- Defined in manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php on line 43
- Signature: public function __construct($form,$id)
- Parameters:
- string $form
The name of this form - integer $id
- Default Value: 0
- string $form
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"
- Defined in manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php on line 89
- Signature: static public function getIds($position)
- Parameters:
- $position
- Returns: array
getLastSalary()
- Defined in manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php on line 63
- Signature: public function getLastSalary()
getSalaryGradeID()
- Defined in manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php on line 126
- Signature: public function getSalaryGradeID()
listStatusOptions()
List all the options from the gender array.
- Defined in manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php on line 167
- Signature: static public function listStatusOptions($form)
- Parameters:
- string $form
The form we wish to lookup by
- string $form
- Returns: array
lookupStatus()
Lookup the given value from the gender array.
- Defined in manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php on line 159
- Signature: static public function lookupStatus($id,$form)
- Parameters:
- integer $id
- string $form
Not used for this method.- Default Value: ""
- Returns: string
validate()
Checks to make sure all the required fields are valid.
- Defined in manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php on line 54
- Signature: public function validate($page)
- Parameters:
- I2CE_Template &$page
Inherited Methods
addChildForm()
This public method is inherited from I2CE_Form->addChildForm()
addField()
This public method is inherited from I2CE_Form->addField()
cleanup()
This public method is inherited from I2CE_Form->cleanup()
clearFields()
This public method is inherited from I2CE_Form->clearFields()
current()
This public method is inherited from I2CE_Form->current()
displayField()
This public method is inherited from I2CE_Form->displayField()
form()
This public method is inherited from I2CE_Form->form()
getAllowedParentForms()
This public method is inherited from I2CE_Form->getAllowedParentForms()
getAttribute()
This public method is inherited from I2CE_Form->getAttribute()
getChildForms()
This public method is inherited from I2CE_Form->getChildForms()
getChildFormsByForm()
This public method is inherited from I2CE_Form->getChildFormsByForm()
getChildren()
This public method is inherited from I2CE_Form->getChildren()
getDisplayName()
This public method is inherited from I2CE_Form->getDisplayName()
getField()
This public method is inherited from I2CE_Form->getField()
getFieldNames()
This public method is inherited from I2CE_Form->getFieldNames()
getFormId()
This public method is inherited from I2CE_Form->getFormId()
getHTMLName()
This public method is inherited from I2CE_Form->getHTMLName()
getId()
This public method is inherited from I2CE_Form->getId()
getParent()
This public method is inherited from I2CE_Form->getParent()
getParentForm()
This public method is inherited from I2CE_Form->getParentForm()
getParentID()
This public method is inherited from I2CE_Form->getParentID()
getQueryDisplay()
This public method is inherited from I2CE_Form->getQueryDisplay()
getQueryFields()
This public method is inherited from I2CE_Form->getQueryFields()
getQueryString()
This public method is inherited from I2CE_Form->getQueryString()
hasAttribute()
This public method is inherited from I2CE_Form->hasAttribute()
hasInvalid()
This public method is inherited from I2CE_Form->hasInvalid()
key()
This public method is inherited from I2CE_Form->key()
listFields()
This public method is inherited from I2CE_Form->listFields()
load()
This public method is inherited from I2CE_Form->load()
next()
This public method is inherited from I2CE_Form->next()
processDOM()
This public method is inherited from I2CE_Form->processDOM()
removeField()
This public method is inherited from I2CE_Form->removeField()
reset()
This public method is inherited from I2CE_Form->reset()
rewind()
This public method is inherited from I2CE_Form->rewind()
search()
This public method is inherited from I2CE_Form->search()
setAttribute()
This public method is inherited from I2CE_Form->setAttribute()
setDisplayName()
This public method is inherited from I2CE_Form->setDisplayName()
setForm()
This public method is inherited from I2CE_Form->setForm()
setFromPost()
This public method is inherited from I2CE_Form->setFromPost()
setId()
This public method is inherited from I2CE_Form->setId()
setParent()
This public method is inherited from I2CE_Form->setParent()
valid()
This public method is inherited from I2CE_Form->valid()
__get()
This protected method is inherited from I2CE_Form->__get()
__isset()
This protected method is inherited from I2CE_Form->__isset()
__set()
This protected method is inherited from I2CE_Form->__set()
__unset()
This protected method is inherited from I2CE_Form->__unset()
addFormFields()
This protected method is inherited from I2CE_Form->addFormFields()
getFormFieldsData()
This protected method is inherited from I2CE_Form->getFormFieldsData()
lookupArray()
This protected method is inherited from I2CE_Form->lookupArray()
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
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()