ValidationEngine Class Reference

The ValidationEngine takes an array of validator objects in its constructor, and is then able to generate both client- and server-side validation for HTML forms. More...

Public Member Functions
	ValidationEngine ()
	Create a new ValidationEngine. More...
	writeScript ()
	Output the client-side form validation function, based on all the validators that have been added. More...
	add ()
	Add a validator. More...
	getValidator ($field, $class)
	Get the specified validator by field and class. More...
	getValidators ($field)
	Get the validators attached to a specific field. More...
	validate ()
	Perform server-side validation of the posted form values. More...
	isRequired ($field)
	Checks to see whether the specified field has a RequiredValidator attached to it. More...
	hasRequiredFields ()
	Checks to see whether any fields have been marked as required. More...

Public Attributes
	$validators = array()
	The array of validators making up this validation engine. More...
	$msg = ""
	Validation error messages accumulator;. More...
	$id = ""
	The ID of this validator. More...
	$generateScript = true
	Specifies whether to generate client-side validation script. More...

Detailed Description

The ValidationEngine takes an array of validator objects in its constructor, and is then able to generate both client- and server-side validation for HTML forms.

Definition at line 1557 of file validation.inc.

Member Function Documentation

add()

ValidationEngine::add

(

)

Add a validator.

Definition at line 1606 of file validation.inc.

     {
          foreach(func_get_args() as $v)
          {
               $this->validators[] = $v;
          }
     }

getValidator()

ValidationEngine::getValidator	(		$field,
			$class
	)

Get the specified validator by field and class.

Parameters

unknown_type	$field	the validator's field
unknown_type	$class	the validator's class

Definition at line 1619 of file validation.inc.

     {
          foreach($this->validators as $v)
          {
               if ($v->field == $field && get_class($v) == $class)
               {
                    return $v;
               }
          }
          
          return null;
     }

getValidators()

ValidationEngine::getValidators

(

$field

)

Get the validators attached to a specific field.

Parameters

$field

the field

Definition at line 1636 of file validation.inc.

     {
          $vals = array();
          foreach($this->validators as $v)
          {
               if ($v->field == $field)
               {
                    $vals[] = $v;
               }
          }
          
          return $vals;
     }

hasRequiredFields()

ValidationEngine::hasRequiredFields

(

)

Checks to see whether any fields have been marked as required.

Returns

true if there is at least one required field, false if no fields are required.

Definition at line 1692 of file validation.inc.

     {
          foreach($this->validators as $v)
          {
               if (get_class($v) == RequiredValidator) return true;
          }
          
          return false;
     }

isRequired()

ValidationEngine::isRequired

(

$field

)

Checks to see whether the specified field has a RequiredValidator attached to it.

Parameters

$field

the field to check

Returns

true if the field is required, false if it is optional

Definition at line 1678 of file validation.inc.

     {
          foreach($this->validators as $v)
          {
               if ($v->field == $field && get_class($v) == RequiredValidator) return true;
          }
          
          return false;
     }

validate()

ValidationEngine::validate

(

)

Perform server-side validation of the posted form values.

The msg field of the ValidationEngine accumulates all the error messages raised by the individual validators.

Returns

true if the form data is valid for all validators, false if one or more fields contain invalid data.

Definition at line 1655 of file validation.inc.

     {
          $result = "";
          
          foreach($this->validators as $v)
          {
               $msg = $v->validate();
               if ($msg)
               {
                    $result .= $msg."<br>";
               }
          }
          
          $this->msg = $msg;
          
          return $result;
     }

ValidationEngine()

ValidationEngine::ValidationEngine

(

)

Create a new ValidationEngine.

Definition at line 1567 of file validation.inc.

     {
          $this->validators = func_get_args();
     }

writeScript()

ValidationEngine::writeScript

(

)

Output the client-side form validation function, based on all the validators that have been added.

Definition at line 1575 of file validation.inc.

     {
          $suffix = ($this->id) ? "_{$this->id}" : "";
          
          $script = <<<ENDSCRIPT
 
function validate{$suffix}(form)
{
ENDSCRIPT;
 
          if ($this->generateScript)
          { 
               foreach($this->validators as $v)
               {
                    $script .= $v->writeClient();
               }
          }
                    
          $script .= <<<ENDSCRIPT
 
     return true;
}
          
ENDSCRIPT;
 
          return $script;
     }

Member Data Documentation

$generateScript

ValidationEngine::$generateScript = true

Specifies whether to generate client-side validation script.

Definition at line 1562 of file validation.inc.

$id

ValidationEngine::$id = ""

The ID of this validator.

Definition at line 1561 of file validation.inc.

$msg

ValidationEngine::$msg = ""

Validation error messages accumulator;.

Definition at line 1560 of file validation.inc.

$validators

ValidationEngine::$validators = array()

The array of validators making up this validation engine.

Definition at line 1559 of file validation.inc.

---

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

• C:/code/cms.sonjara.com/framework/validation.inc