Class: iHRIS PersonPosition: Difference between revisions

From IHRIS Wiki
No edit summary
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article desrcibes 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.
==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
==Inherited Variables==
===$children===
Theis public variable is inherited from [[Class: I2CE_Form#$children | I2CE_Form->$children]]
 
===$fields===
Theis protected variable is inherited from [[Class: I2CE_Form#$fields | I2CE_Form->$fields]]
 
===$parent===
Theis protected variable is inherited from [[Class: I2CE_Form#$parent | I2CE_Form->$parent]]
 
===$id===
Theis protected variable is inherited from [[Class: I2CE_Form#$id | I2CE_Form->$id]]
 
===$attributes===
Theis protected variable is inherited from [[Class: I2CE_Form#$attributes | I2CE_Form->$attributes]]
 
===$parent_forms===
Theis protected variable is inherited from [[Class: I2CE_Form#$parent_forms | I2CE_Form->$parent_forms]]
==Inherited Fuzzy Methods==
===isNumeric()===
This method is inherited from [[Class: I2CE_Form#isNumeric() | I2CE_Form->isNumeric()]]
 
===getLimitStyles()===
This method is inherited from [[Class: I2CE_Form#getLimitStyles() | I2CE_Form->getLimitStyles()]]
 
===checkLimit()===
This method is inherited from [[Class: I2CE_Form#checkLimit() | I2CE_Form->checkLimit()]]
 
===checkWhereClause()===
This method is inherited from [[Class: I2CE_Form#checkWhereClause() | I2CE_Form->checkWhereClause()]]
 
===createCheckFunction()===
This method is inherited from [[Class: I2CE_Form#createCheckFunction() | I2CE_Form->createCheckFunction()]]
 
===createCheckLimitString()===
This method is inherited from [[Class: I2CE_Form#createCheckLimitString() | I2CE_Form->createCheckLimitString()]]
 
===generateLimit()===
This method is inherited from [[Class: I2CE_Form#generateLimit() | I2CE_Form->generateLimit()]]
 
===generateWhereClause()===
This method is inherited from [[Class: I2CE_Form#generateWhereClause() | I2CE_Form->generateWhereClause()]]
 
===processLimit()===
This method is inherited from [[Class: I2CE_Form#processLimit() | I2CE_Form->processLimit()]]
 
===getDisplayedExistingLimit()===
This method is inherited from [[Class: I2CE_Form#getDisplayedExistingLimit() | I2CE_Form->getDisplayedExistingLimit()]]
 
===isComponentized()===
This method is inherited from [[Class: I2CE_Form#isComponentized() | I2CE_Form->isComponentized()]]
 
===addChild()===
This method is inherited from [[Class: I2CE_Form#addChild() | I2CE_Form->addChild()]]
 
===getChildIds()===
This method is inherited from [[Class: I2CE_Form#getChildIds() | I2CE_Form->getChildIds()]]
 
===getStorage()===
This method is inherited from [[Class: I2CE_Form#getStorage() | I2CE_Form->getStorage()]]
 
===isWritable()===
This method is inherited from [[Class: I2CE_Form#isWritable() | I2CE_Form->isWritable()]]
 
===populate()===
This method is inherited from [[Class: I2CE_Form#populate() | I2CE_Form->populate()]]
 
===populateChild()===
This method is inherited from [[Class: I2CE_Form#populateChild() | I2CE_Form->populateChild()]]
 
===populateChildren()===
This method is inherited from [[Class: I2CE_Form#populateChildren() | I2CE_Form->populateChildren()]]
 
===populateFirst()===
This method is inherited from [[Class: I2CE_Form#populateFirst() | I2CE_Form->populateFirst()]]
 
===populateHistory()===
This method is inherited from [[Class: I2CE_Form#populateHistory() | I2CE_Form->populateHistory()]]
 
===populateLast()===
This method is inherited from [[Class: I2CE_Form#populateLast() | I2CE_Form->populateLast()]]
 
===delete()===
This method is inherited from [[Class: I2CE_Form#delete() | I2CE_Form->delete()]]
 
===save()===
This method is inherited from [[Class: I2CE_Form#save() | I2CE_Form->save()]]
 
===setChangeType()===
This method is inherited from [[Class: I2CE_Form#setChangeType() | I2CE_Form->setChangeType()]]
 
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
==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 10:07, 23 August 2013