xpdo/validation/xpdovalidator.class.php

Classes

package: xpdo
subpackage: validation
Classes: xPDOValidator; xPDOValidationRule; xPDOMinLengthValidationRule; xPDOMaxLengthValidationRule; xPDOMinValueValidationRule; xPDOMaxValueValidationRule; xPDOObjectExistsValidationRule; xPDOForeignKeyConstraint

Description

The base xPDO validation classes.

This file contains the base validation classes used by xPDO.

\xPDOForeignKeyConstraint
jump to top

Extends from: \xPDOValidationRule
package: xpdo
Methods: isValid

Description

The base validation rule class.

Methods

isValid
jump to class

isValid(
          mixed $value, array $options
              =
              array
          )
        
        :
        boolean

The public method for executing a validation rule.

Extend this method to provide a reusable validation rule in your xPDOValidator instance.

Arguments

$value: mixed
The value of the field being validated.
$options: array
Any options expected by the rule.

Output

boolean: True if the validation rule was passed, otherwise false.

Details

visibility: public
final: false
static: false

\xPDOMaxLengthValidationRule
jump to top

Extends from: \xPDOValidationRule
package: xpdo
Methods: isValid

Description

The base validation rule class.

Methods

isValid
jump to class

isValid(
          mixed $value, array $options
              =
              array
          )
        
        :
        boolean

The public method for executing a validation rule.

Extend this method to provide a reusable validation rule in your xPDOValidator instance.

Arguments

$value: mixed
The value of the field being validated.
$options: array
Any options expected by the rule.

Output

boolean: True if the validation rule was passed, otherwise false.

Details

visibility: public
final: false
static: false

\xPDOMaxValueValidationRule
jump to top

Extends from: \xPDOValidationRule
package: xpdo
Methods: isValid

Description

The base validation rule class.

Methods

isValid
jump to class

isValid(
          mixed $value, array $options
              =
              array
          )
        
        :
        boolean

The public method for executing a validation rule.

Extend this method to provide a reusable validation rule in your xPDOValidator instance.

Arguments

$value: mixed
The value of the field being validated.
$options: array
Any options expected by the rule.

Output

boolean: True if the validation rule was passed, otherwise false.

Details

visibility: public
final: false
static: false

\xPDOMinLengthValidationRule
jump to top

Extends from: \xPDOValidationRule
package: xpdo
Methods: isValid

Description

The base validation rule class.

Methods

isValid
jump to class

isValid(
          mixed $value, array $options
              =
              array
          )
        
        :
        boolean

The public method for executing a validation rule.

Extend this method to provide a reusable validation rule in your xPDOValidator instance.

Arguments

$value: mixed
The value of the field being validated.
$options: array
Any options expected by the rule.

Output

boolean: True if the validation rule was passed, otherwise false.

Details

visibility: public
final: false
static: false

\xPDOMinValueValidationRule
jump to top

Extends from: \xPDOValidationRule
package: xpdo
Methods: isValid

Description

The base validation rule class.

Methods

isValid
jump to class

isValid(
          mixed $value, array $options
              =
              array
          )
        
        :
        boolean

The public method for executing a validation rule.

Extend this method to provide a reusable validation rule in your xPDOValidator instance.

Arguments

$value: mixed
The value of the field being validated.
$options: array
Any options expected by the rule.

Output

boolean: True if the validation rule was passed, otherwise false.

Details

visibility: public
final: false
static: false

\xPDOObjectExistsValidationRule
jump to top

Extends from: \xPDOValidationRule
package: xpdo
Methods: isValid

Description

The base validation rule class.

Methods

isValid
jump to class

isValid(
          mixed $value, array $options
              =
              array
          )
        
        :
        boolean

The public method for executing a validation rule.

Extend this method to provide a reusable validation rule in your xPDOValidator instance.

Arguments

$value: mixed
The value of the field being validated.
$options: array
Any options expected by the rule.

Output

boolean: True if the validation rule was passed, otherwise false.

Details

visibility: public
final: false
static: false

\xPDOValidationRule
jump to top

package: xpdo
subpackage: validation
Properties: $field; $message; $name; $validator
Methods: __construct; isValid; setMessage

Description

The base validation rule class.

Properties

$field
jump to class

$field = ''

Details

visibility: public
default
final: false
static: false

$message
jump to class

$message = ''

Details

visibility: public
default
final: false
static: false

$name
jump to class

$name = ''

Details

visibility: public
default
final: false
static: false

$validator
jump to class

$validator = 'null'

Details

visibility: public
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          \xPDOValidator $validator, mixed $field, mixed $name, string $message
          )
        
        :
        \xPDOValidationRule

Construct a new xPDOValidationRule instance.

Arguments

$validator: \xPDOValidator
&$validator A reference to the xPDOValidator executing this rule.
$field: mixed
The field being validated.
$name: mixed
The identifying name of the validation rule.
$message: string
An optional message for rule failure.

Output

\xPDOValidationRule: The rule instance.

Details

visibility: public
final: false
static: false

isValid
jump to class

isValid(
          mixed $value, array $options
              =
              array
          )
        
        :
        boolean

The public method for executing a validation rule.

Extend this method to provide a reusable validation rule in your xPDOValidator instance.

Arguments

$value: mixed
The value of the field being validated.
$options: array
Any options expected by the rule.

Output

boolean: True if the validation rule was passed, otherwise false.

Details

visibility: public
final: false
static: false

setMessage
jump to class

setMessage(
          string $message
          )
        
        :

Set the failure message for the rule.

Arguments

$message: string
A message intended to convey the reason for rule failure.

Details

visibility: public
final: false
static: false

\xPDOValidator
jump to top

package: xpdo
subpackage: validation
Properties: $messages; $object; $results
Methods: __construct; addMessage; getMessages; getResults; hasMessages; reset; validate

Description

The base validation service class.

Extend this class to customize the validation process.

Properties

$messages
jump to class

$messages = 'array'

Details

visibility: public
default: array
final: false
static: false

$object
jump to class

$object = 'null'

Details

visibility: public
default: null
final: false
static: false

$results
jump to class

$results = 'array'

Details

visibility: public
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
           $object
          )
        
        :

Arguments

$object

Details

visibility: public
final: false
static: false

addMessage
jump to class

addMessage(
          string $field, string $name, mixed $message
              =
              null
          )
        
        :

Add a validation message to the stack.

Arguments

$field: string
The name of the field the message relates to.
$name: string
The name of the rule the message relates to.
$message: mixed
An optional message; the name of the rule is used if no message is specified.

Details

visibility: public
final: false
static: false

getMessages
jump to class

getMessages(
          
          )
        
        :
        array

Get the validation messages generated by validate().

Output

array: An array of validation messages.

Details

visibility: public
final: false
static: false

getResults
jump to class

getResults(
          
          )
        
        :
        array

Get the validation results generated by validate().

Output

array: An array of boolean validation results.

Details

visibility: public
final: false
static: false

hasMessages
jump to class

hasMessages(
          
          )
        
        :
        boolean

Indicates validation messages were generated by validate().

Output

boolean: True if messages were generated.

Details

visibility: public
final: false
static: false

reset
jump to class

Reset the validation results and messages.

Details

visibility: public
final: false
static: false

validate
jump to class

validate(
          array $parameters
              =
              array
          )
        
        :
        boolean

Executes validation against the object attached to this validator.

Arguments

$parameters: array
A collection of parameters.

Output

boolean: Either true or false indicating valid or invalid.

Details

visibility: public
final: false
static: false

xpdo/validation/xpdovalidator.class.php

Description

\xPDOForeignKeyConstraintjump to top

Description

Methods

isValidjump to class

Arguments

Output

Details

\xPDOMaxLengthValidationRulejump to top

Description

Methods

isValidjump to class

Arguments

Output

Details

\xPDOMaxValueValidationRulejump to top

Description

Methods

isValidjump to class

Arguments

Output

Details

\xPDOMinLengthValidationRulejump to top

Description

Methods

isValidjump to class

Arguments

Output

Details

\xPDOMinValueValidationRulejump to top

Description

Methods

isValidjump to class

Arguments

Output

Details

\xPDOObjectExistsValidationRulejump to top

Description

Methods

isValidjump to class

Arguments

Output

Details

\xPDOValidationRulejump to top

Description

Properties

$fieldjump to class

Details

$messagejump to class

Details

$namejump to class

Details

$validatorjump to class

Details

Methods

__constructjump to class

Arguments

Output

Details

isValidjump to class

Arguments

Output

Details

setMessagejump to class

Arguments

Details

\xPDOValidatorjump to top

Description

Properties

$messagesjump to class

Details

$objectjump to class

Details

$resultsjump to class

Details

Methods

__constructjump to class

Arguments

Details

\xPDOForeignKeyConstraint
jump to top

isValid
jump to class

\xPDOMaxLengthValidationRule
jump to top

isValid
jump to class

\xPDOMaxValueValidationRule
jump to top

isValid
jump to class

\xPDOMinLengthValidationRule
jump to top

isValid
jump to class

\xPDOMinValueValidationRule
jump to top

isValid
jump to class

\xPDOObjectExistsValidationRule
jump to top

isValid
jump to class

\xPDOValidationRule
jump to top

$field
jump to class

$message
jump to class

$name
jump to class

$validator
jump to class

__construct
jump to class

isValid
jump to class

setMessage
jump to class

\xPDOValidator
jump to top

$messages
jump to class

$object
jump to class

$results
jump to class

__construct
jump to class

addMessage
jump to class

getMessages
jump to class

getResults
jump to class

hasMessages
jump to class

reset
jump to class

validate
jump to class