FormValidatorCustom Class Reference
[Form_validation]
Form validation check with a custom user function performing the validation check.
More...
Public Member Functions | |
| FormValidatorCustom (&$form, $field, $type, $message, $userFunction, $additionalArguments=array(), $complementReturn=false) | |
| isValid () | |
Public Attributes | |
| $additionalArguments | |
| $complementReturn | |
| $userFunction | |
Detailed Description
Form validation check with a custom user function performing the validation check.Definition at line 20 of file FormValidatorCustom.inc.php.
Member Function Documentation
| FormValidatorCustom.FormValidatorCustom | ( | &$ | form, | |
| $ | field, | |||
| $ | type, | |||
| $ | message, | |||
| $ | userFunction, | |||
| $ | additionalArguments = array(), |
|||
| $ | complementReturn = false | |||
| ) |
Constructor. The user function is passed the form data as its first argument and $additionalArguments, if set, as the remaining arguments. This function must return a boolean value.
- See also:
- FormValidator.FormValidator()
- Parameters:
-
$userFunction function the user function to use for validation $additionalArguments array optional, a list of additional arguments to pass to $userFunction $complementReturn boolean optional, complement the value returned by $userFunction
Definition at line 39 of file FormValidatorCustom.inc.php.
References $additionalArguments, $complementReturn, FormValidator.$field, FormValidator.$form, FormValidator.$message, FormValidator.$type, and $userFunction.
| FormValidatorCustom.isValid | ( | ) |
Check if field value is valid. Value is valid if it is empty and optional or validated by user-supplied function.
- Returns:
- boolean
Reimplemented from FormValidator.
Definition at line 51 of file FormValidatorCustom.inc.php.
References FormValidator.isEmptyAndOptional().
Member Data Documentation
| FormValidatorCustom.$additionalArguments |
Additional arguments to pass to $userFunction
Definition at line 26 of file FormValidatorCustom.inc.php.
Referenced by FormValidatorCustom().
| FormValidatorCustom.$complementReturn |
If true, field is considered valid if user function returns false instead of true
Definition at line 29 of file FormValidatorCustom.inc.php.
Referenced by FormValidatorCustom().
| FormValidatorCustom.$userFunction |
Custom validation function
Definition at line 23 of file FormValidatorCustom.inc.php.
Referenced by FormValidatorCustom().
The documentation for this class was generated from the following file:
- classes/form/validation/FormValidatorCustom.inc.php
