Docs For Class HasMethodsValidatorRule

Description

The ExtendsValidatorRule checks if a given object is extends a given class.

version: $Id: HasMethodsValidatorRule.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/HasMethodsValidatorRule.class.php (line 15)

ValidatorRuleInterface
   |
   --HasMethodsValidatorRule

Variable Summary

array $_methods

Method Summary

void HasMethodsValidatorRule (string $methodName, optional 1)

boolean check (mixed $val)

object ValidatorRule getRule (string $methodName)

string getRuleKey ()

Variables

array $_methods (line 24)

The methods to check the existance of.

access: private

Methods

Constructor HasMethodsValidatorRule (line 33)

The constructor.

access: public

void HasMethodsValidatorRule (string $methodName, optional 1)

string $methodName: The name of the first method.
optional 1: string $methodName2 specify as man additional strings as needed.

check (line 45)

Checks that the given object extends a specified class.

return: TRUE, if the object extends the class; FALSE if it is not.
access: public

boolean check (mixed $val)

mixed $val: The value to check.

Redefinition of:

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

getRule (line 69)

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 (string $methodName)

string $methodName

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 93)

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()