Open Journal Systems  3.3.0
FormValidatorCustom Class Reference
Inheritance diagram for FormValidatorCustom:
FormValidator

Public Member Functions

 __construct (&$form, $field, $type, $message, $userFunction, $additionalArguments=array(), $complementReturn=false, $messageArgs=array())
 
 getMessage ()
 
 isValid ()
 
- Public Member Functions inherited from FormValidator
 __construct (&$form, $field, $type, $message, $validator=null)
 
 getField ()
 
 getFieldValue ()
 
getForm ()
 
 getType ()
 
getValidator ()
 
 isEmptyAndOptional ()
 

Data Fields

 $_additionalArguments
 
 $_complementReturn
 
 $_userFunction
 
- Data Fields inherited from FormValidator
 $_field
 
 $_form
 
 $_message
 
 $_type
 
 $_validator
 

Detailed Description

Form validation check with a custom user function performing the validation check.

Definition at line 18 of file FormValidatorCustom.inc.php.

Constructor & Destructor Documentation

◆ __construct()

FormValidatorCustom::__construct ( $form,
  $field,
  $type,
  $message,
  $userFunction,
  $additionalArguments = array(),
  $complementReturn = false,
  $messageArgs = array() 
)

Definition at line 53 of file FormValidatorCustom.inc.php.

Member Function Documentation

◆ getMessage()

FormValidatorCustom::getMessage ( )
See also
FormValidator::getMessage()
Returns
string

Reimplemented from FormValidator.

Definition at line 69 of file FormValidatorCustom.inc.php.

◆ isValid()

FormValidatorCustom::isValid ( )
See also
FormValidator::isValid() Value is valid if it is empty and optional or validated by user-supplied function.
Returns
boolean

Reimplemented from FormValidator.

Definition at line 82 of file FormValidatorCustom.inc.php.

References FormValidator\getFieldValue(), and FormValidator\isEmptyAndOptional().

Field Documentation

◆ $_additionalArguments

array FormValidatorCustom::$_additionalArguments

Additional arguments to pass to $userFunction

Definition at line 30 of file FormValidatorCustom.inc.php.

◆ $_complementReturn

boolean FormValidatorCustom::$_complementReturn

If true, field is considered valid if user function returns false instead of true

Definition at line 36 of file FormValidatorCustom.inc.php.

◆ $_userFunction

callable FormValidatorCustom::$_userFunction

Custom validation function

Definition at line 24 of file FormValidatorCustom.inc.php.


The documentation for this class was generated from the following file: