Spec-Zone.ru › CakePHP 3.1

Класс Validation

Класс Validation. Используется для валидации данных модели.

Предлагает различные методы валидации.

Пространство имён: Cake\Validation
Расположение: Validation/Validation.php

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

_checksource protected static

_check( string $check , string $regex )

Выполняет проверку по регулярному выражению.

Параметры

строка $check
Значение для проверки по выражению $regex.
строка $regex
Регулярное выражение.

Возвращает

boolean
Результат проверки

_getDateStringsource protected static

_getDateString( array $value )

Преобразует массив, представляющий дату или дату и время, в строку в формате ISO. Массивы обычно передаются для валидации из формы, сгенерированной CakePHP FormHelper.

Параметры

массив $value
Массив, представляющий дату или дату и время.

Возвращает

string
строка

_populateIpsource protected static

_populateIp( )

Лениво заполняет шаблоны адресов IP, используемые для валидации.

_resetsource protected static

_reset( )

Сбросить внутренние переменные для следующего запуска валидации.

alphaNumericsource public static

alphaNumeric( string|array $check )

Проверяет, содержит ли строка только цифры или буквы.

Возвращает true, если строка содержит только цифры или буквы.

$check может быть передан как массив: ['check' => 'значениеДляПроверки'];

Параметры

строка|массив $check
Значение для проверки.

Возвращает

boolean
Успех

asciisource public static

ascii( string $value )

Проверяет, что входное значение находится в диапазоне байтов ASCII.

Этот метод отклонит все значения, которые не являются строками.

Параметры

строка $value
Значение для проверки.

Возвращает

boolean
bool

blanksource public static

blank( string|array $check )

Возвращает true, если поле пусто -ИЛИ- в его значении присутствуют только пробельные символы. Пробельные символы включают пробел, табуляцию, возврат каретки, перенос строки.

$check может быть передан как массив: ['check' => 'значениеДляПроверки'];

Устарело

3.0.2

Параметры

строка|массив $check
Значение для проверки.

Возвращает

boolean
Успех

booleansource public static

boolean( string $check )

Валидация булевых значений, определяет, является ли переданное значение булевым целым числом или true/false.

Параметры

строка $check
валидное булевое значение.

Возвращает

boolean
Успех

ccsource public static

cc( string|array $check , string|array $type 'fast' , boolean $deep false , string|null $regex null )

Валидация номеров кредитных карт. Возвращает true, если $check соответствует правильному формату кредитной карты.

Параметры

строка|массив $check
номер кредитной карты для валидации
строка|массив $type необязательно 'fast'
'all' может быть передан как строка, по умолчанию используется 'fast' для проверки формата большинства основных кредитных карт. Если используется массив, проверяются только значения массива. Пример: ['amex', 'bankcard', 'maestro']
логическое значение $deep необязательно false
при установке в true, будет проверена алгоритм Луна для кредитной карты.
строка|null $regex необязательно null
Можно также передать пользовательское регулярное выражение, которое будет использоваться вместо определенных значений регулярных выражений.

Возвращает

boolean
Успех

См. также

Cake\Validation\Validation::luhn()

compareWithsource public static

compareWith( mixed $check , string $field , array $context )

Сравнение одного поля с другим.

Если оба поля имеют точно одинаковое значение, этот метод вернёт true.

Параметры

смешанное $check
Значение для поиска в $field.
строка $field
Поле, для проверки $check. Это поле должно быть присутствовать в $context.
массив $context
Контекст валидации.

Возвращает

boolean
bool

comparisonsource public static

comparison( string $check1 , string $operator , integer $check2 )

Используется для сравнения двух числовых значений.

Параметры

строка $check1
если для $check1 передается строка, для $check2 также должна быть передана строка. Если в качестве массива передаются данные, должен быть передан массив ['check1' => value, 'operator' => 'знак', 'check2' => value]
строка $operator
Может быть словом или оператором: больше >, меньше <, больше или равно >=, меньше или равно <=, равно ==, не равно !=
целое число $check2
необходимо только если $check1 является строкой

Возвращает

boolean
Успех

containsNonAlphaNumericsource public static

containsNonAlphaNumeric( string $check , integer $count 1 )

Проверяет, содержит ли строка один или несколько не буквенно-цифровых символов.

Возвращает true, если строка содержит хотя бы указанное количество не буквенно-цифровых символов.

Параметры

строка $check
Значение для проверки
целое число $count необязательно 1
Количество не буквенно-цифровых символов для проверки.

Возвращает

boolean
Успех

customsource public static

custom( string|array $check , string|null $regex null )

Используется, когда требуется пользовательское регулярное выражение.

Параметры

строка|массив $check
При использовании в качестве строки, $regex также должно быть допустимым регулярным выражением. Как массив: ['check' => value, 'regex' => 'допустимое регулярное выражение']
строка|null $regex необязательно null
Если $check передан как строка, $regex также должен быть установлен на допустимое регулярное выражение.

Возвращает

boolean
Успех
END_OF_DOCUMENT_MARKER

datesource public static

date( string|DateTime $check , string|array $format 'ymd' , string|null $regex null )

Проверка даты, определяет, является ли переданная строка допустимой датой. Ключи, которые ожидают полный месяц, день и год, будут проверять високосные годы.

Годы допустимы от 1800 до 2999.

Форматы:

  • dmy 27-12-2006 или 27-12-06 разделители могут быть пробелом, точкой, дефисом, косой чертой
  • mdy 12-27-2006 или 12-27-06 разделители могут быть пробелом, точкой, дефисом, косой чертой
  • ymd 2006-12-27 или 06-12-27 разделители могут быть пробелом, точкой, дефисом, косой чертой
  • dMy 27 декабря 2006 или 27 дек 2006
  • Mdy Декабря 27, 2006 или Дек 27, 2006 запятая необязательна
  • My Декабрь 2006 или Дек 2006
  • my 12/2006 или 12/06 разделители могут быть пробелом, точкой, дефисом, косой чертой
  • ym 2006/12 или 06/12 разделители могут быть пробелом, точкой, дефисом, косой чертой
  • y 2006 только год без разделителей

Параметры

строка|DateTime $check
допустимая строка/объект даты
строка|массив $format необязательно 'ymd'
Используйте строку или массив вышеуказанных ключей. Массивы должны передаваться как ['dmy', 'mdy', и т.д.]
строка|null $regex необязательно null
Если используется пользовательское регулярное выражение, это единственная проверка, которая будет выполнена.

Возвращает

boolean
Успех

datetimesource public static

datetime( string|DateTime $check , string|array $dateFormat 'ymd' , string|null $regex null )

Проверяет значение datetime

Все значения, соответствующие правилу проверки "date" и правилу "time", будут допустимы

Параметры

строка|DateTime $check
Значение для проверки
строка|массив $dateFormat необязательно 'ymd'
Формат части даты. Для получения дополнительной информации см. Validation::date.
строка|null $regex необязательно null
Регулярное выражение для части даты. Если используется пользовательское регулярное выражение, это единственная проверка, которая будет выполнена.

Возвращает

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

См. также

Cake\Validation\Validation::date()
Cake\Validation\Validation::time()

decimalsource public static

decimal( float $check , integer $places null , string|null $regex null )

Проверяет, является ли значение допустимой десятичной дробью. Знак и показатель степени являются необязательными.

Допустимые разряды:

  • null => Любое количество десятичных знаков, включая ноль. Точка '.' не требуется.
  • true => Любое количество десятичных знаков больше нуля или число с плавающей точкой. Точка '.' требуется.
  • 1..N => Ровно столько десятичных знаков. Точка '.' требуется.

Параметры

float $check
Значение, проверяемое на десятичное представление.
целое число $places необязательно null
Десятичные знаки.
строка|null $regex необязательно null
Если используется пользовательское регулярное выражение, это единственная проверка, которая будет выполнена.

Возвращает

boolean
Успех

emailsource public static

email( string $check , boolean $deep false , string $regex null )

Проверка на адрес электронной почты.

Используется только getmxrr() для глубокой проверки или любой версии PHP на дистрибутиве, не являющемся Windows

Параметры

строка $check
Значение для проверки
логическое значение $deep необязательно false
Выполнить более глубокую проверку (если true), проверив доступность хоста
строка $regex необязательно null
Регулярное выражение для использования (если не указано, будет использоваться встроенное регулярное выражение)

Возвращает

boolean
Успех

equalTosource public static

equalTo( mixed $check , mixed $comparedTo )

Проверяет, что значение точно равно $comparedTo.

Параметры

смешанный тип $check
Значение для проверки
смешанный тип $comparedTo
Значение для сравнения

Возвращает

boolean
Успех

extensionsource public static

extension( string|array $check , array $extensions ['gif', 'jpeg', 'png', 'jpg'] )

Проверяет, имеет ли значение допустимое расширение файла.

Параметры

строка|массив $check
Значение для проверки
массив $extensions необязательно ['gif', 'jpeg', 'png', 'jpg']
Допустимые расширения файлов. По умолчанию расширения — 'gif', 'jpeg', 'png', 'jpg'

Возвращает

boolean
Успех

fileSizesource public static

fileSize( string|array $check , string|null $operator null , integer|string|null $size null )

Проверка размера файла

Параметры

строка|массив $check
Значение для проверки.
строка|null $operator необязательно null
См. Validation::comparison().
целое число|строка|null $size необязательно null
Размер в байтах или читаемая строка, например, '5MB'.

Возвращает

boolean
Успех

geoCoordinatesource public static

geoCoordinate( string $value , array $options [] )

Проверка географических координат.

Поддерживаемые форматы:

  • <latitude>, <longitude> Пример: -25.274398, 133.775136

Параметры

  • type - Строка формата координат, сейчас только latLong.
  • format - По умолчанию both, может быть long и lat для проверки только части координаты.

Параметры

строка $value
Географическое положение в виде строки
массив $options необязательно []
Параметры для логики проверки.

Возвращает

boolean
bool

inListsource public static

inList( string $check , array $list , boolean $caseInsensitive false )

Проверяет, находится ли значение в заданном списке. Сравнение по умолчанию регистрозависимое.

Параметры

строка $check
Значение для проверки.
массив $list
Список для сравнения.
логическое значение $caseInsensitive необязательно false
Установите в значение true для регистронезависимого сравнения.

Возвращает

boolean
Успех.

ipsource public static

ip( string $check , string $type 'both' )

Проверка адреса IP.

Параметры

строка $check
Строка для проверки.
строка $type необязательно 'both'
Версия протокола IP для проверки

Возвращает

boolean
Успех

isIntegersource public static

isInteger( string $value )

Проверка того, что входное значение является целым числом.

Этот метод также примет строки, содержащие только данные целых чисел.

Параметры

строка $value
Значение для проверки

Возвращает

boolean
bool

latitudesource public static

latitude( string $value , array $options [] )

Удобный метод для проверки широты.

Параметры

string $value
Широта в виде строки
array $options optional []
Опции для логики проверки.

Возвращает

boolean
bool

См. также

Cake\Validation\Validation::geoCoordinate()

Ссылка

https://en.wikipedia.org/wiki/Latitude

lengthBetweensource public static

lengthBetween( string $check , integer $min , integer $max )

Проверяет, что длина строки находится в заданном диапазоне. Пробелы учитываются при подсчете символов. Возвращает true, если длина строки соответствует значению min, max или находится между min и max.

Параметры

string $check
Значение для проверки длины
integer $min
Минимальное значение в диапазоне (включительно)
integer $max
Максимальное значение в диапазоне (включительно)

Возвращает

boolean
Успех

longitudesource public static

longitude( string $value , array $options [] )

Удобный метод для проверки долготы.

Параметры

string $value
Широта в виде строки
array $options optional []
Опции для логики проверки.

Возвращает

boolean
bool

См. также

Cake\Validation\Validation::geoCoordinate()

Ссылка

https://en.wikipedia.org/wiki/Longitude

luhnsource public static

luhn( string|array $check )

Алгоритм Луна

Параметры

string|array $check
Значение для проверки.

Возвращает

boolean
Успех

См. также

http://en.wikipedia.org/wiki/Luhn_algorithm

maxLengthsource public static

maxLength( string $check , integer $max )

Проверяет, что длина строки меньше или равна максимальной длине.

Параметры

string $check
Строка для проверки
integer $max
Максимальная длина строки

Возвращает

boolean
Успех

mimeTypesource public static

mimeType( string|array $check , array|string $mimeTypes [] )

Проверка типа MIME файла.

Параметры

string|array $check
Значение для проверки.
array|string $mimeTypes optional []
Массив типов MIME или шаблон регулярного выражения для проверки.

Возвращает

boolean
Успех

Выбрасывает

RuntimeException
если тип MIME не может быть определен.
LogicException
если отсутствует расширение ext/fileinfo

minLengthsource public static

minLength( string $check , integer $min )

Проверяет, что длина строки больше или равна минимальной длине.

Параметры

string $check
Строка для проверки
integer $min
Минимальная длина строки

Возвращает

boolean
Успех

moneysource public static

money( string $check , string $symbolPosition 'left' )

Проверяет, что значение является денежной суммой.

Параметры

string $check
Значение для проверки
string $symbolPosition optional 'left'
Где находится символ (слева/справа)

Возвращает

boolean
Успех

multiplesource public static

multiple( array $check , array $options [] , boolean $caseInsensitive false )

Проверяет множественный выбор. Сравнение по умолчанию чувствительно к регистру.

Допустимые опции

  • in => список вариантов, из которых должны быть сделаны выбор
  • max => максимальное количество ненулевых выборов
  • min => минимальное количество ненулевых выборов

Параметры

array $check
Значение для проверки
array $options optional []
Опции для проверки.
boolean $caseInsensitive optional false
Установите значение true для сравнения без учета регистра.

Возвращает

boolean
Успех

naturalNumbersource public static

naturalNumber( string $check , boolean $allowZero false )

Проверяет, является ли значение натуральным числом.

Параметры

string $check
Значение для проверки
boolean $allowZero optional false
Установите значение true, чтобы разрешить ноль, по умолчанию false

Возвращает

boolean
Успех

См. также

http://en.wikipedia.org/wiki/Natural_number

notBlanksource public static

notBlank( string|array $check )

Проверяет, содержит ли строка что-либо кроме пробелов

Возвращает true, если строка содержит что-либо кроме пробелов

$check может быть передан в виде массива: ['check' => 'valueToCheck'];

Параметры

string|array $check
Значение для проверки

Возвращает

boolean
Успех

notEmptysource public static

notEmpty( string|array $check )

Обертка для обратной совместимости Validation::notBlank().

Устарело

3.0.2 Используйте Validation::notBlank() вместо этого.

Параметры

string|array $check
Значение для проверки.

Возвращает

boolean
Успех.

См. также

Cake\Validation\Validation::notBlank()

numericsource public static

numeric( string $check )

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

Параметры

string $check
Значение для проверки

Возвращает

boolean
Успех

rangesource public static

range( string $check , integer|float|null $lower null , integer|float|null $upper null )

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

Если $lower и $upper заданы, диапазон включительно. Если не заданы, возвращает true, если $check является законным конечным числом в этой платформе.

Параметры

string $check
Значение для проверки
integer|float|null $lower optional null
Нижняя граница
integer|float|null $upper optional null
Верхняя граница

Возвращает

boolean
Успех

timesource public static

time( string|DateTime $check )

Проверка времени, определяет, является ли переданная строка допустимым временем. Проверяет время как 24-часовое (ЧЧ:ММ) или am/pm ([Ч]Ч:ММ[a|p]м) Не допускает/не проверяет секунды.

Параметры

string|DateTime $check
допустимая строка/объект времени

Возвращает

boolean
Успех

uploadErrorsource public static

uploadError( string|array $check , boolean $allowNoFile false )

Проверка ошибок загрузки

Параметры

string|array $check
Значение для проверки.
boolean $allowNoFile необязательный false
Установите в true, чтобы разрешить UPLOAD_ERR_NO_FILE как проход.

Возвращает

boolean
bool

См. также

http://www.php.net/manual/en/features.file-upload.errors.php

uploadedFilesource public static

uploadedFile( array $file , array $options [] )

Проверка загруженного файла.

Помогает объединить uploadError, fileSize и mimeType в один метод валидации более высокого уровня.

Параметры

  • types - Массив допустимых типов MIME. Если пустой, все типы будут приняты. type не будет рассматриваться, вместо этого тип файла будет проверяться с помощью ext/finfo.
  • minSize - Минимальный размер файла в байтах. По умолчанию проверка не выполняется.
  • maxSize - Максимальный размер файла в байтах. По умолчанию проверка не выполняется.
  • optional - Файл является необязательным. По умолчанию false. Если true, отсутствующий файл пройдет валидатор независимо от других ограничений.

Параметры

array $file
Данные загруженного файла из PHP.
array $options необязательный []
Массив параметров для проверки.

Возвращает

boolean
bool

urlsource public static

url( string $check , boolean $strict false )

Проверяет, является ли значение допустимым URL-адресом в соответствии с http://www.w3.org/Addressing/URL/url-spec.txt

Регулярное выражение проверяет следующие компоненты:

  • допустимый, необязательный, схему
  • допустимый IP-адрес ИЛИ допустимое доменное имя, как определено в разделе 2.3.1 http://www.ietf.org/rfc/rfc1035.txt с необязательным номером порта
  • необязательный допустимый путь
  • необязательная строка запроса (параметры get)
  • необязательный фрагмент (якорь)

Параметры

string $check
Значение для проверки
boolean $strict необязательный false
Требуется, чтобы URL был префиксен допустимой схемой (одна из http(s)/ftp(s)/file/news/gopher)

Возвращает

boolean
Успех

userDefinedsource public static

userDefined( string|array $check , object $object , string $method , array|null $args null )

Выполняет пользовательскую проверку.

Устаревшее

3.0.2 Вы можете просто установить вызываемый элемент для rule ключа при добавлении валидаторов.

Параметры

string|array $check
значение, которое будет проверено в пользовательских методах.
object $object
класс, содержащий метод проверки
string $method
имя метода класса для выполнения проверки
array|null $args необязательный null
аргументы для передачи методу

Возвращает

mixed
возвращаемое значение метода класса user-defined

utf8source public static

utf8( string $value , array $options [] )

Проверка, что входное значение является строкой utf8.

Этот метод отклонит все значения, отличные от строки.

# Параметры

  • extended - Запретить байты, расположенные выше в базовой многоязычной плоскости. Более старые типы кодирования utf8 MySQL не допускают символов выше базовой многоязычной плоскости. По умолчанию false.

Параметры

string $value
Значение для проверки
array $options необязательный []
Массив параметров. См. выше поддерживаемые параметры.

Возвращает

boolean
bool

uuidsource public static

uuid( string $check )

Проверяет, является ли значение допустимым UUID - http://tools.ietf.org/html/rfc4122

Параметры

string $check
Значение для проверки

Возвращает

boolean
Успех

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

string DEFAULT_LOCALE

Локаль по умолчанию

'en_US'

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

$_patternsource

protected static array

Некоторые сложные шаблоны, необходимые в нескольких местах

[
    'hostname' => '(?:[_\p{L}0-9][-_\p{L}0-9]*\.)*(?:[\p{L}0-9][-\p{L}0-9]{0,62})\.(?:(?:[a-z]{2}\.)?[a-z]{2,})',
    'latitude' => '[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?)',
    'longitude' => '[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)',
]

$errorssource

public static array

Содержит массив сообщений об ошибках, установленных в этом классе. Они используются для отладки

[]

© 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/3.1/class-Cake.Validation.Validation.html

Spec-Zone.ru

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