Class: I2CE FormField BOOL: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 3: Line 3:
*Definition in [[#modules/Forms/lib/fields/I2CE_FormField_BOOL.php|modules/Forms/lib/fields/I2CE_FormField_BOOL.php]]
*Definition in [[#modules/Forms/lib/fields/I2CE_FormField_BOOL.php|modules/Forms/lib/fields/I2CE_FormField_BOOL.php]]
=modules/Forms/lib/fields/I2CE_FormField_BOOL.php=
=modules/Forms/lib/fields/I2CE_FormField_BOOL.php=
This article desrcibes the class '''I2CE_FormField_BOOL'''.
This article desrcibes the class ''I2CE_FormField_BOOL''.
*Extends the class: [[Class: I2CE_FormField_DB_INT | I2CE_FormField_DB_INT]].
*Extends the class: [[Class: I2CE_FormField_DB_INT | I2CE_FormField_DB_INT]].
*Location: Part of the module [[iHRIS Module List#forms|forms]] in the package [https://launchpad.net/i2ce I2CE]
*Location: Part of the module [[iHRIS Module List#forms|forms]] in the package [https://launchpad.net/i2ce I2CE]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Forms/lib/fields/I2CE_FormField_BOOL.php modules/Forms/lib/fields/I2CE_FormField_BOOL.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Forms/lib/fields/I2CE_FormField_BOOL.php modules/Forms/lib/fields/I2CE_FormField_BOOL.php]
*Author: Luke Duncan <lduncan@intrahealth.org>
*Author: Luke Duncan <lduncan@intrahealth.org>
*Since: v2.0.0
*Since: v2.0.0
Line 285: Line 284:
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
=modules/Forms/lib/fields/I2CE_FormField_BOOL.php=
=modules/Forms/lib/fields/I2CE_FormField_BOOL.php=
This article desrcibes the class '''I2CE_FormField_BOOL'''.
This article desrcibes the class ''I2CE_FormField_BOOL''.
*Extends the class: [[Class: I2CE_FormField_DB_INT | I2CE_FormField_DB_INT]].
*Extends the class: [[Class: I2CE_FormField_DB_INT | I2CE_FormField_DB_INT]].
*Location: Part of the module [[iHRIS Module List#forms|forms]] in the package [https://launchpad.net/i2ce I2CE]
*Location: Part of the module [[iHRIS Module List#forms|forms]] in the package [https://launchpad.net/i2ce I2CE]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Forms/lib/fields/I2CE_FormField_BOOL.php modules/Forms/lib/fields/I2CE_FormField_BOOL.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Forms/lib/fields/I2CE_FormField_BOOL.php modules/Forms/lib/fields/I2CE_FormField_BOOL.php]
*Author: Luke Duncan <lduncan@intrahealth.org>
*Author: Luke Duncan <lduncan@intrahealth.org>
*Since: v2.0.0
*Since: v2.0.0

Revision as of 23:13, 16 October 2009

The class I2CE_FormField_BOOL contains 2 definitions:

modules/Forms/lib/fields/I2CE_FormField_BOOL.php

This article desrcibes the class I2CE_FormField_BOOL.

Class for defining all the database fields used by a I2CE_Form object.

Methods

__construct()

Create a new instance of a I2CE_FormField

  • Signature: public function __construct($name,$options)

Parameters:

  • string $name
  • array $options
    A list of options for this form field.

getDBValue()

Returns the value of this field ready to be stored in the database.

  • Signature: public function getDBValue()
  • Returns: mixed

getDisplayValue()

Returns the value of this field as a human readable format. entry for this field.

  • Signature: public function getDisplayValue($entry)
  • Returns: mixed

Parameters:

  • I2CE_Entry $entry
    If a I2CE_Entry object has been passed to this method then it will return the value for that entry assuming it's an
    • Default Value: false

isValid()

Checks to see if the current value for this is set and valid.

  • Signature: public function isValid()
  • Returns: boolean

processDOMEditable()

  • Signature: public function processDOMEditable($node,$template,$form_node)
  • Returns: array of DOMNode

Parameters:

  • $node
  • $template
  • $form_node

setFromPost()

Sets the value of this field from the posted form.

  • Signature: public function setFromPost($post)

Parameters:

  • array $post
    The $_POST array holding the values for this form.

Inherited Variables

$name

Theis protected variable is inherited from I2CE_FormField->$name

$options

Theis protected variable is inherited from I2CE_FormField->$options

$value

Theis protected variable is inherited from I2CE_FormField->$value

$headers

Theis protected variable is inherited from I2CE_FormField->$headers

$href

Theis protected variable is inherited from I2CE_FormField->$href

$form

Theis protected variable is inherited from I2CE_FormField->$form

$history

Theis protected variable is inherited from I2CE_FormField->$history

$history_idx

Theis protected variable is inherited from I2CE_FormField->$history_idx

$attributes

Theis protected variable is inherited from I2CE_FormField->$attributes

$invalid

Theis protected variable is inherited from I2CE_FormField->$invalid

Inherited Fuzzy Methods

generateLimit_in()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_in()

generateLimit_equals()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_equals()

generateLimit_greaterthan()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_greaterthan()

generateLimit_lessthan()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_lessthan()

generateLimit_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_greaterthan_equals()

generateLimit_lessthan_equals()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_lessthan_equals()

generateLimit_between()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_between()

checkLimit_in()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_in()

checkLimitString_in()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_in()

getLimitMenu_in()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_in()

processLimitMenu_in()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_in()

checkLimit_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_equals()

checkLimitString_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_equals()

getLimitMenu_equals()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_equals()

processLimitMenu_equals()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_equals()

checkLimit_greaterthan()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_greaterthan()

checkLimitString_greaterthan()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_greaterthan()

getLimitMenu_greaterthan()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_greaterthan()

processLimitMenu_greaterthan()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_greaterthan()

checkLimit_lessthan()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_lessthan()

checkLimitString_lessthan()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_lessthan()

getLimitMenu_lessthan()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_lessthan()

processLimitMenu_lessthan()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_lessthan()

checkLimit_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_greaterthan_equals()

checkLimitString_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_greaterthan_equals()

getLimitMenu_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_greaterthan_equals()

processLimitMenu_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_greaterthan_equals()

checkLimit_lessthan_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_lessthan_equals()

checkLimitString_lessthan_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_lessthan_equals()

getLimitMenu_lessthan_equals()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_lessthan_equals()

processLimitMenu_lessthan_equals()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_lessthan_equals()

checkLimit_between()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_between()

checkLimitString_between()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_between()

getLimitMenu_between()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_between()

processLimitMenu_between()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_between()

cachedTableReference()

This method is inherited from I2CE_FormField->cachedTableReference()

isNumeric()

This method is inherited from I2CE_FormField->isNumeric()

getLimitStyles()

This method is inherited from I2CE_FormField->getLimitStyles()

generateLimit()

This method is inherited from I2CE_FormField->generateLimit()

generateLimit_null()

This method is inherited from I2CE_FormField->generateLimit_null()

generateLimit_not_null()

This method is inherited from I2CE_FormField->generateLimit_not_null()

generateLimit_null_not_null()

This method is inherited from I2CE_FormField->generateLimit_null_not_null()

checkLimit_null()

This method is inherited from I2CE_FormField->checkLimit_null()

checkLimit_not_null()

This method is inherited from I2CE_FormField->checkLimit_not_null()

checkLimit_null_not_null()

This method is inherited from I2CE_FormField->checkLimit_null_not_null()

checkLimitString_null()

This method is inherited from I2CE_FormField->checkLimitString_null()

checkLimitString_not_null()

This method is inherited from I2CE_FormField->checkLimitString_not_null()

checkLimitString_null_not_null()

This method is inherited from I2CE_FormField->checkLimitString_null_not_null()

getLimitMenu_null()

This method is inherited from I2CE_FormField->getLimitMenu_null()

getLimitMenu_not_null()

This method is inherited from I2CE_FormField->getLimitMenu_not_null()

getLimitMenu_null_not_null()

This method is inherited from I2CE_FormField->getLimitMenu_null_not_null()

processLimitMenu_null()

This method is inherited from I2CE_FormField->processLimitMenu_null()

processLimitMenu_not_null()

This method is inherited from I2CE_FormField->processLimitMenu_not_null()

processLimitMenu_null_not_null()

This method is inherited from I2CE_FormField->processLimitMenu_null_not_null()

generateLimit_max_parent()

This method is inherited from I2CE_FormField->generateLimit_max_parent()

generateLimit_min_parent()

This method is inherited from I2CE_FormField->generateLimit_min_parent()

generateLimit_max_parent_form()

This method is inherited from I2CE_FormField->generateLimit_max_parent_form()

generateLimit_min_parent_form()

This method is inherited from I2CE_FormField->generateLimit_min_parent_form()

getLimitMenu_max_parent()

This method is inherited from I2CE_FormField->getLimitMenu_max_parent()

getLimitMenu_min_parent()

This method is inherited from I2CE_FormField->getLimitMenu_min_parent()

getLimitMenu_max_parent_form()

This method is inherited from I2CE_FormField->getLimitMenu_max_parent_form()

getLimitMenu_min_parent_form()

This method is inherited from I2CE_FormField->getLimitMenu_min_parent_form()

processLimitMenu_max_parent()

This method is inherited from I2CE_FormField->processLimitMenu_max_parent()

processLimitMenu_min_parent()

This method is inherited from I2CE_FormField->processLimitMenu_min_parent()

processLimitMenu_max_parent_form()

This method is inherited from I2CE_FormField->processLimitMenu_max_parent_form()

processLimitMenu_min_parent_form()

This method is inherited from I2CE_FormField->processLimitMenu_min_parent_form()

save()

This method is inherited from I2CE_FormField->save()

populateHistory()

This method is inherited from I2CE_FormField->populateHistory()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

modules/Forms/lib/fields/I2CE_FormField_BOOL.php

This article desrcibes the class I2CE_FormField_BOOL.

Class for defining all the database fields used by a I2CE_Form object.

Methods

__construct()

Create a new instance of a I2CE_FormField

  • Signature: public function __construct($name,$options)

Parameters:

  • string $name
  • array $options
    A list of options for this form field.

getDBValue()

Returns the value of this field ready to be stored in the database.

  • Signature: public function getDBValue()
  • Returns: mixed

getDisplayValue()

Returns the value of this field as a human readable format. entry for this field.

  • Signature: public function getDisplayValue($entry)
  • Returns: mixed

Parameters:

  • I2CE_Entry $entry
    If a I2CE_Entry object has been passed to this method then it will return the value for that entry assuming it's an
    • Default Value: false

isValid()

Checks to see if the current value for this is set and valid.

  • Signature: public function isValid()
  • Returns: boolean

processDOMEditable()

  • Signature: public function processDOMEditable($node,$template,$form_node)
  • Returns: array of DOMNode

Parameters:

  • $node
  • $template
  • $form_node

setFromPost()

Sets the value of this field from the posted form.

  • Signature: public function setFromPost($post)

Parameters:

  • array $post
    The $_POST array holding the values for this form.

Inherited Variables

$name

Theis protected variable is inherited from I2CE_FormField->$name

$options

Theis protected variable is inherited from I2CE_FormField->$options

$value

Theis protected variable is inherited from I2CE_FormField->$value

$headers

Theis protected variable is inherited from I2CE_FormField->$headers

$href

Theis protected variable is inherited from I2CE_FormField->$href

$form

Theis protected variable is inherited from I2CE_FormField->$form

$history

Theis protected variable is inherited from I2CE_FormField->$history

$history_idx

Theis protected variable is inherited from I2CE_FormField->$history_idx

$attributes

Theis protected variable is inherited from I2CE_FormField->$attributes

$invalid

Theis protected variable is inherited from I2CE_FormField->$invalid

Inherited Fuzzy Methods

generateLimit_in()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_in()

generateLimit_equals()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_equals()

generateLimit_greaterthan()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_greaterthan()

generateLimit_lessthan()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_lessthan()

generateLimit_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_greaterthan_equals()

generateLimit_lessthan_equals()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_lessthan_equals()

generateLimit_between()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_between()

checkLimit_in()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_in()

checkLimitString_in()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_in()

getLimitMenu_in()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_in()

processLimitMenu_in()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_in()

checkLimit_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_equals()

checkLimitString_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_equals()

getLimitMenu_equals()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_equals()

processLimitMenu_equals()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_equals()

checkLimit_greaterthan()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_greaterthan()

checkLimitString_greaterthan()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_greaterthan()

getLimitMenu_greaterthan()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_greaterthan()

processLimitMenu_greaterthan()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_greaterthan()

checkLimit_lessthan()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_lessthan()

checkLimitString_lessthan()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_lessthan()

getLimitMenu_lessthan()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_lessthan()

processLimitMenu_lessthan()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_lessthan()

checkLimit_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_greaterthan_equals()

checkLimitString_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_greaterthan_equals()

getLimitMenu_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_greaterthan_equals()

processLimitMenu_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_greaterthan_equals()

checkLimit_lessthan_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_lessthan_equals()

checkLimitString_lessthan_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_lessthan_equals()

getLimitMenu_lessthan_equals()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_lessthan_equals()

processLimitMenu_lessthan_equals()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_lessthan_equals()

checkLimit_between()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_between()

checkLimitString_between()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_between()

getLimitMenu_between()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_between()

processLimitMenu_between()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_between()

cachedTableReference()

This method is inherited from I2CE_FormField->cachedTableReference()

isNumeric()

This method is inherited from I2CE_FormField->isNumeric()

getLimitStyles()

This method is inherited from I2CE_FormField->getLimitStyles()

generateLimit()

This method is inherited from I2CE_FormField->generateLimit()

generateLimit_null()

This method is inherited from I2CE_FormField->generateLimit_null()

generateLimit_not_null()

This method is inherited from I2CE_FormField->generateLimit_not_null()

generateLimit_null_not_null()

This method is inherited from I2CE_FormField->generateLimit_null_not_null()

checkLimit_null()

This method is inherited from I2CE_FormField->checkLimit_null()

checkLimit_not_null()

This method is inherited from I2CE_FormField->checkLimit_not_null()

checkLimit_null_not_null()

This method is inherited from I2CE_FormField->checkLimit_null_not_null()

checkLimitString_null()

This method is inherited from I2CE_FormField->checkLimitString_null()

checkLimitString_not_null()

This method is inherited from I2CE_FormField->checkLimitString_not_null()

checkLimitString_null_not_null()

This method is inherited from I2CE_FormField->checkLimitString_null_not_null()

getLimitMenu_null()

This method is inherited from I2CE_FormField->getLimitMenu_null()

getLimitMenu_not_null()

This method is inherited from I2CE_FormField->getLimitMenu_not_null()

getLimitMenu_null_not_null()

This method is inherited from I2CE_FormField->getLimitMenu_null_not_null()

processLimitMenu_null()

This method is inherited from I2CE_FormField->processLimitMenu_null()

processLimitMenu_not_null()

This method is inherited from I2CE_FormField->processLimitMenu_not_null()

processLimitMenu_null_not_null()

This method is inherited from I2CE_FormField->processLimitMenu_null_not_null()

generateLimit_max_parent()

This method is inherited from I2CE_FormField->generateLimit_max_parent()

generateLimit_min_parent()

This method is inherited from I2CE_FormField->generateLimit_min_parent()

generateLimit_max_parent_form()

This method is inherited from I2CE_FormField->generateLimit_max_parent_form()

generateLimit_min_parent_form()

This method is inherited from I2CE_FormField->generateLimit_min_parent_form()

getLimitMenu_max_parent()

This method is inherited from I2CE_FormField->getLimitMenu_max_parent()

getLimitMenu_min_parent()

This method is inherited from I2CE_FormField->getLimitMenu_min_parent()

getLimitMenu_max_parent_form()

This method is inherited from I2CE_FormField->getLimitMenu_max_parent_form()

getLimitMenu_min_parent_form()

This method is inherited from I2CE_FormField->getLimitMenu_min_parent_form()

processLimitMenu_max_parent()

This method is inherited from I2CE_FormField->processLimitMenu_max_parent()

processLimitMenu_min_parent()

This method is inherited from I2CE_FormField->processLimitMenu_min_parent()

processLimitMenu_max_parent_form()

This method is inherited from I2CE_FormField->processLimitMenu_max_parent_form()

processLimitMenu_min_parent_form()

This method is inherited from I2CE_FormField->processLimitMenu_min_parent_form()

save()

This method is inherited from I2CE_FormField->save()

populateHistory()

This method is inherited from I2CE_FormField->populateHistory()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Fuzzy Methods

generateLimit_truefalse()

This method is implemented by I2CE_Module_FormLimits->generateLimit_BOOL_truefalse()

generateLimit_true()

This method is implemented by I2CE_Module_FormLimits->generateLimit_BOOL_true()

generateLimit_false()

This method is implemented by I2CE_Module_FormLimits->generateLimit_BOOL_false()

checkLimit_truefalse()

This method is implemented by I2CE_Module_FormLimits->checkLimit_BOOL_truefalse()

checkLimitString_truefalse()

This method is implemented by I2CE_Module_FormLimits->checkLimitString_BOOL_truefalse()

getLimitMenu_truefalse()

This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_BOOL_DISPLAYFIELDSTYLE_truefalse()

processLimitMenu_truefalse()

This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_BOOL_PROCESSFIELDSTYLE_truefalse()

checkLimit_true()

This method is implemented by I2CE_Module_FormLimits->checkLimit_BOOL_true()

checkLimitString_true()

This method is implemented by I2CE_Module_FormLimits->checkLimitString_BOOL_true()

getLimitMenu_true()

This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_BOOL_DISPLAYFIELDSTYLE_true()

processLimitMenu_true()

This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_BOOL_PROCESSFIELDSTYLE_true()

checkLimit_false()

This method is implemented by I2CE_Module_FormLimits->checkLimit_BOOL_false()

checkLimitString_false()

This method is implemented by I2CE_Module_FormLimits->checkLimitString_BOOL_false()

getLimitMenu_false()

This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_BOOL_DISPLAYFIELDSTYLE_false()

processLimitMenu_false()

This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_BOOL_PROCESSFIELDSTYLE_false()