Docs For Class ActiveRecord

Description

ActiveRecord_Validation is an interface for objects that can perform validations on an ActiveRecord instance. One instance of an ActiveRecord_Validation may have validate invoked for multiple ActiveRecord instances.

abstract:

Located in /activerecord/lib/ActiveRecord/Validation.php (line 18)

Direct descendents

Class	Description
ActiveRecord_Association_BelongsToKeyValidation	A validation for the foreign key field on a belongs_to relationship
ActiveRecord_ConfirmationValidation	A validation to check that a confirmation attribute for an
ActiveRecord_PresentValidation	A validation to check that an attribute is non-empty (as determined by the PHP function empty()).
ActiveRecord_BoundsValidation	A validation to check that an attribute's string length is within a certain range.
ActiveRecord_UniqueValidation	A validation to check that an attribute's value is unique.
ActiveRecord_RegExValidation	A validation to check that an attribute's value conforms to a regular expression.
ActiveRecord_SetValidation	A validation to check that an attribute's value is contained in a specified list.
ActiveRecord_NumericValidation	A validation to check that an attribute's value is numeric.

Class Constant Summary

ON_CREATE = 2

ON_SAVE = 1

ON_UPDATE = 3

Variable Summary

mixed $condition

mixed $type

Method Summary

ActiveRecord_Validation __construct ([int $type = ActiveRecord_Validation::ON_SAVE], [string $condition = false])

bool should_validate (ActiveRecord_Base $obj)

void validate (ActiveRecord_Base $obj)

Variables

mixed $condition (line 41)

Optional condition method for determining whether or not to run

the validation

access: protected

mixed $type (line 35)

Validation type. One of ON_SAVE, ON_CREATE, or ON_UPDATE.

access: public

Methods

Constructor __construct (line 49)

Constructor

access: public

ActiveRecord_Validation __construct ([int $type = ActiveRecord_Validation::ON_SAVE], [string $condition = false])

int $type: The validation type (ON_SAVE, ON_CREATE, or ON_UPDATE)
string $condition: Optional method to call for determining whether to run the validation or not

Redefined in descendants as:

ActiveRecord_Association_BelongsToKeyValidation::__construct() : Constructor
ActiveRecord_ConfirmationValidation::__construct() : Constructor
ActiveRecord_PresentValidation::__construct() : Constructor
ActiveRecord_BoundsValidation::__construct() : Constructor
ActiveRecord_UniqueValidation::__construct() : Constructor
ActiveRecord_RegExValidation::__construct() : Constructor
ActiveRecord_SetValidation::__construct() : Constructor
ActiveRecord_NumericValidation::__construct() : Constructor

should_validate (line 71)

Determine if the object should be validated or not based on the configured condition

access: public

bool should_validate (ActiveRecord_Base $obj)

ActiveRecord_Base $obj: The object to validate

validate (line 61)

Validate the object provided. If the object is invalid, it is the responsibility of this method to add any errors appropriate to the object's error collection.

abstract:
access: public

void validate (ActiveRecord_Base $obj)

ActiveRecord_Base $obj: The object to validate

Redefined in descendants as:

ActiveRecord_Association_BelongsToKeyValidation::validate() : Validate the object provided. If the object is invalid, it is the responsibility of this method to add any errors appropriate to the object's error collection.
ActiveRecord_ConfirmationValidation::validate() : Validate the object provided. If the object is invalid, it is the responsibility of this method to add any errors appropriate to the object's error collection.
ActiveRecord_PresentValidation::validate() : Validate the object provided. If the object is invalid, it is the responsibility of this method to add any errors appropriate to the object's error collection.
ActiveRecord_BoundsValidation::validate() : Validate the object provided. If the object is invalid, it is the responsibility of this method to add any errors appropriate to the object's error collection.
ActiveRecord_UniqueValidation::validate() : Validate the object provided. If the object is invalid, it is the responsibility of this method to add any errors appropriate to the object's error collection.
ActiveRecord_RegExValidation::validate() : Validate the object provided. If the object is invalid, it is the responsibility of this method to add any errors appropriate to the object's error collection.
ActiveRecord_SetValidation::validate() : Validate the object provided. If the object is invalid, it is the responsibility of this method to add any errors appropriate to the object's error collection.
ActiveRecord_NumericValidation::validate() : Validate the object provided. If the object is invalid, it is the responsibility of this method to add any errors appropriate to the object's error collection.

Class Constants

ON_CREATE = 2 (line 26)

Type for validations that run only on update

ON_SAVE = 1 (line 22)

Type for validations that always run

ON_UPDATE = 3 (line 30)

Type for validations that always run