Docs For Class RuleSet

Description

a RuleSet allows a user to define a number of keys each with associated rules and errors

Variable Summary

array $_rules

Method Summary

void RuleSet ()

void addRule (string $key, ref $rule, [optional $message = null], [mixed $type = ''])

int count ()

array getKeys ()

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

Variables

array $_rules (line 30)

an associative array of keys and associated rules

the format of the array is this: [key1]=>array( $rule1, $error1), array( $rule2, $error2), ... [key2]=>...

Methods

Constructor RuleSet (line 38)

the constructor

void RuleSet ()

addRule (line 50)

adds a new $rule to $key, which if fails when validated throws $error

void addRule (string $key, ref $rule, [optional $message = null], [mixed $type = ''])

count (line 111)

returns the number of keys with rules

int count ()

getKeys (line 100)

returns an array of keys

array getKeys ()

validate (line 70)

validates $val against the rules defined for $key. if validation fails the associated error is thrown

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

string $key: the key to look at for rules
mixed $val: the value to check against the rules
optional $throwErrors: boolean $throwErrors Should we throw the specified errors if validation fails or just return true/false. Default = TRUE.