Docs For Class ActiveRecord

Description

A validation to check that an attribute's value conforms to a regular expression.

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

ActiveRecord_Validation
   |
   --ActiveRecord_RegExValidation

Variable Summary

mixed $allowNull

mixed $attrNames

mixed $msg

mixed $pattern

Method Summary

ActiveRecord_RegExValidation __construct (array $attrNames, string $pattern, [string $msg = false], [bool $allowNull = false], [int $type = ActiveRecord_Validation::ON_SAVE], [string $condition = false])

void validate (ActiveRecord_Base $obj)

Variables

mixed $allowNull (line 367)

Flag indicating whether nulls are allowed

access: protected

mixed $attrNames (line 355)

List of attribute names to validate

access: protected

mixed $msg (line 359)

Error message to use

access: protected

mixed $pattern (line 363)

Regular expression to validate against

access: protected

Inherited Variables

Inherited from ActiveRecord_Validation

ActiveRecord_Validation::$condition
ActiveRecord_Validation::$type

Methods

Constructor __construct (line 379)

Constructor

access: public

ActiveRecord_RegExValidation __construct (array $attrNames, string $pattern, [string $msg = false], [bool $allowNull = false], [int $type = ActiveRecord_Validation::ON_SAVE], [string $condition = false])

array $attrNames: An array of attribute names to validate
string $pattern: Regular expression to use for validation
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 395)

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