FormValidatorArrayCustom Class Reference
[Form_validation]
Form validation check with a custom user function performing the validation check of an array of fields.
More...
Public Member Functions | |
| FormValidatorArrayCustom (&$form, $field, $type, $message, $userFunction, $additionalArguments=array(), $complementReturn=false, $fields=array(), $isLocaleField=false) | |
| getErrorFields () | |
| isArray () | |
| isLocaleField () | |
| isValid () | |
Public Attributes | |
| $additionalArguments | |
| $complementReturn | |
| $userFunction | |
Detailed Description
Form validation check with a custom user function performing the validation check of an array of fields.Definition at line 20 of file FormValidatorArrayCustom.inc.php.
Member Function Documentation
| FormValidatorArrayCustom.FormValidatorArrayCustom | ( | &$ | form, | |
| $ | field, | |||
| $ | type, | |||
| $ | message, | |||
| $ | userFunction, | |||
| $ | additionalArguments = array(), |
|||
| $ | complementReturn = false, |
|||
| $ | fields = array(), |
|||
| $ | isLocaleField = false | |||
| ) |
Constructor.
- See also:
- FormValidator.FormValidator()
- Parameters:
-
$field string field name specifying an array of fields, i.e. name[] $fields array all subfields for each item in the array, i.e. name[][foo]. If empty it is assumed that name[] is a data field
Definition at line 46 of file FormValidatorArrayCustom.inc.php.
References $additionalArguments, $complementReturn, FormValidator.$field, FormValidator.$form, FormValidator.$message, FormValidator.$type, $userFunction, and isLocaleField().
| FormValidatorArrayCustom.getErrorFields | ( | ) |
Get array of fields where an error occurred.
- Returns:
- array
Definition at line 109 of file FormValidatorArrayCustom.inc.php.
| FormValidatorArrayCustom.isArray | ( | ) |
Is the field an array.
- Returns:
- boolean
Definition at line 117 of file FormValidatorArrayCustom.inc.php.
| FormValidatorArrayCustom.isLocaleField | ( | ) |
Is it a multilingual-capable field.
- Returns:
- boolean
Definition at line 125 of file FormValidatorArrayCustom.inc.php.
Referenced by FormValidatorArrayCustom(), and isValid().
| FormValidatorArrayCustom.isValid | ( | ) |
Check if field value is valid. Value is valid if it is empty and optional or is in the set of accepted values.
- Returns:
- boolean
Reimplemented from FormValidator.
Definition at line 61 of file FormValidatorArrayCustom.inc.php.
References FormValidator.$field, and isLocaleField().
Member Data Documentation
| FormValidatorArrayCustom.$additionalArguments |
Additional arguments to pass to $userFunction
Definition at line 35 of file FormValidatorArrayCustom.inc.php.
Referenced by FormValidatorArrayCustom().
| FormValidatorArrayCustom.$complementReturn |
If true, field is considered valid if user function returns false instead of true
Definition at line 38 of file FormValidatorArrayCustom.inc.php.
Referenced by FormValidatorArrayCustom().
| FormValidatorArrayCustom.$userFunction |
Custom validation function
Definition at line 32 of file FormValidatorArrayCustom.inc.php.
Referenced by FormValidatorArrayCustom().
The documentation for this class was generated from the following file:
- classes/form/validation/FormValidatorArrayCustom.inc.php
