Framework  3.9
RequiredBooleanValidator Class Reference

RequiredBoolean Validator. More...

+ Inheritance diagram for RequiredBooleanValidator:
+ Collaboration diagram for RequiredBooleanValidator:

Public Member Functions

 RequiredBooleanValidator ($field, $title, $msg="")
 
 writeClient ()
 
- Public Member Functions inherited from RequiredValidator
 RequiredValidator ($field, $title, $empty="", $checkDisplayNone=true)
 
 validate ()
 
- Public Member Functions inherited from AbstractValidator
 AbstractValidator ($field, $title)
 

Public Attributes

 $msg
 
- Public Attributes inherited from RequiredValidator
 $empty = ""
 
 $checkDisplayNone = true
 
- Public Attributes inherited from AbstractValidator
 $field
 
 $title
 

Detailed Description

RequiredBoolean Validator.

Verifies single checkbox (Boolean renderer) is checked. While it would seem unnecessary to have a checkbox that must be checked, it is useful for "agree to the terms" fields.

Add this validator the the script using: $form->validator->add(new RequiredBooleanValidator($field, $label, $empty));

Definition at line 1244 of file validation.inc.

Member Function Documentation

◆ RequiredBooleanValidator()

RequiredBooleanValidator::RequiredBooleanValidator (   $field,
  $title,
  $msg = "" 
)

Definition at line 1248 of file validation.inc.

1249  {
1250  $this->AbstractValidator($field, $title);
1251  $this->msg = ($msg) ? $msg : $title . " is a required field.";
1252  }
AbstractValidator($field, $title)
Definition: validation.inc:53

◆ writeClient()

RequiredBooleanValidator::writeClient ( )

Reimplemented from RequiredValidator.

Definition at line 1254 of file validation.inc.

1255  {
1256 $script = <<<ENDSCRIPT
1257 
1258  var boolObj = form["{$this->field}"];
1259 
1260  if (boolObj.checked == false)
1261  {
1262  alert("{$this->msg}");
1263  return false;
1264  }
1265 
1266 
1267 ENDSCRIPT;
1268 
1269  return $script;
1270  }

Member Data Documentation

◆ $msg

RequiredBooleanValidator::$msg

Definition at line 1246 of file validation.inc.


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