CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.10 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.10
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class ValidationRule

ValidationRule object. Represents a validation method, error message and rules for applying such method to a field.

Namespace: Cake\Validation

Property Summary

  • $_last protected
    bool

    The 'last' key

  • $_message protected
    string

    The 'message' key

  • $_on protected
    string

    The 'on' key

  • $_pass protected
    array

    Extra arguments to be passed to the validation method

  • $_provider protected
    string

    Key under which the object or class where the method to be used for validation will be found

  • $_rule protected
    string|callable

    The method to be called for a given scope

Method Summary

  • __construct() public

    Constructor

  • _addValidatorProps() protected

    Sets the rule properties from the rule entry in validate

  • _skip() protected

    Checks if the validation rule should be skipped

  • get() public

    Returns the value of a property by name

  • isLast() public

    Returns whether this rule should break validation process for associated field after it fails

  • process() public

    Dispatches the validation rule to the given validator method and returns a boolean indicating whether the rule passed or not. If a string is returned it is assumed that the rule failed and the error message was given as a result.

Method Detail

__construct() ¶ public

__construct(array $validator = [])

Constructor

Parameters
array $validator optional

[optional] The validator properties

_addValidatorProps() ¶ protected

_addValidatorProps(array $validator = []): void

Sets the rule properties from the rule entry in validate

Parameters
array $validator optional

[optional]

Returns
void

_skip() ¶ protected

_skip(array $context): bool

Checks if the validation rule should be skipped

Parameters
array $context

A key value list of data that could be used as context during validation. Recognized keys are:

  • newRecord: (boolean) whether or not the data to be validated belongs to a new record
  • data: The full data that was passed to the validation process
  • providers associative array with objects or class names that will be passed as the last argument for the validation method
Returns
bool

get() ¶ public

get(string $property): mixed

Returns the value of a property by name

Parameters
string $property

The name of the property to retrieve.

Returns
mixed

isLast() ¶ public

isLast(): bool

Returns whether this rule should break validation process for associated field after it fails

Returns
bool

process() ¶ public

process(mixed $value, array $providers, array $context = []): bool|string|array

Dispatches the validation rule to the given validator method and returns a boolean indicating whether the rule passed or not. If a string is returned it is assumed that the rule failed and the error message was given as a result.

Parameters
mixed $value

The data to validate

array $providers

associative array with objects or class names that will be passed as the last argument for the validation method

array $context optional

A key value list of data that could be used as context during validation. Recognized keys are:

  • newRecord: (boolean) whether or not the data to be validated belongs to a new record
  • data: The full data that was passed to the validation process
  • field: The name of the field that is being processed
Returns
bool|string|array
Throws
InvalidArgumentException
when the supplied rule is not a valid callable for the configured scope

Property Detail

$_last ¶ protected

The 'last' key

Type
bool

$_message ¶ protected

The 'message' key

Type
string

$_on ¶ protected

The 'on' key

Type
string

$_pass ¶ protected

Extra arguments to be passed to the validation method

Type
array

$_provider ¶ protected

Key under which the object or class where the method to be used for validation will be found

Type
string

$_rule ¶ protected

The method to be called for a given scope

Type
string|callable
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs