Docs For Class ActiveRecord

Description

A validation to check that an attribute's value is contained in a specified list.

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

ActiveRecord_Validation
   |
   --ActiveRecord_SetValidation

Variable Summary

mixed $allowNull

mixed $attrNames

mixed $msg

mixed $testExistence

mixed $validValues

Method Summary

ActiveRecord_SetValidation __construct (array $attrNames, array $in, [bool $testInList = true], [string $msg = false], [bool $allowNull = false], [int $type = ActiveRecord_Validation::ON_SAVE], [string $condition = false])

void validate (ActiveRecord_Base $obj)

Variables

mixed $allowNull (line 426)

Flag indicating whether nulls are allowed

access: protected

mixed $attrNames (line 414)

List of attribute names to validate

access: protected

mixed $msg (line 418)

Error message to use

access: protected

mixed $testExistence (line 430)

Flag indicating type of test being performed

access: protected

mixed $validValues (line 422)

List to validate against

access: protected

Inherited Variables

Inherited from ActiveRecord_Validation

ActiveRecord_Validation::$condition
ActiveRecord_Validation::$type

Methods

Constructor __construct (line 443)

Constructor

access: public

ActiveRecord_SetValidation __construct (array $attrNames, array $in, [bool $testInList = true], [string $msg = false], [bool $allowNull = false], [int $type = ActiveRecord_Validation::ON_SAVE], [string $condition = false])

array $attrNames: An array of attribute names to validate
array $in: List of allowed/disallowed values
bool $testInList: If true, valid values MUST exist in the provided list, otherwise valid values MUST NOT exist in the list
string $msg: Error message to use
bool $allowNull: If true and the value is null, validation is skipped
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

Redefinition of:

ActiveRecord_Validation::__construct(): Constructor

validate (line 460)

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.

access: public

void validate (ActiveRecord_Base $obj)

ActiveRecord_Base $obj: The object to validate

Redefinition of:

ActiveRecord_Validation::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.

Inherited Methods

Inherited From ActiveRecord_Validation

ActiveRecord_Validation::__construct()
ActiveRecord_Validation::should_validate()
ActiveRecord_Validation::validate()

Class Constants

Inherited Constants

Inherited from ActiveRecord_Validation

ActiveRecord_Validation::ON_CREATE
ActiveRecord_Validation::ON_SAVE
ActiveRecord_Validation::ON_UPDATE