Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitModelSetValidator

Core::Model::arbitModelSetValidator

Class arbitModelSetValidator

Set validator class

Set validator class

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

Member Variables

protected array $set = array()
Allowed values for the validator.

Allowed values for the validator.

Method Summary

public void configure( [ $set = array()] )
Configure validator The array validator should be configured with an array, which contains the allowed values.
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( [ $set = array()] )

Configure validator The array validator should be configured with an array, which contains the allowed values.

Configure validator The array validator should be configured with an array, which contains the allowed values.

Parameters:
Name Type Description
$set array
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:18 +0200 by phpDocumentor 1.4.3