|
|
| (32 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class '''iHRIS_Person'''which extends the class [[Class: I2CE_Form | I2CE_Form]]
| | #REDIRECT [[Class: iHRIS_Person (4.1.7)]] |
| It is contained in the module [[iHRIS Module List#Person|Person]] in the package [https://launchpad.net/ihris-common iHRIS Common]
| |
| The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.0-release/files/head:modules/Person/lib/iHRIS_Person.php modules/Person/lib/iHRIS_Person.php]
| |
| iHRIS_Person
| |
| @package I2CE
| |
| @subpackage Core
| |
| @author Carl Leitner <litlfred@ibiblio.org>
| |
| | |
| @version 2.1
| |
| @access public
| |
| ==Methods==
| |
| ===__construct()===
| |
| Create a new instance of a person.
| |
| *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
| |
| ===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.
| |
| and return 100 rows.
| |
| *Signature: static public function search($search,$andor,$modified,$limit)
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array]
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.array.php array] $search
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $andor<br/>If the search results should be AND or OR among all the search criteria
| |
| **Default Value: "AND"
| |
| * [http://www.php.net/manual/en/language.types.boolean.php boolean] $modified
| |
| **Default Value: false
| |
| * [http://www.php.net/manual/en/language.types.array.php array] $limit<br/>The limit to use on the final query, ie: array( 0, 100 ) to start at the beginning
| |
| **Default Value: null
| |
| ===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.
| |
| *Signature: public function validate($page)
| |
| Parameters:
| |
| * I2CE_Template $page<br/>A reference to the top level Template object
| |
| ==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==
| |
| ===getLastPosition()===
| |
| This method is implemented by [[Class: iHRIS_Module_PersonPosition#getLastPosition() | iHRIS_Module_PersonPosition->getLastPosition() ]]
| |
| ===isActive()===
| |
| This method is implemented by [[Class: iHRIS_Module_PersonPosition#isActive_Person() | iHRIS_Module_PersonPosition->isActive_Person() ]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
