Класс CakeValidationRule

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

Пакет: Cake\Модель\Валидатор
Ссылка: https://book.cakephp.org/2.0/ru/data-validation.html
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: Лицензия MIT
Расположение: 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, если правило проверки можно пропустить

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

$_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–2017 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.10/class-CakeValidationRule.html