Spec-Zone.ru › CakePHP 2.10

Класс CakeValidationSet

Объект CakeValidationSet. Содержит все правила валидации для поля и предоставляет методы для динамического добавления или удаления правил валидации

CakeValidationSet реализует ArrayAccess, IteratorAggregate, Countable
Пакет: Cake\Model\Validator
Ссылка: https://book.cakephp.org/2.0/en/data-validation.html
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Model/Validator/CakeValidationSet.php

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

  • $_methods protected
    array
    Список доступных методов для валидации
  • $_rules protected
    CakeValidationRule[]
    Содержит объекты CakeValidationRule
  • $_validationDomain protected
    string
    I18n домен для сообщений валидации.
  • $field public
    string
    Содержит имя поля
  • $isStopped public
    boolean
    Остановлена ли валидация
  • $ruleSet public
    array
    Содержит исходное правило

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

  • __construct() public
    Конструктор
  • _processValidationResponse() protected
    Извлекает правильное сообщение об ошибке для невалидного значения
  • _translateArgs() protected
    Применяет переводы к аргументам валидатора.
  • count() public
    Возвращает количество правил в этом наборе
  • getIterator() public
    Возвращает итератор для каждого правила, которое будет применено
  • getRule() public
    Получает правило по заданному имени, если оно существует
  • getRules() public
    Возвращает все правила для этого набора валидации
  • offsetExists() public
    Возвращает, существует ли индекс в наборе правил
  • offsetGet() public
    Возвращает объект правила по его индексу
  • offsetSet() public
    Устанавливает или заменяет правило валидации.
  • offsetUnset() public
    Удаляет правило валидации
  • removeRule() public
    Удаляет правило валидации из набора
  • reset() public
    Сбрасывает внутреннее состояние для всех правил валидации в этом наборе
  • setMethods() public
    Устанавливает список методов для использования при валидации
  • setRule() public
    Устанавливает CakeValidationRule $rule с $name
  • setRules() public
    Устанавливает правила для заданного поля
  • setValidationDomain() public
    Устанавливает I18n домен для сообщений валидации.
  • validate() public

    Выполняет все правила валидации в этом наборе и возвращает список ошибок валидации

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

__construct()source public 

__construct( string $fieldName , array $ruleSet )

Конструктор

Параметры

строка $fieldName
Имя поля.
массив $ruleSet
Набор правил.

_processValidationResponse()source protected 

_processValidationResponse( string $name , CakeValidationRule $rule )

Извлекает правильное сообщение об ошибке для невалидного значения

Параметры

строка $name
имя правила, как оно было настроено
CakeValidationRule $rule
объект, содержащий информацию о валидации

Возвращает

строка

_translateArgs()source protected 

_translateArgs( array $args )

Применяет переводы к аргументам валидатора.

Параметры

массив $args
Аргументы для перевода

Возвращает

массив
Переведенные аргументы.

count()source public 

count( )

Возвращает количество правил в этом наборе

Возвращает

целое число

Реализация

Countable::count()

getIterator()source public 

getIterator( )

Возвращает итератор для каждого правила, которое будет применено

Возвращает

ArrayIterator

Реализация

IteratorAggregate::getIterator()

getRule()source public 

getRule( string $name )

Получает правило по заданному имени, если оно существует

Параметры

строка $name
Имя поля.

Возвращает

CakeValidationRule

getRules()source public 

getRules( )

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

Возвращает

CakeValidationRule[]

offsetExists()source public 

offsetExists( string $index )

Возвращает, существует ли индекс в наборе правил

Параметры

строка $index
имя правила

Возвращает

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

Реализация

ArrayAccess::offsetExists()

offsetGet()source public 

offsetGet( string $index )

Возвращает объект правила по его индексу

Параметры

строка $index
имя правила

Возвращает

CakeValidationRule

Реализация

ArrayAccess::offsetGet()

offsetSet()source public 

offsetSet( string $index , CakeValidationRule|array $rule )

Устанавливает или заменяет правило валидации.

Это обёртка для ArrayAccess. Используйте setRule() напрямую для цепочки доступа.

Параметры

строка $index
Имя правила.
CakeValidationRule|массив $rule
Правило для добавления в $index.

См.

http://www.php.net/manual/en/arrayobject.offsetset.php

Реализация

ArrayAccess::offsetSet()

offsetUnset()source public 

offsetUnset( string $index )

Удаляет правило валидации

Параметры

строка $index
имя правила

Реализация

ArrayAccess::offsetUnset()

removeRule()source public 

removeRule( string $name )

Удаляет правило проверки из набора

Пример:

$set
        ->removeRule('required')
        ->removeRule('inRange')

Параметры

строка $name
Имя, по которому следует удалить правило

Возвращает

CakeValidationSet

reset()source public 

reset( )

Сбрасывает внутреннее состояние для всех правил проверки в этом наборе

setMethods()source public 

setMethods( array $methods )

Устанавливает список методов для использования при проверке

Параметры

массив $methods
$methods Список методов

setRule()source public 

setRule( string $name , CakeValidationRule|array $rule )

Устанавливает CakeValidationRule $rule с $name

Пример:

$set
        ->setRule('required', array('rule' => 'notBlank', 'required' => true))
        ->setRule('between', array('rule' => array('lengthBetween', 4, 10))

Параметры

строка $name
Имя, по которому следует установить правило
CakeValidationRule|массив $rule
Правило проверки, которое нужно установить

Возвращает

CakeValidationSet

setRules()source public 

setRules( array $rules array() , boolean $mergeVars true )

Устанавливает правила для указанного поля

Пример:

$set->setRules(array(
        'required' => array('rule' => 'notBlank', 'required' => true),
        'inRange' => array('rule' => array('between', 4, 10)
        ));

Параметры

массив $rules необязательно array()
Правила, которые нужно установить
логическое значение $mergeVars необязательно true
[необязательно] Если true, объединяет переменные вместо замены. По умолчанию true.

Возвращает

CakeValidationSet

setValidationDomain()source public 

setValidationDomain( string $validationDomain )

Устанавливает домен I18n для сообщений об ошибках проверки.

Параметры

строка $validationDomain
Домен проверки, который нужно использовать.

validate()source public 

validate( array $data , boolean $isUpdate false )

Выполняет все правила проверки в этом наборе и возвращает список ошибок проверки

Параметры

массив $data
Массив данных
логическое значение $isUpdate необязательно false
Обновляется или создается запись

Возвращает

массив
список ошибок проверки для данного поля

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

$_methodssource

protected массив

Список методов, доступных для проверки

array()

$_rulessource

protected CakeValidationRule[]

Содержит объекты CakeValidationRule

array()

$_validationDomainsource

protected строка

Домен I18n для сообщений об ошибках проверки.

null

$fieldsource

public строка

Содержит имя поля

null

$isStoppedsource

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

Определяет, остановлена ли проверка

false

$ruleSetsource

public массив

Содержит исходный ruleSet

array()

© 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-CakeValidationSet.html

Spec-Zone.ru

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