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

Public Member Functions

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

Additional Inherited Members

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

Detailed Description

Form validation check that checks if the value can be interpreted as a boolean value. An empty field is considered 'false', a value of '1' is considered 'true'.

Definition at line 20 of file FormValidatorBoolean.inc.php.

Constructor & Destructor Documentation

◆ __construct()

FormValidatorBoolean::__construct ( $form,
  $field,
  $message 
)

Constructor.

Parameters
$formForm the associated form
$fieldstring the name of the associated field
$messagestring the error message for validation failures (i18n key)

Definition at line 27 of file FormValidatorBoolean.inc.php.

Member Function Documentation

◆ isValid()

FormValidatorBoolean::isValid ( )

Value is valid if it is empty (false) or has value '1' (true). This assumes checkbox behavior in the form.

See also
FormValidator::isValid()
Returns
boolean

Reimplemented from FormValidator.

Definition at line 42 of file FormValidatorBoolean.inc.php.

References FormValidator\getField(), FormValidator\getFieldValue(), and FormValidator\getForm().


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