Class: iHRIS Search: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The class iHRIS_Search contains 2 definitions:
This article describes the class ''iHRIS_Search''.
*Definition in [[#lib/iHRIS_Search.php|lib/iHRIS_Search.php]]
*Definition in [[#lib/iHRIS_Search.php|lib/iHRIS_Search.php]]
=lib/iHRIS_Search.php=
This article desrcibes the class ''iHRIS_Search''.
*Extends the class: [[Class: I2CE_Form | I2CE_Form]].
*Extends the class: [[Class: I2CE_Form | I2CE_Form]].
*Location: Part of the module [[iHRIS Module List#ihris-qualify|ihris-qualify]] in the package [https://launchpad.net/qualify iHRIS Qualify]
*Location: Part of the module [[iHRIS Manage Module List#ihris-manage|ihris-manage]] in the package [https://launchpad.net/ihris-manage iHRIS Manage]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0.-release/annotate/head:/lib/iHRIS_Search.php lib/iHRIS_Search.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/lib/iHRIS_Search.php#L34 lib/iHRIS_Search.php] on line 34
*Author: Luke Duncan <lduncan@intrahealth.org>
*Author: Luke Duncan <lduncan@intrahealth.org>
*Since: v1.0.0
*Since: v2.0.0
@copyright Copyright &copy; 2007, 2008 IntraHealth International, Inc.    Object for dealing with selecting search options for the search form..
@copyright Copyright &copy; 2007, 2008 IntraHealth International, Inc.    Object for dealing with selecting search options for the search form..
==Constants==
==Constants==
Line 14: Line 10:
Constant values for limiting search results: include all results.
Constant values for limiting search results: include all results.
Defined as: 1
Defined as: 1
===iHRIS_Search::LIMIT_IN_TRAINING===
===iHRIS_Search::LIMIT_APPLICANT===
Constant values for limiting search results: include people in training.
Constant values for limiting search results: include applicant results.
Defined as: 2
Defined as: 2
===iHRIS_Search::LIMIT_REGISTERED===
===iHRIS_Search::LIMIT_EMPLOYEE===
Constant values for limiting search results: include people who have registered.
Constant values for limiting search results: include employee results.
Defined as: 3
Defined as: 3
===iHRIS_Search::LIMIT_LICENSED===
===iHRIS_Search::LIMIT_OLD_APPLICANT===
Constant values for limiting search results: include people who have been licensed.
Constant values for limiting search results: include old applicant results.
Defined as: 4
Defined as: 4
===iHRIS_Search::LIMIT_OLD_EMPLOYEE===
Constant values for limiting search results: include old employee results.
Defined as: 5
==Variables==
==Variables==
===$limit===
===$limit===
List of choices for limiting search results.
List of choices for limiting search results.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/lib/iHRIS_Search.php#L60 manage/lib/iHRIS_Search.php] on line 60
*Type: static public $limit
*Type: static public $limit
===$app_limit===
List of choices for limiting search results with applicant module.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/lib/iHRIS_Search.php#L65 manage/lib/iHRIS_Search.php] on line 65
*Type: static public $app_limit


==Methods==
==Methods==
===listLimitOptions()===
===listLimitOptions()===
List all the options from the limit array.
List all the options from the limit array.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/lib/iHRIS_Search.php#L89 manage/lib/iHRIS_Search.php] on line 89
*Signature: static public function listLimitOptions($form)
*Signature: static public function listLimitOptions($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 ]
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
Parameters:
* [http://www.php.net/manual/en/language.types.string.php string ] $form<br/>The  form we wish to lookup by
===lookupLimit()===
===lookupLimit()===
Lookup the given value from the limit array.
Lookup the given value from the limit array.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/lib/iHRIS_Search.php#L77 manage/lib/iHRIS_Search.php] on line 77
*Signature: static public function lookupLimit($id,$form)
*Signature: static public function lookupLimit($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 ]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
Parameters:
==Inherited Methods==
* integer $id
===__construct()===
* [http://www.php.net/manual/en/language.types.string.php string ] $form<br/>Not used for this method.
This public method is inherited from [[Class: I2CE_Form#__construct() | I2CE_Form->__construct()]]
**Default Value: ""
 
===addChildForm()===
This public method is inherited from [[Class: I2CE_Form#addChildForm() | I2CE_Form->addChildForm()]]
 
===addField()===
This public method is inherited from [[Class: I2CE_Form#addField() | I2CE_Form->addField()]]
 
===cleanup()===
This public method is inherited from [[Class: I2CE_Form#cleanup() | I2CE_Form->cleanup()]]
 
===clearFields()===
This public method is inherited from [[Class: I2CE_Form#clearFields() | I2CE_Form->clearFields()]]
 
===current()===
This public method is inherited from [[Class: I2CE_Form#current() | I2CE_Form->current()]]
 
===displayField()===
This public method is inherited from [[Class: I2CE_Form#displayField() | I2CE_Form->displayField()]]
 
===form()===
This public method is inherited from [[Class: I2CE_Form#form() | I2CE_Form->form()]]
 
===getAllowedParentForms()===
This public method is inherited from [[Class: I2CE_Form#getAllowedParentForms() | I2CE_Form->getAllowedParentForms()]]
 
===getAttribute()===
This public method is inherited from [[Class: I2CE_Form#getAttribute() | I2CE_Form->getAttribute()]]
 
===getChildForms()===
This public method is inherited from [[Class: I2CE_Form#getChildForms() | I2CE_Form->getChildForms()]]
 
===getChildFormsByForm()===
This public method is inherited from [[Class: I2CE_Form#getChildFormsByForm() | I2CE_Form->getChildFormsByForm()]]
 
===getChildren()===
This public method is inherited from [[Class: I2CE_Form#getChildren() | I2CE_Form->getChildren()]]
 
===getDisplayName()===
This public method is inherited from [[Class: I2CE_Form#getDisplayName() | I2CE_Form->getDisplayName()]]
 
===getField()===
This public method is inherited from [[Class: I2CE_Form#getField() | I2CE_Form->getField()]]


==Inherited Variables==
===getFieldNames()===
===$children===
This public method is inherited from [[Class: I2CE_Form#getFieldNames() | I2CE_Form->getFieldNames()]]
Theis public variable is inherited from [[Class: I2CE_Form#$children | I2CE_Form->$children]]


===$fields===
===getFormId()===
Theis protected variable is inherited from [[Class: I2CE_Form#$fields | I2CE_Form->$fields]]
This public method is inherited from [[Class: I2CE_Form#getFormId() | I2CE_Form->getFormId()]]


===$parent===
===getHTMLName()===
Theis protected variable is inherited from [[Class: I2CE_Form#$parent | I2CE_Form->$parent]]
This public method is inherited from [[Class: I2CE_Form#getHTMLName() | I2CE_Form->getHTMLName()]]


===$id===
===getId()===
Theis protected variable is inherited from [[Class: I2CE_Form#$id | I2CE_Form->$id]]
This public method is inherited from [[Class: I2CE_Form#getId() | I2CE_Form->getId()]]


===$attributes===
===getParent()===
Theis protected variable is inherited from [[Class: I2CE_Form#$attributes | I2CE_Form->$attributes]]
This public method is inherited from [[Class: I2CE_Form#getParent() | I2CE_Form->getParent()]]


===$parent_forms===
===getParentForm()===
Theis protected variable is inherited from [[Class: I2CE_Form#$parent_forms | I2CE_Form->$parent_forms]]
This public method is inherited from [[Class: I2CE_Form#getParentForm() | I2CE_Form->getParentForm()]]
==Inherited Fuzzy Methods==
===isNumeric()===
This method is inherited from [[Class: I2CE_Form#isNumeric() | I2CE_Form->isNumeric()]]


===getLimitStyles()===
===getParentID()===
This method is inherited from [[Class: I2CE_Form#getLimitStyles() | I2CE_Form->getLimitStyles()]]
This public method is inherited from [[Class: I2CE_Form#getParentID() | I2CE_Form->getParentID()]]


===checkLimit()===
===getQueryDisplay()===
This method is inherited from [[Class: I2CE_Form#checkLimit() | I2CE_Form->checkLimit()]]
This public method is inherited from [[Class: I2CE_Form#getQueryDisplay() | I2CE_Form->getQueryDisplay()]]


===checkWhereClause()===
===getQueryFields()===
This method is inherited from [[Class: I2CE_Form#checkWhereClause() | I2CE_Form->checkWhereClause()]]
This public method is inherited from [[Class: I2CE_Form#getQueryFields() | I2CE_Form->getQueryFields()]]


===createCheckFunction()===
===getQueryString()===
This method is inherited from [[Class: I2CE_Form#createCheckFunction() | I2CE_Form->createCheckFunction()]]
This public method is inherited from [[Class: I2CE_Form#getQueryString() | I2CE_Form->getQueryString()]]


===createCheckLimitString()===
===hasAttribute()===
This method is inherited from [[Class: I2CE_Form#createCheckLimitString() | I2CE_Form->createCheckLimitString()]]
This public method is inherited from [[Class: I2CE_Form#hasAttribute() | I2CE_Form->hasAttribute()]]


===generateLimit()===
===hasInvalid()===
This method is inherited from [[Class: I2CE_Form#generateLimit() | I2CE_Form->generateLimit()]]
This public method is inherited from [[Class: I2CE_Form#hasInvalid() | I2CE_Form->hasInvalid()]]


===generateWhereClause()===
===key()===
This method is inherited from [[Class: I2CE_Form#generateWhereClause() | I2CE_Form->generateWhereClause()]]
This public method is inherited from [[Class: I2CE_Form#key() | I2CE_Form->key()]]


===processLimit()===
===listFields()===
This method is inherited from [[Class: I2CE_Form#processLimit() | I2CE_Form->processLimit()]]
This public method is inherited from [[Class: I2CE_Form#listFields() | I2CE_Form->listFields()]]


===getDisplayedExistingLimit()===
===load()===
This method is inherited from [[Class: I2CE_Form#getDisplayedExistingLimit() | I2CE_Form->getDisplayedExistingLimit()]]
This public method is inherited from [[Class: I2CE_Form#load() | I2CE_Form->load()]]


===isComponentized()===
===next()===
This method is inherited from [[Class: I2CE_Form#isComponentized() | I2CE_Form->isComponentized()]]
This public method is inherited from [[Class: I2CE_Form#next() | I2CE_Form->next()]]


===addChild()===
===processDOM()===
This method is inherited from [[Class: I2CE_Form#addChild() | I2CE_Form->addChild()]]
This public method is inherited from [[Class: I2CE_Form#processDOM() | I2CE_Form->processDOM()]]


===getChildIds()===
===removeField()===
This method is inherited from [[Class: I2CE_Form#getChildIds() | I2CE_Form->getChildIds()]]
This public method is inherited from [[Class: I2CE_Form#removeField() | I2CE_Form->removeField()]]


===getStorage()===
===reset()===
This method is inherited from [[Class: I2CE_Form#getStorage() | I2CE_Form->getStorage()]]
This public method is inherited from [[Class: I2CE_Form#reset() | I2CE_Form->reset()]]


===isWritable()===
===rewind()===
This method is inherited from [[Class: I2CE_Form#isWritable() | I2CE_Form->isWritable()]]
This public method is inherited from [[Class: I2CE_Form#rewind() | I2CE_Form->rewind()]]


===populate()===
===search()===
This method is inherited from [[Class: I2CE_Form#populate() | I2CE_Form->populate()]]
This public method is inherited from [[Class: I2CE_Form#search() | I2CE_Form->search()]]


===populateChild()===
===setAttribute()===
This method is inherited from [[Class: I2CE_Form#populateChild() | I2CE_Form->populateChild()]]
This public method is inherited from [[Class: I2CE_Form#setAttribute() | I2CE_Form->setAttribute()]]


===populateChildren()===
===setDisplayName()===
This method is inherited from [[Class: I2CE_Form#populateChildren() | I2CE_Form->populateChildren()]]
This public method is inherited from [[Class: I2CE_Form#setDisplayName() | I2CE_Form->setDisplayName()]]


===populateFirst()===
===setForm()===
This method is inherited from [[Class: I2CE_Form#populateFirst() | I2CE_Form->populateFirst()]]
This public method is inherited from [[Class: I2CE_Form#setForm() | I2CE_Form->setForm()]]


===populateHistory()===
===setFromPost()===
This method is inherited from [[Class: I2CE_Form#populateHistory() | I2CE_Form->populateHistory()]]
This public method is inherited from [[Class: I2CE_Form#setFromPost() | I2CE_Form->setFromPost()]]


===populateLast()===
===setId()===
This method is inherited from [[Class: I2CE_Form#populateLast() | I2CE_Form->populateLast()]]
This public method is inherited from [[Class: I2CE_Form#setId() | I2CE_Form->setId()]]


===delete()===
===setParent()===
This method is inherited from [[Class: I2CE_Form#delete() | I2CE_Form->delete()]]
This public method is inherited from [[Class: I2CE_Form#setParent() | I2CE_Form->setParent()]]


===save()===
===valid()===
This method is inherited from [[Class: I2CE_Form#save() | I2CE_Form->save()]]
This public method is inherited from [[Class: I2CE_Form#valid() | I2CE_Form->valid()]]


===setChangeType()===
===validate()===
This method is inherited from [[Class: I2CE_Form#setChangeType() | I2CE_Form->setChangeType()]]
This public method is inherited from [[Class: I2CE_Form#validate() | I2CE_Form->validate()]]


===userMessage()===
===__get()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
This protected method is inherited from [[Class: I2CE_Form#__get() | I2CE_Form->__get()]]
=lib/iHRIS_Search.php=
 
This article desrcibes the class ''iHRIS_Search''.
===__isset()===
*Extends the class: [[Class: I2CE_Form | I2CE_Form]].
This protected method is inherited from [[Class: I2CE_Form#__isset() | I2CE_Form->__isset()]]
*Location: Part of the module [[iHRIS Module List#ihris-qualify|ihris-qualify]] in the package [https://launchpad.net/qualify iHRIS Qualify]
 
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0.-release/annotate/head:/lib/iHRIS_Search.php lib/iHRIS_Search.php]
===__set()===
*Author: Luke Duncan <lduncan@intrahealth.org>
This protected method is inherited from [[Class: I2CE_Form#__set() | I2CE_Form->__set()]]
*Since: v1.0.0
 
@copyright Copyright &copy; 2007, 2008 IntraHealth International, Inc.    Object for dealing with selecting search options for the search form..
===__unset()===
==Constants==
This protected method is inherited from [[Class: I2CE_Form#__unset() | I2CE_Form->__unset()]]
===iHRIS_Search::LIMIT_ALL===
 
Constant values for limiting search results: include all results.
===addFormFields()===
Defined as: 1
This protected method is inherited from [[Class: I2CE_Form#addFormFields() | I2CE_Form->addFormFields()]]
===iHRIS_Search::LIMIT_IN_TRAINING===
 
Constant values for limiting search results: include people in training.
===getFormFieldsData()===
Defined as: 2
This protected method is inherited from [[Class: I2CE_Form#getFormFieldsData() | I2CE_Form->getFormFieldsData()]]
===iHRIS_Search::LIMIT_REGISTERED===
Constant values for limiting search results: include people who have registered.
Defined as: 3
===iHRIS_Search::LIMIT_LICENSED===
Constant values for limiting search results: include people who have been licensed.
Defined as: 4
==Variables==
===$limit===
List of choices for limiting search results.
*Type: static public $limit


==Methods==
===lookupArray()===
===listLimitOptions()===
This protected method is inherited from [[Class: I2CE_Form#lookupArray() | I2CE_Form->lookupArray()]]
List all the options from the limit array.
*Signature: static public function listLimitOptions($form)
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
Parameters:
* [http://www.php.net/manual/en/language.types.string.php string ] $form<br/>The  form we wish to lookup by
===lookupLimit()===
Lookup the given value from the limit array.
*Signature: static public function lookupLimit($id,$form)
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
Parameters:
* integer $id
* [http://www.php.net/manual/en/language.types.string.php string ] $form<br/>Not used for this method.
**Default Value: ""


===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Variables==
==Inherited Variables==
===$children===
===$children===

Latest revision as of 13:18, 8 November 2013

This article describes the class iHRIS_Search.

@copyright Copyright © 2007, 2008 IntraHealth International, Inc. Object for dealing with selecting search options for the search form..

Constants

iHRIS_Search::LIMIT_ALL

Constant values for limiting search results: include all results. Defined as: 1

iHRIS_Search::LIMIT_APPLICANT

Constant values for limiting search results: include applicant results. Defined as: 2

iHRIS_Search::LIMIT_EMPLOYEE

Constant values for limiting search results: include employee results. Defined as: 3

iHRIS_Search::LIMIT_OLD_APPLICANT

Constant values for limiting search results: include old applicant results. Defined as: 4

iHRIS_Search::LIMIT_OLD_EMPLOYEE

Constant values for limiting search results: include old employee results. Defined as: 5

Variables

$limit

List of choices for limiting search results.

$app_limit

List of choices for limiting search results with applicant module.

Methods

listLimitOptions()

List all the options from the limit array.

lookupLimit()

Lookup the given value from the limit array.

Inherited Methods

__construct()

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

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

validate()

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

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