Class: iHRIS PersonPosition (Development): Difference between revisions

Latest revision as of 08:31, 6 May 2015

For other versions, see Class: iHRIS_PersonPosition (versions) .

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 4.1-dev
Source: Defined in the file modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php on line 35
Author: Luke Duncan <lduncan@intrahealth.org>
Since: v1.0.0

Form Fields

This class is a form class and provides the following form fields

start_date

The form field start_date is implemented by DATE_YMD

end_date

The form field end_date is implemented by DATE_YMD

position

The form field position is implemented by MAP

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 93
Type: static public array $stati

Methods

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 43
Signature: static public function getIds($position)
Parameters:
- $position
Returns: array

listStatusOptions()

List all the options from the gender array.

Defined in manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php on line 110
Signature: static public function listStatusOptions($form)
Parameters:
- string $form
  The form we wish to lookup by
Returns: array

lookupStatus()

Lookup the given value from the gender array.

Defined in manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php on line 102
Signature: static public function lookupStatus($id,$form)
Parameters:
- integer $id
- string $form
  Not used for this method.
  - Default Value: ""
Returns: string

Inherited Methods

__construct()

This public method is inherited from I2CE_Form->__construct()

addChildForm()

This public method is inherited from I2CE_Form->addChildForm()

childFormAdded()

This public method is inherited from I2CE_Form->childFormAdded()

cleanup()

This public method is inherited from I2CE_Form->cleanup()

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()

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()

getFormID()

This public method is inherited from I2CE_Form->getFormID()

getHistory()

This public method is inherited from I2CE_Form->getHistory()

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()

getPost()

This public method is inherited from I2CE_Form->getPost()

listFields()

This public method is inherited from I2CE_Form->listFields()

parentIsSet()

This public method is inherited from I2CE_Form->parentIsSet()

processDOM()

This public method is inherited from I2CE_Form->processDOM()

reset()

This public method is inherited from I2CE_Form->reset()

search()

This public method is inherited from I2CE_Form->search()

setCreated()

This public method is inherited from I2CE_Form->setCreated()

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()

setLastModified()

This public method is inherited from I2CE_Form->setLastModified()

setParent()

This public method is inherited from I2CE_Form->setParent()

isValidFieldName()

This protected method is inherited from I2CE_Form->isValidFieldName()

lookupArray()

This protected method is inherited from I2CE_Form->lookupArray()

preProcessFieldArgs()

This protected method is inherited from I2CE_Form->preProcessFieldArgs()

setupCreatedField()

This protected method is inherited from I2CE_Form->setupCreatedField()

setupLastModifiedField()

This protected method is inherited from I2CE_Form->setupLastModifiedField()

setupParentField()

This protected method is inherited from I2CE_Form->setupParentField()

__get()

This public method is inherited from I2CE_FieldContainer->__get()

__isset()

This public method is inherited from I2CE_FieldContainer->__isset()

__set()

This public method is inherited from I2CE_FieldContainer->__set()

__unset()

This public method is inherited from I2CE_FieldContainer->__unset()

addField()

This public method is inherited from I2CE_FieldContainer->addField()

clearFields()

This public method is inherited from I2CE_FieldContainer->clearFields()

current()

This public method is inherited from I2CE_FieldContainer->current()

getAttribute()

This public method is inherited from I2CE_FieldContainer->getAttribute()

getContainerIndex()

This public method is inherited from I2CE_FieldContainer->getContainerIndex()

getContainerType()

This public method is inherited from I2CE_FieldContainer->getContainerType()

getFieldNames()

This public method is inherited from I2CE_FieldContainer->getFieldNames()

getHTMLName()

This public method is inherited from I2CE_FieldContainer->getHTMLName()

getId()

This public method is inherited from I2CE_FieldContainer->getId()

getLoad()

This public method is inherited from I2CE_FieldContainer->getLoad()

getMeta()

This public method is inherited from I2CE_FieldContainer->getMeta()

getName()

This public method is inherited from I2CE_FieldContainer->getName()

getNameId()

This public method is inherited from I2CE_FieldContainer->getNameId()

hasAttribute()

This public method is inherited from I2CE_FieldContainer->hasAttribute()

hasField()

This public method is inherited from I2CE_FieldContainer->hasField()

hasInvalid()

This public method is inherited from I2CE_FieldContainer->hasInvalid()

hasMeta()

This public method is inherited from I2CE_FieldContainer->hasMeta()

isValid()

This public method is inherited from I2CE_FieldContainer->isValid()

key()

This public method is inherited from I2CE_FieldContainer->key()

load()

This public method is inherited from I2CE_FieldContainer->load()

next()

This public method is inherited from I2CE_FieldContainer->next()

removeField()

This public method is inherited from I2CE_FieldContainer->removeField()

rewind()

This public method is inherited from I2CE_FieldContainer->rewind()

setAttribute()

This public method is inherited from I2CE_FieldContainer->setAttribute()

setId()

This public method is inherited from I2CE_FieldContainer->setId()

setInvalidMessage()

This public method is inherited from I2CE_FieldContainer->setInvalidMessage()

setMeta()

This public method is inherited from I2CE_FieldContainer->setMeta()

setName()

This public method is inherited from I2CE_FieldContainer->setName()

valid()

This public method is inherited from I2CE_FieldContainer->valid()

validate()

This public method is inherited from I2CE_FieldContainer->validate()

addFields()

This protected method is inherited from I2CE_FieldContainer->addFields()

getAttributes()

This protected method is inherited from I2CE_FieldContainer->getAttributes()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Variables

$children

Theis public variable is inherited from I2CE_Form->$children

$parent_forms

Theis protected variable is inherited from I2CE_Form->$parent_forms

$parentField

Theis protected variable is inherited from I2CE_Form->$parentField

$lastModifiedField

Theis protected variable is inherited from I2CE_Form->$lastModifiedField

$createdField

Theis protected variable is inherited from I2CE_Form->$createdField

$name

Theis protected variable is inherited from I2CE_FieldContainer->$name

$display_name

Theis protected variable is inherited from I2CE_FieldContainer->$display_name

$fields

Theis protected variable is inherited from I2CE_FieldContainer->$fields

$attributes

Theis protected variable is inherited from I2CE_FieldContainer->$attributes

$id

Theis protected variable is inherited from I2CE_FieldContainer->$id

$factory

Theis protected variable is inherited from I2CE_FieldContainer->$factory

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()

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()

duplicate()

This method is inherited from I2CE_Form->duplicate()

storeHistory()

This method is inherited from I2CE_Form->storeHistory()

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()

changeID()

This method is inherited from I2CE_Form->changeID()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Fuzzy Methods

isActive()

This method is implemented by iHRIS_Module_PersonPosition->isActive_PersonPosition()

getLastSalary()

This method is implemented by iHRIS_Module_ManageSalary->getLastSalary()

getSalaryGradeID()

This method is implemented by iHRIS_Module_ManageSalary->getSalaryGradeID()

@@ Line 2: / Line 2: @@
 This article describes the class ''iHRIS_PersonPosition'' .
 *Extends the class: [[Class: I2CE_Form (Development) | I2CE_Form]].
-*Location: Part of the module [[iHRIS Manage Module List (Development)#ihris-manage-PersonPosition|ihris-manage-PersonPosition]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] 4.0-dev
+*Location: Part of the module [[iHRIS Manage Module List (Development)#ihris-manage-PersonPosition|ihris-manage-PersonPosition]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] 4.1-dev
-*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L35 modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 35
+*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L35 modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 35
 *Author: Luke Duncan <lduncan@intrahealth.org>
 *Since: v1.0.0
@@ Line 9: / Line 9: @@
 ==Form Fields==
 This class is a [[Class: I2CE_Form (Development) |form class]] and provides the following [[Class: I2CE_FormField (Development) |form fields]]
-===position===
-The form field ''position'' is implemented by [[Class: I2CE_FormField_MAP (Development) |MAP ]]
 ===start_date===
 The form field ''start_date'' is implemented by [[Class: I2CE_FormField_DATE_YMD (Development) |DATE_YMD ]]
 ===end_date===
 The form field ''end_date'' is implemented by [[Class: I2CE_FormField_DATE_YMD (Development) |DATE_YMD ]]
+===position===
+The form field ''position'' is implemented by [[Class: I2CE_FormField_MAP (Development) |MAP ]]
 ===reason===
 The form field ''reason'' is implemented by [[Class: I2CE_FormField_MAP (Development) |MAP ]]
@@ Line 27: / Line 27: @@
 ===$stati===
 Employment Status
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L136 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 136
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L93 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 93
 *Type: static public [http://www.php.net/manual/en/language.types.array.php array ] $stati
@@ Line 33: / Line 33: @@
 ===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 [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L75 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 75
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L43 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 43
 *Signature: static public function getIds($position)
 *Parameters:
 **$position
 *Returns: [http://www.php.net/manual/en/language.types.array.php array ]
-===getLastSalary()===
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L49 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 49
-*Signature: public function getLastSalary()
-===getSalaryGradeID()===
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L112 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 112
-*Signature: public function getSalaryGradeID()
 ===listStatusOptions()===
 List all the options from the gender array.
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L153 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 153
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L110 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 110
 *Signature: static public function listStatusOptions($form)
 *Parameters:
@@ Line 53: / Line 47: @@
 ===lookupStatus()===
 Lookup the given value from the gender array.
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L145 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 145
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L102 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 102
 *Signature: static public function lookupStatus($id,$form)
 *Parameters:
@@ Line 60: / Line 54: @@
 ***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.
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php#L40 manage/modules/ManagePersonPosition/lib/iHRIS_PersonPosition.php] on line 40
-*Signature: public function validate()
 ==Inherited Methods==
 ===__construct()===
@@ Line 70: / Line 60: @@
 ===addChildForm()===
 This public method is inherited from [[Class: I2CE_Form (Development)#addChildForm() | I2CE_Form->addChildForm()]]
+===childFormAdded()===
+This public method is inherited from [[Class: I2CE_Form (Development)#childFormAdded() | I2CE_Form->childFormAdded()]]
 ===cleanup()===
@@ Line 97: / Line 90: @@
 ===getField()===
 This public method is inherited from [[Class: I2CE_Form (Development)#getField() | I2CE_Form->getField()]]
+===getFormID()===
+This public method is inherited from [[Class: I2CE_Form (Development)#getFormID() | I2CE_Form->getFormID()]]
+===getHistory()===
+This public method is inherited from [[Class: I2CE_Form (Development)#getHistory() | I2CE_Form->getHistory()]]
 ===getParent()===
@@ Line 112: / Line 111: @@
 ===listFields()===
 This public method is inherited from [[Class: I2CE_Form (Development)#listFields() | I2CE_Form->listFields()]]
+===parentIsSet()===
+This public method is inherited from [[Class: I2CE_Form (Development)#parentIsSet() | I2CE_Form->parentIsSet()]]
 ===processDOM()===
@@ Line 121: / Line 123: @@
 ===search()===
 This public method is inherited from [[Class: I2CE_Form (Development)#search() | I2CE_Form->search()]]
+===setCreated()===
+This public method is inherited from [[Class: I2CE_Form (Development)#setCreated() | I2CE_Form->setCreated()]]
 ===setDisplayName()===
@@ Line 130: / Line 135: @@
 ===setFromPost()===
 This public method is inherited from [[Class: I2CE_Form (Development)#setFromPost() | I2CE_Form->setFromPost()]]
+===setLastModified()===
+This public method is inherited from [[Class: I2CE_Form (Development)#setLastModified() | I2CE_Form->setLastModified()]]
 ===setParent()===
 This public method is inherited from [[Class: I2CE_Form (Development)#setParent() | I2CE_Form->setParent()]]
+===isValidFieldName()===
+This protected method is inherited from [[Class: I2CE_Form (Development)#isValidFieldName() | I2CE_Form->isValidFieldName()]]
 ===lookupArray()===
 This protected method is inherited from [[Class: I2CE_Form (Development)#lookupArray() | I2CE_Form->lookupArray()]]
+===preProcessFieldArgs()===
+This protected method is inherited from [[Class: I2CE_Form (Development)#preProcessFieldArgs() | I2CE_Form->preProcessFieldArgs()]]
+===setupCreatedField()===
+This protected method is inherited from [[Class: I2CE_Form (Development)#setupCreatedField() | I2CE_Form->setupCreatedField()]]
+===setupLastModifiedField()===
+This protected method is inherited from [[Class: I2CE_Form (Development)#setupLastModifiedField() | I2CE_Form->setupLastModifiedField()]]
+===setupParentField()===
+This protected method is inherited from [[Class: I2CE_Form (Development)#setupParentField() | I2CE_Form->setupParentField()]]
 ===__get()===
@@ Line 160: / Line 183: @@
 ===getAttribute()===
 This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getAttribute() | I2CE_FieldContainer->getAttribute()]]
+===getContainerIndex()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getContainerIndex() | I2CE_FieldContainer->getContainerIndex()]]
 ===getContainerType()===
@@ Line 196: / Line 222: @@
 ===hasAttribute()===
 This public method is inherited from [[Class: I2CE_FieldContainer (Development)#hasAttribute() | I2CE_FieldContainer->hasAttribute()]]
+===hasField()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#hasField() | I2CE_FieldContainer->hasField()]]
 ===hasInvalid()===
@@ Line 226: / Line 255: @@
 ===setId()===
 This public method is inherited from [[Class: I2CE_FieldContainer (Development)#setId() | I2CE_FieldContainer->setId()]]
+===setInvalidMessage()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#setInvalidMessage() | I2CE_FieldContainer->setInvalidMessage()]]
 ===setMeta()===
@@ Line 235: / Line 267: @@
 ===valid()===
 This public method is inherited from [[Class: I2CE_FieldContainer (Development)#valid() | I2CE_FieldContainer->valid()]]
+===validate()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#validate() | I2CE_FieldContainer->validate()]]
 ===addFields()===
@@ Line 247: / Line 282: @@
 ===$children===
 Theis public variable is inherited from [[Class: I2CE_Form (Development)#$children | I2CE_Form->$children]]
-===$parent===
-Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$parent | I2CE_Form->$parent]]
 ===$parent_forms===
 Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$parent_forms | I2CE_Form->$parent_forms]]
+===$parentField===
+Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$parentField | I2CE_Form->$parentField]]
+===$lastModifiedField===
+Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$lastModifiedField | I2CE_Form->$lastModifiedField]]
+===$createdField===
+Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$createdField | I2CE_Form->$createdField]]
 ===$name===
@@ Line 313: / Line 354: @@
 ===populate()===
 This method is inherited from [[Class: I2CE_Form (Development)#populate() | I2CE_Form->populate()]]
+===duplicate()===
+This method is inherited from [[Class: I2CE_Form (Development)#duplicate() | I2CE_Form->duplicate()]]
+===storeHistory()===
+This method is inherited from [[Class: I2CE_Form (Development)#storeHistory() | I2CE_Form->storeHistory()]]
 ===populateChild()===
@@ Line 337: / Line 384: @@
 ===setChangeType()===
 This method is inherited from [[Class: I2CE_Form (Development)#setChangeType() | I2CE_Form->setChangeType()]]
+===changeID()===
+This method is inherited from [[Class: I2CE_Form (Development)#changeID() | I2CE_Form->changeID()]]
 ===userMessage()===
@@ Line 342: / Line 392: @@
 ==Fuzzy Methods==
 ===isActive()===
-This method is implemented by [[Class: iHRIS_Module_PersonPosition (Development)#isActive_PersonPosution() | iHRIS_Module_PersonPosition->isActive_PersonPosution() ]]
+This method is implemented by [[Class: iHRIS_Module_PersonPosition (Development)#isActive_PersonPosition() | iHRIS_Module_PersonPosition->isActive_PersonPosition() ]]
+===getLastSalary()===
+This method is implemented by [[Class: iHRIS_Module_ManageSalary (Development)#getLastSalary() | iHRIS_Module_ManageSalary->getLastSalary() ]]
+===getSalaryGradeID()===
+This method is implemented by [[Class: iHRIS_Module_ManageSalary (Development)#getSalaryGradeID() | iHRIS_Module_ManageSalary->getSalaryGradeID() ]]
 [[Category:Class Documentation (Development)]]

Anonymous

Search