Docs For Class FieldSetValidator

Description

the FieldSetValidator takes a FieldSet and a RuleSet and validates values between the two

version: $Id: FieldSetValidator.class.php,v 1.5 2007/09/04 20:25:55 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Variable Summary

Method Summary

void FieldSetValidator (object FieldSet $fieldset, object RuleSet $ruleset)

void setFieldSet (object FieldSet $fieldset)

void setRuleSet (object RuleSet $ruleset)

boolean validate (string $key, [optional $throwErrors = true])

boolean validateAll ([optional $throwErrors = true])

Variables

object FieldSet $_fieldset (line 24)

the FieldSet object

object RuleSet $_ruleset (line 32)

the RuleSet object

Methods

Constructor FieldSetValidator (line 42)

the constructor

void FieldSetValidator (object FieldSet $fieldset, object RuleSet $ruleset)

setFieldSet (line 54)

sets the fieldset object to use to $fieldset

void setFieldSet (object FieldSet $fieldset)

setRuleSet (line 65)

sets the ruleset object to use to $ruleset

void setRuleSet (object RuleSet $ruleset)

validate (line 78)

validates the value of $key against the rules defined for it

boolean validate (string $key, [optional $throwErrors = true])

string $key: the key to validate
optional $throwErrors: boolean $throwErrors Should we throw the specified errors if validation fails or just return true/false. Default = TRUE.

validateAll (line 94)

validates all defined keys in the FieldSet against those in the RuleSet

boolean validateAll ([optional $throwErrors = true])

optional $throwErrors: boolean $throwErrors Should we throw the specified errors if validation fails or just return true/false. Default = TRUE.