Spec-Zone.ru › CakePHP 2.7

Класс CakeValidationRule

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

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

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

__constructисходный код public

__construct( array $validator array() )

Конструктор

Параметры

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

_addValidatorPropsисходный код protected

_addValidatorProps( array $validator array() )

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

Параметры

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

_getPropertiesArrayисходный код protected

_getPropertiesArray( )

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

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

array
массив

_parseRuleисходный код protected

_parseRule( string $field , array $data )

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

Параметры

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

checkEmptyисходный код public

checkEmpty( string $field , array $data )

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

Параметры

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

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

boolean
логическое значение

checkRequiredисходный код public

checkRequired( string $field , array $data )

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

Параметры

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

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

boolean
логическое значение

getOptionsисходный код public

getOptions( string|integer $key )

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

Параметры

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

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

array|null
массив/null

getValidationResultисходный код public

getValidationResult( )

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

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

string
строка

isEmptyAllowedисходный код public

isEmptyAllowed( )

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

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

boolean
логическое значение

isLastисходный код public

isLast( )

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

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

boolean
логическое значение

isRequiredисходный код public

isRequired( )

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

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

boolean
логическое значение

isUpdateисходный код public

isUpdate( boolean $exists null )

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

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

Параметры

логическое значение $exists необязательно null
Логическое значение, указывающее, существуют ли записи

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

boolean
логическое значение

isValidисходный код public

isValid( )

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

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

boolean
логическое значение

processисходный код public

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

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

Параметры

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

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

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

resetисходный код public

reset( )

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

skipисходный код 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.
http://api.cakephp.org/2.7/class-CakeValidationRule.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API