Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitModelObjectValidator

Packages:

Interfaces:

Classes:

Core::Model::arbitModelObjectValidator

[ Index ] [ Core classes ] [ Core elements ] [ All elements ] [ Errors ]

Class arbitModelObjectValidator

Object validator class

Object validator class

arbitModelValidatorBase
   |
   --arbitModelObjectValidator
Author(s):
Version:   $Revision: 1236 $
License:   GPL

Member Variables

protected string $className
Name of class, which should be inherited by the object.

Name of class, which should be inherited by the object.

Method Summary

public void configure( [ $className = null] )
Configure validator The object validator will optionally take a class name, which causes the passed objects are checked that they inherit from the specified class.
public mixed validate( $name , $value , $expectation )
Validate value Validates the given input. validation constraints and throws a arbitPropertyValidationException exception otherwise.

Inherited Methods

From arbitModelValidatorBase
public void arbitModelValidatorBase::configure()
Configure validator Method to configure the validator, if it requires configuration at all.
public static void arbitModelValidatorBase::create()
Create validator.
public abstract mixed arbitModelValidatorBase::validate()
Validate value Validates the given input. validation constraints and throws a arbitPropertyValidationException exception otherwise.

Methods

configure

void configure( [string $className = null] )

Configure validator The object validator will optionally take a class name, which causes the passed objects are checked that they inherit from the specified class.

Configure validator The object validator will optionally take a class name, which causes the passed objects are checked that they inherit from the specified class.

Parameters:
Name Type Description
$className string
Redefinition of:
Method Description
arbitModelValidatorBase::configure() Configure validator Method to configure the validator, if it requires configuration at all.

validate

mixed validate( string $name , mixed $value , string $expectation )

Validate value Validates the given input. validation constraints and throws a arbitPropertyValidationException exception otherwise.

Validate value Validates the given input. Returns the input, when it matches the validation constraints and throws a arbitPropertyValidationException exception otherwise. The name and expectation paramters are used to generate a better user error message. The name should be the name of the property, and the expectation should be a string somehow describing what kind of content was expected from validation.

Parameters:
Name Type Description
$name string
$value mixed
$expectation string
Exceptions:
Type Description
arbitPropertyValue If validation constraints are not met.
Redefinition of:
Method Description
arbitModelValidatorBase::validate() Validate value Validates the given input. validation constraints and throws a arbitPropertyValidationException exception otherwise.
Documentation generated on Mon, 05 Apr 2010 14:02:07 +0200 by phpDocumentor 1.4.3

Arbit - project tracking, licensed under GPL 3