Docs For Class ExtendsValidatorRule

Description

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

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

ValidatorRuleInterface
   |
   --ExtendsValidatorRule

Variable Summary

mixed $_parentClassName

Method Summary

void ExtendsValidatorRule (string $parentClassName)

boolean check (mixed $val)

object ValidatorRule getRule (string $parentClassName)

string getRuleKey ()

Variables

mixed $_parentClassName (line 26)

The name of the parent class.

The name of the parent class. Will check whether the given object extends this parent class.

access: private

Methods

Constructor ExtendsValidatorRule (line 35)

The constructor.

access: public

void ExtendsValidatorRule (string $parentClassName)

string $parentClassName: The name of the parent class. Will check whether the given object extends this parent class.

check (line 47)

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

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 $parentClassName)

string $parentClassName: The name of the parent class. Will check whether the given object extends this parent class.

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

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