Class: iHRIS Search

From IHRIS Wiki
Revision as of 21:13, 16 October 2009 by Litlfred (talk | contribs)

The class iHRIS_Search contains 2 definitions:

lib/iHRIS_Search.php

This article desrcibes the class iHRIS_Search which extends the class I2CE_Form It is contained in the module ihris-qualify in the package iHRIS Qualify

The class is defined in the file: lib/iHRIS_Search.php

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

  • Author: Luke Duncan <lduncan@intrahealth.org>
  • Since: v1.0.0

Constants

iHRIS_Search::LIMIT_ALL

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

iHRIS_Search::LIMIT_IN_TRAINING

Constant values for limiting search results: include people in training. Defined as: 2

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

listLimitOptions()

List all the options from the limit array.

  • Signature: static public function listLimitOptions($form)
  • Returns: array

Parameters:

  • string $form
    The form we wish to lookup by

lookupLimit()

Lookup the given value from the limit array.

  • Signature: static public function lookupLimit($id,$form)
  • Returns: string

Parameters:

  • integer $id
  • string $form
    Not used for this method.
    • Default Value: ""

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

lib/iHRIS_Search.php

This article desrcibes the class iHRIS_Search which extends the class I2CE_Form It is contained in the module ihris-qualify in the package iHRIS Qualify

The class is defined in the file: lib/iHRIS_Search.php

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

  • Author: Luke Duncan <lduncan@intrahealth.org>
  • Since: v1.0.0

Constants

iHRIS_Search::LIMIT_ALL

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

iHRIS_Search::LIMIT_IN_TRAINING

Constant values for limiting search results: include people in training. Defined as: 2

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

listLimitOptions()

List all the options from the limit array.

  • Signature: static public function listLimitOptions($form)
  • Returns: array

Parameters:

  • string $form
    The form we wish to lookup by

lookupLimit()

Lookup the given value from the limit array.

  • Signature: static public function lookupLimit($id,$form)
  • Returns: string

Parameters:

  • integer $id
  • string $form
    Not used for this method.
    • Default Value: ""

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

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_iHRIS_Search&oldid=6372"