Class: I2CE Module FormLimits (4.0.3)

From IHRIS Wiki
Revision as of 15:17, 10 March 2010 by Litlfred (talk | contribs) (Created page with '{{otherversions|Class: I2CE_Module_FormLimits}} This article describes the class ''I2CE_Module_FormLimits'' . *Extends the class: I2CE_Module. *L…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
For other versions, see Class: I2CE_Module_FormLimits (versions) .


This article describes the class I2CE_Module_FormLimits .

I2CE_Module_FormRelationship

Variables

$dateTypes

$dateActions

$dateOperatorMaps

$menudata

$checkOperatorMap

Methods

DATE_between_checkLimit()

DATE_between_checkLimitString()

DATE_between_generateLimit()

DATE_between_getLimitMenu()

DATE_between_processLimitMenu()

DISPLAY_generic()

Generic (internal fuzzy method for) display menu for a limit style Generic (internal fuzzy method for) processing menu for a particular limit style

PROCESS_generic()

Generic (internal fuzzy method for) processing menu for a particular limit style @param array $params are the calling parameters. 0=>array $vals the values we are processing. 1=>string $reportformfield which defaults to null. in the case of null, we except keys of the form $limit_field in the case of non-null, we expect $reportformfield to be of the form "$reportform+$field" and then the keys are of the form "limit_value_FORM_{$reportform}_FIELD_{$field}_LIMIT_{$style}_VALUE_{$field}"; 2=>boolean $strict. which defaults to true. if true we check that the key is in $vals and if not, return error.

  • Defined in i2ce/modules/Forms/modules/FormLimits/lib/I2CE_Module_FormLimits.php on line 643
  • Signature: protected function PROCESS_generic($style,$fieldObj,$vals,$strict)
  • Parameters:
    • string $style
      The style
    • I2CE_FormField $fieldObj
      the object the fuzzy method was called on
    • $vals
      • Default Value: array()
    • $strict
      • Default Value: true
  • Returns: mixed.
    false on failure. on sucess an array of relevant values for this limit style. The keys are the short version of the keys e.g. 'max' instead of 'limit_value_FORM_person_FIELD_password_LIMIT_between'

__call()

_hasMethod()

action_initialize()

Method called before the module is enabled for the first time. @param boolean -- returns true on success. false on error.

addDateTimeElements()

checkDateFromVals()

checkDateLimit()

checkDateLimitString()

checkLimit()

Checks a limit expression for a field based on limit data

checkLimitString_BOOL_false()

checkLimitString_BOOL_true()

checkLimitString_BOOL_truefalse()

checkLimitString_DB_INT_between()

checkLimitString_DB_INT_greaterthan()

checkLimitString_DB_INT_greaterthan_equals()

checkLimitString_DB_INT_in()

checkLimitString_DB_INT_lessthan()

checkLimitString_DB_STRING_between()

checkLimitString_DB_STRING_contains()

checkLimitString_DB_STRING_equals()

checkLimitString_DB_STRING_greaterthan()

checkLimitString_DB_STRING_greaterthan_equals()

checkLimitString_DB_STRING_in()

checkLimitString_DB_STRING_lessthan()

checkLimitString_DB_STRING_like()

checkLimitString_DB_STRING_lowerequals()

checkLimitString_DB_STRING_lowerlike()

checkLimitString_DB_TEXT_between()

checkLimitString_DB_TEXT_contains()

checkLimitString_DB_TEXT_equals()

checkLimitString_DB_TEXT_greaterthan()

checkLimitString_DB_TEXT_greaterthan_equals()

checkLimitString_DB_TEXT_in()

checkLimitString_DB_TEXT_lessthan()

checkLimitString_DB_TEXT_lessthan_equals()

checkLimitString_DB_TEXT_like()

checkLimitString_DB_TEXT_lowerequals()

checkLimitString_DB_TEXT_lowerlike()

checkLimitString_YESNO_no()

checkLimitString_YESNO_yes()

checkLimitString_YESNO_yesno()

checkLimitString_greaterthan_now()

checkLimitString_lessthan_now()

checkLimitString_not_null()

checkLimitString_null()

checkLimitString_null_not_null()

checkLimit_BOOL_false()

checkLimit_BOOL_true()

checkLimit_BOOL_truefalse()

checkLimit_DB_DATE_in()

checkLimit_DB_INT_between()

checkLimit_DB_INT_equals()

checkLimit_DB_INT_greaterthan()

checkLimit_DB_INT_greaterthan_equals()

checkLimit_DB_INT_in()

checkLimit_DB_INT_lessthan()

checkLimit_DB_INT_lessthan_equals()

checkLimit_DB_STRING_between()

checkLimit_DB_STRING_contains()

checkLimit_DB_STRING_equals()

checkLimit_DB_STRING_greaterthan()

checkLimit_DB_STRING_greaterthan_equals()

checkLimit_DB_STRING_in()

checkLimit_DB_STRING_lessthan()

checkLimit_DB_STRING_lessthan_equals()

checkLimit_DB_STRING_like()

checkLimit_DB_STRING_lowerequals()

checkLimit_DB_STRING_lowerlike()

checkLimit_DB_TEXT_between()

checkLimit_DB_TEXT_contains()

checkLimit_DB_TEXT_equals()

checkLimit_DB_TEXT_greaterthan()

checkLimit_DB_TEXT_greaterthan_equals()

checkLimit_DB_TEXT_in()

checkLimit_DB_TEXT_lessthan()

checkLimit_DB_TEXT_lessthan_equals()

checkLimit_DB_TEXT_like()

checkLimit_DB_TEXT_lowerequals()

checkLimit_DB_TEXT_lowerlike()

checkLimit_YESNO_no()

checkLimit_YESNO_yes()

checkLimit_YESNO_yesno()

checkLimit_greaterthan_now()

checkLimit_lessthan_now()

checkLimit_not_null()

checkLimit_null()

checkLimit_null_not_null()

checkWhereClause()

The worker method that recurses down the where clause data to make the query. Walks down the where clause data create the WHERE query it defined.

checkeLimitString_DB_DATE_in()

createCheckFunction()

Create a check function based on the where data. The function takes on argument which is an array indexed by the field names and with values the value of the field. @param I2CE_Form $form @param callback $field_refernece_callback. A callback function whose first arguement is the form, the second arguements is the field and which returns the way the field value should be references as a field. If the callback is null (the default) then the reference used is $data["$field']

  • Defined in i2ce/modules/Forms/modules/FormLimits/lib/I2CE_Module_FormLimits.php on line 991
  • Signature: public function createCheckFunction($formObj,$expr,$field_reference_callback,$func_args)
  • Parameters:
    • $formObj
    • mixed $expr
      array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data.
    • $field_reference_callback
      • Default Value: null
    • string $func_args
      Defaults to $data
      • Default Value: '$data'
  • Returns: false
    on failure a funciton on sucess.

createCheckFunctionString()

Create a check function boolean expression based on the where data. The function takes on argument which is an array indexed by the field names and with values the value of the field. @param I2CE_Form $form @param callback $field_refernece_callback. A callback function whose first arguement is the form, the second arguements is the field and which returns the way the field value should be references as a field. If the callback is null (the default) then the reference used is $data["$field']

  • Defined in i2ce/modules/Forms/modules/FormLimits/lib/I2CE_Module_FormLimits.php on line 1022
  • Signature: public function createCheckFunctionString($formObj,$expr,$field_reference_callback)
  • Parameters:
    • $formObj
    • mixed $expr
      array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data.
    • $field_reference_callback
      • Default Value: null
  • Returns: false
    on failure a string to which can be evalued as true/false on success.

createCheckLimitString()

Checks a limit boolean expression for a field based on limit data @param callback $field_refernece_callback. A callback function whose first arguement is the form, the second arguements is the field and which returns the way the field value should be references as a field. If the callback is null (the default) then the reference used is $data["$field']

createLimitString_DB_INT_equals()

generateDateLimit()

generateFieldLimit()

generateLimit()

Generates a limit expression for a field based on limit data @param callback $field_refernece_callback. A callback function whose first arguement is the form, the second arguements is the field and which returns the way the field value should be references as a field. If the callback is null (the default) then the reference used is "$form+$field"

generateLimit_BOOL_false()

generateLimit_BOOL_true()

generateLimit_BOOL_truefalse()

generateLimit_DB_DATE_in()

generateLimit_DB_INT_between()

generateLimit_DB_INT_equals()

generateLimit_DB_INT_greaterthan()

generateLimit_DB_INT_greaterthan_equals()

generateLimit_DB_INT_in()

generateLimit_DB_INT_lessthan()

generateLimit_DB_INT_lessthan_equals()

generateLimit_DB_STRING_between()

generateLimit_DB_STRING_contains()

generateLimit_DB_STRING_equals()

generateLimit_DB_STRING_greaterthan()

generateLimit_DB_STRING_greaterthan_equals()

generateLimit_DB_STRING_in()

generateLimit_DB_STRING_lessthan()

generateLimit_DB_STRING_lessthan_equals()

generateLimit_DB_STRING_like()

generateLimit_DB_STRING_lowerequals()

generateLimit_DB_STRING_lowerlike()

generateLimit_DB_TEXT_between()

generateLimit_DB_TEXT_contains()

generateLimit_DB_TEXT_equals()

generateLimit_DB_TEXT_greaterthan()

generateLimit_DB_TEXT_greaterthan_equals()

generateLimit_DB_TEXT_in()

generateLimit_DB_TEXT_lessthan()

generateLimit_DB_TEXT_lessthan_equals()

generateLimit_DB_TEXT_like()

generateLimit_DB_TEXT_lowerequals()

generateLimit_DB_TEXT_lowerlike()

generateLimit_YESNO_no()

generateLimit_YESNO_yes()

generateLimit_YESNO_yesno()

generateLimit_greaterthan_now()

generateLimit_lessthan_now()

generateLimit_max_parent()

generateLimit_max_parent_form()

generateLimit_min_parent()

generateLimit_min_parent_form()

generateLimit_not_null()

generateLimit_null()

generateLimit_null_not_null()

generateWhereClause()

The worker method that recurses down the where clause data to make the query. Walks down the where clause data create the WHERE query it defined. @param callback $field_refernece_callback. A callback function whose first arguement is the form, the second arguements is the field and which returns the way the field value should be references as a field. If the callback is null (the default) then the reference used is "$form+$field"

getDateLimitMenu()

getFieldLimitStyles()

getLimitStyles()

getMethods()

processDateLimitMenu()

Inherited Methods

__construct()

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

action_configure()

This public method is inherited from I2CE_Module->action_configure()

action_disable()

This public method is inherited from I2CE_Module->action_disable()

action_enable()

This public method is inherited from I2CE_Module->action_enable()

getCLIHooks()

This public method is inherited from I2CE_Module->getCLIHooks()

getCLIMethods()

This public method is inherited from I2CE_Module->getCLIMethods()

getConfig()

This public method is inherited from I2CE_Module->getConfig()

getHooks()

This public method is inherited from I2CE_Module->getHooks()

post_update()

This public method is inherited from I2CE_Module->post_update()

pre_upgrade()

This public method is inherited from I2CE_Module->pre_upgrade()

upgrade()

This public method is inherited from I2CE_Module->upgrade()

Inherited Fuzzy Methods

launchBackgroundProcess()

This method is inherited from I2CE_Module->launchBackgroundProcess()

launchBackgroundPHPScript()

This method is inherited from I2CE_Module->launchBackgroundPHPScript()

launchBackgroundPage()

This method is inherited from I2CE_Module->launchBackgroundPage()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_Module_FormLimits_(4.0.3)&oldid=13182"