Класс CakeValidationRule

Объект CakeValidationRule. Представляет метод валидации, сообщение об ошибке и правила для применения такого метода к полю.

Пакет: Cake\Модель\Валидатор
Ссылка: http://book.cakephp.org/2.0/ru/data-validation.html
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Model/Validator/CakeValidationRule.php

Краткое описание свойств

$_passedOptions protected

array
Содержит переданные опции
$_recordExists protected

boolean
Содержит информацию о том, существует ли запись, проходящая валидацию, в источнике данных или нет
$_rule protected

mixed
Метод валидации
$_ruleParams protected

array
Аргументы метода валидации
$_valid protected

mixed
Прошло ли поле эту проверку
$allowEmpty public

boolean
Ключ 'allowEmpty'
$last public

boolean
Ключ 'last'
$message public

string
Ключ 'message'
$on public

string
Ключ 'on'
$required public

mixed
Ключ 'required'
$rule public

mixed
Ключ 'rule'

Краткое описание методов

__construct() public
Конструктор
_addValidatorProps() protected
Устанавливает свойства правила из записи правила в validate
_getPropertiesArray() protected
Возвращает массив свойств правила
_parseRule() protected
Парсит правило и устанавливает rule и ruleParams
checkEmpty() public
Проверяет, применяется ли ключ allowEmpty
checkRequired() public
Проверяет, не прошла ли валидация поля по правилу field should be present
getOptions() public
Возвращает переданные опции для этого правила
getValidationResult() public
Возвращает сообщение об ошибке валидации
isEmptyAllowed() public
Возвращает, может ли поле быть пустым в соответствии с этим правилом
isLast() public

Возвращает, должно ли это правило прервать процесс валидации для связанного поля после неудачи
isRequired() public
Проверяет, обязательно ли поле в соответствии со свойством required
isUpdate() public

Устанавливает значение конфигурации recordExists для этого правила, которое указывает, существует ли запись модели, которую оно проверяет, в коллекции или нет (операция создания или обновления)
isValid() public
Проверяет, является ли правило валидным
process() public
Отправляет правило валидации указанному методу валидатора
reset() public

Сбрасывает внутреннее состояние этого правила, по умолчанию оно станет валидным, и isUpdate() будет установлено в false
skip() public
Проверяет, должно ли быть пропущено правило валидации

Подробное описание методов

__construct()source public

__construct( array $validator array() )

Конструктор

Параметры

массив $validator необязательный array(): [необязательно] Свойства валидатора

_addValidatorProps()source protected

_addValidatorProps( array $validator array() )

Устанавливает свойства правила из записи правила в validate

Параметры

массив $validator необязательный array(): [необязательно]

_getPropertiesArray()source protected

_getPropertiesArray( )

Возвращает массив со свойствами правила

Возвращает

массив

_parseRule()source protected

_parseRule( string $field , array $data )

Парсит правило и устанавливает rule и ruleParams

Параметры

строка $field: Имя поля
массив $data: $data Массив данных

checkEmpty()source public

checkEmpty( string $field , array $data )

Проверяет, применяется ли ключ allowEmpty

Параметры

строка $field: Имя поля
массив $data: $data данные для проверки правила

Возвращает

boolean

checkRequired()source public

checkRequired( string $field , array $data )

Проверяет, не прошла ли валидация поля по правилу field should be present

Параметры

строка $field: Имя поля
массив $data: $data Данные для проверки правила

Возвращает

boolean

getOptions()source public

getOptions( string|integer $key )

Возвращает переданные опции для этого правила

Параметры

строка|целое число $key: Индекс массива

Возвращает

массив|null

getValidationResult()source public

getValidationResult( )

Возвращает сообщение об ошибке валидации

Возвращает

строка

isEmptyAllowed()source public

isEmptyAllowed( )

Возвращает, может ли поле быть пустым в соответствии с этим правилом

Возвращает

boolean

isLast()source public

isLast( )

Возвращает, должно ли это правило прервать процесс валидации для связанного поля после неудачи

Возвращает

boolean

isRequired()source public

isRequired( )

Проверяет, обязательно ли поле в соответствии со свойством required

Возвращает

boolean

END_OF_DOCUMENT_MARKER

isUpdate()source public

isUpdate( boolean $exists null )

Устанавливает значение конфигурации recordExists для этой правила, оно указывает, существует ли проверяемая запись модели в коллекции или нет (операция создания или обновления).

Если вызывается без параметров, она вернёт, настроено ли это правило для операций обновления или нет.

Параметры

boolean $exists необязательный null: Булево значение, указывающее, существуют ли записи.

Возвращаемое значение

boolean

isValid()source public

isValid( )

Проверяет, является ли правило валидным.

Возвращаемое значение

boolean

process()source public

process( string $field , array $data , array $methods )

Пересылает правило валидации указанному методу валидатора.

Параметры

string $field: Имя поля
array $data: $data Массив данных
array $methods: $methods Список методов

Возвращаемое значение

boolean
True, если правило можно переслать, false в противном случае

reset()source public

reset( )

Сбрасывает внутреннее состояние для этого правила, по умолчанию оно станет валидным, и isUpdate() будет установлено в false.

skip()source public

skip( )

Проверяет, следует ли пропустить правило валидации.

Возвращаемое значение

boolean
True, если ValidationRule можно пропустить

Подробное описание свойств

$_passedOptionssource

protected array

Хранит переданные параметры.

array()

$_recordExistssource

protected boolean

Содержит информацию о том, существует ли проверяемая запись в источнике данных или нет.

false

$_rulesource

protected mixed

Метод валидации.

null

$_ruleParamssource

protected array

Аргументы метода валидации.

array()

$_validsource

protected mixed

Прошло ли поле проверку по этому правилу.

true

$allowEmptysource

public boolean

Ключ 'allowEmpty'.

null

$lastsource

public boolean

Ключ 'last'.

true

$messagesource

public string

Ключ 'message'.

null

$onsource

public string

Ключ 'on'.

null

$requiredsource

public mixed

Ключ 'required'.

null

$rulesource

public mixed

Ключ 'rule'.

'blank'

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.9/class-CakeValidationRule.html