Docs For Class OrValidatorRule

Description

the OrValidatorRule takes 2 other rules and validates if at least one of the 2 validates.

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

Located in /harmoni/core/utilities/FieldSetValidator/rules/OrValidatorRule.class.php (line 15)

ValidatorRuleInterface
   |
   --OrValidatorRule

Method Summary

void OrValidatorRule (object ValidatorRule $rule1, object ValidatorRule $rule2)

boolean check (mixed $val, mixed $rule1)

object ValidatorRule getRule (object ValidatorRule $rule1, object ValidatorRule $rule2)

string getRuleKey ()

Methods

Constructor OrValidatorRule (line 26)

the constructur

access: public

void OrValidatorRule (object ValidatorRule $rule1, object ValidatorRule $rule2)

object ValidatorRule $rule1: the first rule
object ValidatorRule $rule2: the second rule

check (line 39)

the OrValidatorRule takes 2 other rules and validates if at least one of the 2 validates.

return: TRUE, if the value is an integer; FALSE if it is not.
access: public

boolean check (mixed $val, mixed $rule1)

mixed $rule1: The first rule.

Redefinition of:

ValidatorRuleInterface::check(): checks a given value against the rule contained within the class

getRule (line 58)

This is a static method to return an already-created instance of a validator rule. There are at most about a hundred unique rule objects in use durring any given execution cycle, but rule objects are instantiated hundreds of thousands of times.

This method follows a modified Singleton pattern.

since: 3/28/05
static:
access: public

object ValidatorRule getRule (object ValidatorRule $rule1, object ValidatorRule $rule2)

object ValidatorRule $rule1: the first rule
object ValidatorRule $rule2: the second rule

Redefinition of:

ValidatorRuleInterface::getRule(): This is a static method to return an already-created instance of a validator rule. There are at most about a hundred unique rule objects in use durring any given execution cycle, but rule objects are instantiated hundreds of thousands of times.

getRuleKey (line 86)

Return a key that can be used to identify this Rule for caching purposes.

If this rule takes no arguments, the class name should be sufficient. otherwise, append the arguments.

This method should only be called by ValidatorRules.

since: 3/29/05
access: protected

string getRuleKey ()

Redefinition of:

ValidatorRuleInterface::getRuleKey(): Return a key that can be used to identify this Rule for caching purposes.

Inherited Methods

Inherited From ValidatorRuleInterface

ValidatorRuleInterface::check()
ValidatorRuleInterface::getRule()
ValidatorRuleInterface::getRuleKey()