Class: iHRIS Search: Difference between revisions
No edit summary |
Sturlington (talk | contribs) No edit summary |
||
(16 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
This article describes the class ''iHRIS_Search''. | |||
*Extends the class: [[Class: I2CE_Form | I2CE_Form]]. | |||
*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/ihris-manage/4.0.2-release/annotate/head:/lib/iHRIS_Search.php#L34 lib/iHRIS_Search.php] on line 34 | |||
This article | *Author: Luke Duncan <lduncan@intrahealth.org> | ||
*Since: v2.0.0 | |||
@copyright Copyright © 2007, 2008 IntraHealth International, Inc. Object for dealing with selecting search options for the search form.. | |||
@copyright Copyright © 2007, 2008 IntraHealth International, Inc. | |||
Object for dealing with selecting search options for the search form.. | |||
==Constants== | ==Constants== | ||
===iHRIS_Search::LIMIT_ALL=== | ===iHRIS_Search::LIMIT_ALL=== | ||
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:: | ===iHRIS_Search::LIMIT_APPLICANT=== | ||
Constant values for limiting search results: include | Constant values for limiting search results: include applicant results. | ||
Defined as: 2 | Defined as: 2 | ||
===iHRIS_Search:: | ===iHRIS_Search::LIMIT_EMPLOYEE=== | ||
Constant values for limiting search results: include | Constant values for limiting search results: include employee results. | ||
Defined as: 3 | Defined as: 3 | ||
===iHRIS_Search:: | ===iHRIS_Search::LIMIT_OLD_APPLICANT=== | ||
Constant values for limiting search results: include | 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 ] | |||
===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 ] | |||
==Inherited Methods== | |||
===__construct()=== | |||
This public method is inherited from [[Class: I2CE_Form#__construct() | I2CE_Form->__construct()]] | |||
===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()]] | |||
===getFieldNames()=== | |||
This public method is inherited from [[Class: I2CE_Form#getFieldNames() | I2CE_Form->getFieldNames()]] | |||
===getFormId()=== | |||
This public method is inherited from [[Class: I2CE_Form#getFormId() | I2CE_Form->getFormId()]] | |||
===getHTMLName()=== | |||
This public method is inherited from [[Class: I2CE_Form#getHTMLName() | I2CE_Form->getHTMLName()]] | |||
===getId()=== | |||
This public method is inherited from [[Class: I2CE_Form#getId() | I2CE_Form->getId()]] | |||
===getParent()=== | |||
This public method is inherited from [[Class: I2CE_Form#getParent() | I2CE_Form->getParent()]] | |||
== | ===getParentForm()=== | ||
This public method is inherited from [[Class: I2CE_Form#getParentForm() | I2CE_Form->getParentForm()]] | |||
=== | ===getParentID()=== | ||
This public method is inherited from [[Class: I2CE_Form#getParentID() | I2CE_Form->getParentID()]] | |||
=== | ===getQueryDisplay()=== | ||
This public method is inherited from [[Class: I2CE_Form#getQueryDisplay() | I2CE_Form->getQueryDisplay()]] | |||
=== | ===getQueryFields()=== | ||
This public method is inherited from [[Class: I2CE_Form#getQueryFields() | I2CE_Form->getQueryFields()]] | |||
=== | ===getQueryString()=== | ||
This public method is inherited from [[Class: I2CE_Form#getQueryString() | I2CE_Form->getQueryString()]] | |||
=== | ===hasAttribute()=== | ||
This public method is inherited from [[Class: I2CE_Form#hasAttribute() | I2CE_Form->hasAttribute()]] | |||
This method is inherited from [[Class: I2CE_Form# | |||
=== | ===hasInvalid()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#hasInvalid() | I2CE_Form->hasInvalid()]] | ||
=== | ===key()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#key() | I2CE_Form->key()]] | ||
=== | ===listFields()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#listFields() | I2CE_Form->listFields()]] | ||
=== | ===load()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#load() | I2CE_Form->load()]] | ||
=== | ===next()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#next() | I2CE_Form->next()]] | ||
=== | ===processDOM()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#processDOM() | I2CE_Form->processDOM()]] | ||
=== | ===removeField()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#removeField() | I2CE_Form->removeField()]] | ||
=== | ===reset()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#reset() | I2CE_Form->reset()]] | ||
=== | ===rewind()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#rewind() | I2CE_Form->rewind()]] | ||
=== | ===search()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#search() | I2CE_Form->search()]] | ||
=== | ===setAttribute()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#setAttribute() | I2CE_Form->setAttribute()]] | ||
=== | ===setDisplayName()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#setDisplayName() | I2CE_Form->setDisplayName()]] | ||
=== | ===setForm()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#setForm() | I2CE_Form->setForm()]] | ||
=== | ===setFromPost()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#setFromPost() | I2CE_Form->setFromPost()]] | ||
=== | ===setId()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#setId() | I2CE_Form->setId()]] | ||
=== | ===setParent()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#setParent() | I2CE_Form->setParent()]] | ||
=== | ===valid()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#valid() | I2CE_Form->valid()]] | ||
=== | ===validate()=== | ||
This method is inherited from [[Class: I2CE_Form# | This public method is inherited from [[Class: I2CE_Form#validate() | I2CE_Form->validate()]] | ||
=== | ===__get()=== | ||
This method is inherited from [[Class: I2CE_Form# | This protected method is inherited from [[Class: I2CE_Form#__get() | I2CE_Form->__get()]] | ||
=== | ===__isset()=== | ||
This method is inherited from [[Class: I2CE_Form# | This protected method is inherited from [[Class: I2CE_Form#__isset() | I2CE_Form->__isset()]] | ||
=== | ===__set()=== | ||
This method is inherited from [[Class: I2CE_Form# | This protected method is inherited from [[Class: I2CE_Form#__set() | I2CE_Form->__set()]] | ||
=== | ===__unset()=== | ||
This method is inherited from [[Class: I2CE_Form# | This protected method is inherited from [[Class: I2CE_Form#__unset() | I2CE_Form->__unset()]] | ||
=== | ===addFormFields()=== | ||
This method is inherited from [[Class: I2CE_Form# | This protected method is inherited from [[Class: I2CE_Form#addFormFields() | I2CE_Form->addFormFields()]] | ||
=== | ===getFormFieldsData()=== | ||
This method is inherited from [[Class: | This protected method is inherited from [[Class: I2CE_Form#getFormFieldsData() | I2CE_Form->getFormFieldsData()]] | ||
== | ===lookupArray()=== | ||
This protected method is inherited from [[Class: I2CE_Form#lookupArray() | I2CE_Form->lookupArray()]] | |||
===_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.
- Extends the class: I2CE_Form.
- Location: Part of the module ihris-manage in the package iHRIS Manage
- Source: Defined in the file lib/iHRIS_Search.php on line 34
- Author: Luke Duncan <lduncan@intrahealth.org>
- Since: v2.0.0
@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.
- Defined in manage/lib/iHRIS_Search.php on line 60
- Type: static public $limit
$app_limit
List of choices for limiting search results with applicant module.
- Defined in manage/lib/iHRIS_Search.php on line 65
- Type: static public $app_limit
Methods
listLimitOptions()
List all the options from the limit array.
- Defined in manage/lib/iHRIS_Search.php on line 89
- Signature: static public function listLimitOptions($form)
- Parameters:
- string $form
The form we wish to lookup by
- string $form
- Returns: array
lookupLimit()
Lookup the given value from the limit array.
- Defined in manage/lib/iHRIS_Search.php on line 77
- Signature: static public function lookupLimit($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()
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()