Class: I2CE Module FormLimits (Development)

For other versions, see Class: I2CE_Module_FormLimits (versions) .

This article describes the class I2CE_Module_FormLimits .

• Extends the class: I2CE_Module.
• Location: Part of the module form-limits in the package I2CE 4.0-dev
• Source: Defined in the file modules/Forms/modules/FormLimits/lib/I2CE_Module_FormLimits.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v4.0.6

@filesource Class I2CE_Module_FormLimits

Variables

$checkOperatorMap

• Defined in i2ce/modules/Forms/modules/FormLimits/lib/I2CE_Module_FormLimits.php on line 254
• Type: static protected $checkOperatorMap

Methods

action_initialize()

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

• Defined in i2ce/modules/Forms/modules/FormLimits/lib/I2CE_Module_FormLimits.php on line 39
• Signature: public function action_initialize()

checkLimit()

Checks a limit expression for a field based on limit data

• Defined in i2ce/modules/Forms/modules/FormLimits/lib/I2CE_Module_FormLimits.php on line 101
• Signature: public function checkLimit($formObj,$limit_data)
• Parameters:
  • I2CE_Form $formObj
  • mixed $limit_data array.
    • Default Value: array()
• Returns: boolean
  or null on failure

checkWhereClause()

The implementation of the fuzzy method to check that a where clause is satisfied by the given form Walks down the where clause data create the WHERE query it defined.

• Defined in i2ce/modules/Forms/modules/FormLimits/lib/I2CE_Module_FormLimits.php on line 144
• Signature: public function checkWhereClause($formObj,$expr)
• Parameters:
  • I2CE_Form $formObj
  • mixed $expr
    array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data.
• Returns: boolean,
  null on failure

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 240
• 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 271
• 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']

• Defined in i2ce/modules/Forms/modules/FormLimits/lib/I2CE_Module_FormLimits.php on line 369
• Signature: public function createCheckLimitString($formObj,$limit_data,$field_reference_callback)
• Parameters:
  • I2CE_Form $formObj
  • mixed $limit_data array.
    • Default Value: array()
  • $field_reference_callback
    • Default Value: null
• Returns: string
  or false on failure

generateLimit()

Generates a limit expression for a form based on limit data. Called by {generateWhereClause()} @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"

• Defined in i2ce/modules/Forms/modules/FormLimits/lib/I2CE_Module_FormLimits.php on line 424
• Signature: public function generateLimit($formObj,$limit_data,$field_reference_callback,$parent_ref)
• Parameters:
  • I2CE_Form $formObj
  • mixed $limit_data array.
    • Default Value: array()
  • $field_reference_callback
    • Default Value: null
  • string $parent_ref
    Defaults to null. If not null, it is the referent to the parent id of the form
    • Default Value: null
• Returns: string
  SQL statement false on failure

generateWhereClause()

The implementation of the fuzzy method that recurses down the where clause data to make the limit part of a SQL 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"

• Defined in i2ce/modules/Forms/modules/FormLimits/lib/I2CE_Module_FormLimits.php on line 463
• Signature: public function generateWhereClause($formObj,$expr,$field_reference_callback,$parent_ref)
• Parameters:
  • I2CE_Form $formObj
  • mixed $expr
    array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data.
  • $field_reference_callback
    • Default Value: null
  • string $parent_ref
    Defaults to null. If not null, it is the referent to the parent id of the form
    • Default Value: null
• Returns: SQL
  statement, false on failure

getLimitStyles()

Implementation of fuzzy method on a I2CE_FormObject to determine what are the limit styles for a given field

• Defined in i2ce/modules/Forms/modules/FormLimits/lib/I2CE_Module_FormLimits.php on line 83
• Signature: public function getLimitStyles($formObj,$field)
• Parameters:
  • I2CE_Form $formObj
  • string $field
    The name of a field of {$formObj}
• Returns: array

getMethods()

The 'fuzzy' methods that this module implements.

• Defined in i2ce/modules/Forms/modules/FormLimits/lib/I2CE_Module_FormLimits.php on line 62
• Signature: static public function getMethods()
• Returns: an
  associative array.

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

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

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