Class: iHRIS Person

This article describes the class iHRIS_Person.

• Extends the class: I2CE_Form.
• Child Classes:
  • iHRIS_QualifyPerson
  • iHRIS_ManagePerson
• Location: Part of the module Person in the package iHRIS Common
• Source: Defined in the file modules/Person/lib/iHRIS_Person.php
• Author: Carl Leitner <litlfred@ibiblio.org>

iHRIS_Person

Form Fields

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

surname

The form field surname is implemented by STRING_LINE

firstname

The form field firstname is implemented by STRING_LINE

othername

The form field othername is implemented by STRING_LINE

nationality

The form field nationality is implemented by MAP

surname_ignore

The form field surname_ignore is implemented by BOOL

residence

The form field residence is implemented by MAP

Methods

__construct()

Create a new instance of a person.

• Signature: public function __construct($form,$id)
• Parameters:
  • string $form
    The name of this form
  • integer $id
    • Default Value: 0

search()

Search the database for a person record. Returns a list of records that match the given search parameters. The $search parameter is an array in the following format: array( '<form>' => array( 0 => array( 'field' => '<field_name>', 'values' => array( 0 => array( 'value' => '<field_value>', 'method' => '=', 'lower' => <boolean> ) ), - or - 'values' => 'norecord', 'value_andor' => 'OR', 'history' => <false|true> ) $andor can be an array. If it is, the first entry is the default value used. The 1st entry goes between the 1st two where clauses, etc. Any forms not matching person will use the parent id from the record entry for the matching results.

• Signature: static public function search($search,$andor,$modified,$limit)
• Parameters:
  • array $search
  • string $andor
    If the search results should be AND or OR among all the search criteria
    • Default Value: "AND"
  • boolean $modified
    • Default Value: false
  • array $limit
    The limit to use on the final query, ie: array( 0, 100 ) to start at the beginning and return 100 rows.
    • Default Value: null
• Returns: array

validate()

Perform additional validation for the Person object. A new person record needs to verify there aren't any existing records with the same name. @param I2CE_Template $page A reference to the top level Template object

• Signature: public function validate()

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

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

getLastPosition()

This method is implemented by iHRIS_Module_PersonPosition->getLastPosition()

isActive()

This method is implemented by iHRIS_Module_PersonPosition->isActive_Person()