core/xpdo/validation/xpdovalidator.class.php

Show:

inherited

Classes

Table of Contents

The base xPDO validation classes.

This file contains the base validation classes used by xPDO.

Package: xpdo
Subpackage: validation

\xPDOForeignKeyConstraint
jump to top

Package:

The base validation rule class.

Parent(s): \xPDOValidationRule

Properties


                 $field= ''''

inheritedInherited from: \xPDOValidationRule::$$field

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$field


                 $message= ''''

inheritedInherited from: \xPDOValidationRule::$$message

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$message


                 $name= ''''

inheritedInherited from: \xPDOValidationRule::$$name

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$name


                 $validator= 'null'

inheritedInherited from: \xPDOValidationRule::$$validator

Default valuenullDetails

Type: n/a
Inherited_from: \xPDOValidationRule::$$validator

Methods

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

inherited

Construct a new xPDOValidationRule instance.

Inherited from: \xPDOValidationRule::__construct()

Parameters

Name	Type	Description
$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.

Returns

Type	Description
\xPDOValidationRule	The rule instance.

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.

Parameters

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

Returns

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

setMessage(
          string $message
              =
              ''
          )
        
        :
          void

inherited

Set the failure message for the rule.

Inherited from: \xPDOValidationRule::setMessage()

Parameters

Name	Type	Description
$message	string	A message intended to convey the reason for rule failure.

\xPDOMaxLengthValidationRule
jump to top

Package:

The base validation rule class.

Parent(s): \xPDOValidationRule

Properties


                 $field= ''''

inheritedInherited from: \xPDOValidationRule::$$field

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$field


                 $message= ''''

inheritedInherited from: \xPDOValidationRule::$$message

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$message


                 $name= ''''

inheritedInherited from: \xPDOValidationRule::$$name

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$name


                 $validator= 'null'

inheritedInherited from: \xPDOValidationRule::$$validator

Default valuenullDetails

Type: n/a
Inherited_from: \xPDOValidationRule::$$validator

Methods

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

inherited

Construct a new xPDOValidationRule instance.

Inherited from: \xPDOValidationRule::__construct()

Parameters

Name	Type	Description
$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.

Returns

Type	Description
\xPDOValidationRule	The rule instance.

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.

Parameters

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

Returns

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

setMessage(
          string $message
              =
              ''
          )
        
        :
          void

inherited

Set the failure message for the rule.

Inherited from: \xPDOValidationRule::setMessage()

Parameters

Name	Type	Description
$message	string	A message intended to convey the reason for rule failure.

\xPDOMaxValueValidationRule
jump to top

Package:

The base validation rule class.

Parent(s): \xPDOValidationRule

Properties


                 $field= ''''

inheritedInherited from: \xPDOValidationRule::$$field

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$field


                 $message= ''''

inheritedInherited from: \xPDOValidationRule::$$message

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$message


                 $name= ''''

inheritedInherited from: \xPDOValidationRule::$$name

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$name


                 $validator= 'null'

inheritedInherited from: \xPDOValidationRule::$$validator

Default valuenullDetails

Type: n/a
Inherited_from: \xPDOValidationRule::$$validator

Methods

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

inherited

Construct a new xPDOValidationRule instance.

Inherited from: \xPDOValidationRule::__construct()

Parameters

Name	Type	Description
$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.

Returns

Type	Description
\xPDOValidationRule	The rule instance.

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.

Parameters

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

Returns

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

setMessage(
          string $message
              =
              ''
          )
        
        :
          void

inherited

Set the failure message for the rule.

Inherited from: \xPDOValidationRule::setMessage()

Parameters

Name	Type	Description
$message	string	A message intended to convey the reason for rule failure.

\xPDOMinLengthValidationRule
jump to top

Package:

The base validation rule class.

Parent(s): \xPDOValidationRule

Properties


                 $field= ''''

inheritedInherited from: \xPDOValidationRule::$$field

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$field


                 $message= ''''

inheritedInherited from: \xPDOValidationRule::$$message

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$message


                 $name= ''''

inheritedInherited from: \xPDOValidationRule::$$name

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$name


                 $validator= 'null'

inheritedInherited from: \xPDOValidationRule::$$validator

Default valuenullDetails

Type: n/a
Inherited_from: \xPDOValidationRule::$$validator

Methods

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

inherited

Construct a new xPDOValidationRule instance.

Inherited from: \xPDOValidationRule::__construct()

Parameters

Name	Type	Description
$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.

Returns

Type	Description
\xPDOValidationRule	The rule instance.

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.

Parameters

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

Returns

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

setMessage(
          string $message
              =
              ''
          )
        
        :
          void

inherited

Set the failure message for the rule.

Inherited from: \xPDOValidationRule::setMessage()

Parameters

Name	Type	Description
$message	string	A message intended to convey the reason for rule failure.

\xPDOMinValueValidationRule
jump to top

Package:

The base validation rule class.

Parent(s): \xPDOValidationRule

Properties


                 $field= ''''

inheritedInherited from: \xPDOValidationRule::$$field

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$field


                 $message= ''''

inheritedInherited from: \xPDOValidationRule::$$message

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$message


                 $name= ''''

inheritedInherited from: \xPDOValidationRule::$$name

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$name


                 $validator= 'null'

inheritedInherited from: \xPDOValidationRule::$$validator

Default valuenullDetails

Type: n/a
Inherited_from: \xPDOValidationRule::$$validator

Methods

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

inherited

Construct a new xPDOValidationRule instance.

Inherited from: \xPDOValidationRule::__construct()

Parameters

Name	Type	Description
$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.

Returns

Type	Description
\xPDOValidationRule	The rule instance.

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.

Parameters

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

Returns

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

setMessage(
          string $message
              =
              ''
          )
        
        :
          void

inherited

Set the failure message for the rule.

Inherited from: \xPDOValidationRule::setMessage()

Parameters

Name	Type	Description
$message	string	A message intended to convey the reason for rule failure.

\xPDOObjectExistsValidationRule
jump to top

Package:

The base validation rule class.

Parent(s): \xPDOValidationRule

Properties


                 $field= ''''

inheritedInherited from: \xPDOValidationRule::$$field

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$field


                 $message= ''''

inheritedInherited from: \xPDOValidationRule::$$message

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$message


                 $name= ''''

inheritedInherited from: \xPDOValidationRule::$$name

Default value''Details

Type: n/a
Inherited_from: \xPDOValidationRule::$$name


                 $validator= 'null'

inheritedInherited from: \xPDOValidationRule::$$validator

Default valuenullDetails

Type: n/a
Inherited_from: \xPDOValidationRule::$$validator

Methods

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

inherited

Construct a new xPDOValidationRule instance.

Inherited from: \xPDOValidationRule::__construct()

Parameters

Name	Type	Description
$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.

Returns

Type	Description
\xPDOValidationRule	The rule instance.

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.

Parameters

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

Returns

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

setMessage(
          string $message
              =
              ''
          )
        
        :
          void

inherited

Set the failure message for the rule.

Inherited from: \xPDOValidationRule::setMessage()

Parameters

Name	Type	Description
$message	string	A message intended to convey the reason for rule failure.

\xPDOValidationRule
jump to top

Package: xpdo\validation

The base validation rule class.

Children: \xPDOMinLengthValidationRule; \xPDOMaxLengthValidationRule; \xPDOMinValueValidationRule; \xPDOMaxValueValidationRule; \xPDOObjectExistsValidationRule; \xPDOForeignKeyConstraint

Properties


                 $field= ''''

Default value''Details

Type: n/a


                 $message= ''''

Default value''Details

Type: n/a


                 $name= ''''

Default value''Details

Type: n/a


                 $validator= 'null'

Default valuenullDetails

Type: n/a

Methods

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

Construct a new xPDOValidationRule instance.

Parameters

Name	Type	Description
$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.

Returns

Type	Description
\xPDOValidationRule	The rule instance.

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.

Parameters

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

Returns

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

setMessage(
          string $message
              =
              ''
          )
        
        :
          void

Set the failure message for the rule.

Parameters

Name	Type	Description
$message	string	A message intended to convey the reason for rule failure.

\xPDOValidator
jump to top

Package: xpdo\validation

The base validation service class.

Extend this class to customize the validation process.

Children: \modValidator

Properties


                 $messages= 'array()'

Default valuearray()Details

Type: n/a


                 $object= 'null'

Default valuenullDetails

Type: n/a


                 $results= 'array()'

Default valuearray()Details

Type: n/a

Methods

__construct(
           $object
          )
        
        :
          void

Parameters

Name	Type	Description
$object

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

Add a validation message to the stack.

Parameters

Name	Type	Description
$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.

getMessages(
          
          )
        
        :
          array

Get the validation messages generated by validate().

Returns

Type	Description
array	An array of validation messages.

getResults(
          
          )
        
        :
          array

Get the validation results generated by validate().

Returns

Type	Description
array	An array of boolean validation results.

hasMessages(
          
          )
        
        :
          boolean

Indicates validation messages were generated by validate().

Returns

Type	Description
boolean	True if messages were generated.

Reset the validation results and messages.

validate(
          array $parameters
              =
              array()
          )
        
        :
          boolean

Executes validation against the object attached to this validator.

Parameters

Name	Type	Description
$parameters	array	A collection of parameters.

Returns

Type	Description
boolean	Either true or false indicating valid or invalid.

core/xpdo/validation/xpdovalidator.class.php

\xPDOForeignKeyConstraintjump to top

Properties

Methods

\xPDOMaxLengthValidationRulejump to top

Properties

Methods

\xPDOMaxValueValidationRulejump to top

Properties

Methods

\xPDOMinLengthValidationRulejump to top

Properties

Methods

\xPDOMinValueValidationRulejump to top

Properties

Methods

\xPDOObjectExistsValidationRulejump to top

Properties

Methods

\xPDOValidationRulejump to top

Properties

Methods

\xPDOValidatorjump to top

Properties

Methods

\xPDOForeignKeyConstraint
jump to top

\xPDOMaxLengthValidationRule
jump to top

\xPDOMaxValueValidationRule
jump to top

\xPDOMinLengthValidationRule
jump to top

\xPDOMinValueValidationRule
jump to top

\xPDOObjectExistsValidationRule
jump to top

\xPDOValidationRule
jump to top

\xPDOValidator
jump to top