Класс CakeValidationRule

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

Пакет: Cake\Model\Validator
Ссылка: 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 данные для проверки правила

Возвращает

булево значение

checkRequired()source public

checkRequired( string $field , array $data )

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

Параметры

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

Возвращает

булево значение

getOptions()source public

getOptions( string|integer $key )

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

Параметры

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

Возвращает

массив/null

getValidationResult()source public

getValidationResult( )

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

Возвращает

строка

isEmptyAllowed()source public

isEmptyAllowed( )

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

Возвращает

булево значение

isLast()source public

isLast( )

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

Возвращает

булево значение

isRequired()source public

isRequired( )

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

Возвращает

булево значение

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, если правило валидации может быть пропущено

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

$_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.
http://api.cakephp.org/2.8/class-CakeValidationRule.html