Класс yii\validators\StringValidator

Все классы | Свойства | Методы

Наследование	yii\validators\StringValidator » yii\validators\Validator » yii\base\Component » yii\base\Object
Реализует	yii\base\Configurable
Доступно с версии	2.0
Исходный код	https://github.com/yiisoft/yii2/blob/master/framework/validators/StringValidator.php

StringValidator проверяет, что значение атрибута имеет определённую длину.

Обратите внимание, что этот валидатор следует использовать только с атрибутами строкового типа.

Публичные свойства

Свойство	Тип	Описание	Определено в
$attributeNames	массив	Имена атрибутов.	yii\validators\Validator
$attributes	массив\|строка	Атрибуты, которые должны быть проверены этим валидатором.	yii\validators\Validator
$behaviors	yii\base\Behavior[]	Список поведений, прикреплённых к этому компоненту	yii\base\Component
$builtInValidators	массив	Список встроенных валидаторов (имя => класс или конфигурация)	yii\validators\Validator
$enableClientValidation	логическое значение	Включить проверку на стороне клиента для этого валидатора.	yii\validators\Validator
$encoding	строка	Кодировка значения строки, подлежащей проверке (например, 'UTF-8').	yii\validators\StringValidator
$except	массив\|строка	Сценарии, для которых валидатор не должен применяться.	yii\validators\Validator
$isEmpty	вызов функции	Функция PHP, которая заменяет стандартную реализацию isEmpty().	yii\validators\Validator
$length	целое число\|массив	Определяет предельную длину значения, подлежащего проверке.	yii\validators\StringValidator
$max	целое число	Максимальная длина.	yii\validators\StringValidator
$message	строка	Пользовательское сообщение об ошибке, используемое, когда значение не является строкой.	yii\validators\StringValidator
$min	целое число	Минимальная длина.	yii\validators\StringValidator
$notEqual	строка	Пользовательское сообщение об ошибке, используемое, когда длина значения не равна $length.	yii\validators\StringValidator
$on	массив\|строка	Сценарии, для которых валидатор может применяться.	yii\validators\Validator
$skipOnEmpty	логическое значение	Пропускать проверку, если значение атрибута равно null или пустой строке.	yii\validators\Validator
$skipOnError	логическое значение	Пропускать проверку, если у атрибута уже есть ошибка валидации по предыдущим правилам.	yii\validators\Validator
$tooLong	строка	Пользовательское сообщение об ошибке, используемое, когда длина значения больше, чем $max.	yii\validators\StringValidator
$tooShort	строка	Пользовательское сообщение об ошибке, используемое, когда длина значения меньше, чем $min.	yii\validators\StringValidator
$when	вызов функции	Функция PHP, результат которой определяет, следует ли применять этот валидатор.	yii\validators\Validator
$whenClient	строка	Имя JavaScript-функции, результат которой определяет, следует ли применять этот валидатор на стороне клиента.	yii\validators\Validator

Публичные методы

Метод	Описание	Определено в
__call()	Вызывает именованный метод, который не является методом класса.	yii\base\Component
__clone()	Этот метод вызывается после создания объекта путём клонирования существующего.	yii\base\Component
__construct()	Конструктор.	yii\base\Object
__get()	Возвращает значение свойства компонента.	yii\base\Component
__isset()	Проверяет, установлено ли свойство, т.е. определено и не равно null.	yii\base\Component
__set()	Устанавливает значение свойства компонента.	yii\base\Component
__unset()	Устанавливает свойство компонента в null.	yii\base\Component
addError()	Добавляет ошибку об указанном атрибуте в объект модели.	yii\validators\Validator
attachBehavior()	Присоединяет поведение к этому компоненту.	yii\base\Component
attachBehaviors()	Присоединяет список поведений к компоненту.	yii\base\Component
behaviors()	Возвращает список поведений, по которым должен вести себя этот компонент.	yii\base\Component
canGetProperty()	Возвращает значение, указывающее, можно ли прочитать свойство.	yii\base\Component
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Component
className()	Возвращает полное квалифицированное имя этого класса.	yii\base\Object
clientValidateAttribute()	Возвращает JavaScript, необходимый для выполнения проверки на стороне клиента.	yii\validators\StringValidator
createValidator()	Создаёт объект валидатора.	yii\validators\Validator
detachBehavior()	Отсоединяет поведение от компонента.	yii\base\Component
detachBehaviors()	Отсоединяет все поведения от компонента.	yii\base\Component
ensureBehaviors()	Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту.	yii\base\Component
getAttributeNames()	Возвращает очищенные имена атрибутов без символа `!` в начале	yii\validators\Validator
getBehavior()	Возвращает объект поведения с заданным именем.	yii\base\Component
getBehaviors()	Возвращает все присоединённые к этому компоненту поведения.	yii\base\Component
getClientOptions()	Возвращает параметры проверки на стороне клиента.	yii\validators\StringValidator
hasEventHandlers()	Возвращает значение, указывающее, есть ли какой-либо обработчик, прикреплённый к заданному событию.	yii\base\Component
hasMethod()	Возвращает значение, указывающее, определён ли метод.	yii\base\Component
hasProperty()	Возвращает значение, указывающее, определено ли свойство для этого компонента.	yii\base\Component
init()	Инициализирует объект.	yii\validators\StringValidator
isActive()	Возвращает значение, указывающее, активен ли валидатор для данного сценария и атрибута.	yii\validators\Validator
isEmpty()	Проверяет, пустое ли заданное значение.	yii\validators\Validator
off()	Отсоединяет существующий обработчик событий от этого компонента.	yii\base\Component
on()	Присоединяет обработчик событий к событию.	yii\base\Component
trigger()	Вызывает событие.	yii\base\Component
validate()	Проверяет заданное значение.	yii\validators\Validator
validateAttribute()	Проверяет один атрибут.	yii\validators\StringValidator
validateAttributes()	Проверяет указанный объект.	yii\validators\Validator

Защищённые методы

Метод	Описание	Определено в
formatMessage()	Форматирует сообщение с использованием I18N или простым strtr, если `\Yii::$app` недоступен.	yii\validators\Validator
validateValue()	Проверяет значение.	yii\validators\StringValidator

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

$encoding общедоступное свойство

Кодировка строкового значения, подлежащего проверке (например, 'UTF-8'). Если это свойство не задано, будет использоваться yii\base\Application::$charset.

public string $encoding = null

$length общедоступное свойство

Устанавливает ограничение длины значения, подлежащего проверке. Это может быть задано в одной из следующих форм:

целое число: точная длина, которой должно быть значение;
массив из одного элемента: минимальная длина, которой должно быть значение. Например, [8]. Это перепишет $min.
массив из двух элементов: минимальная и максимальная длины, которыми должно быть значение. Например, [8, 128]. Это перепишет как $min, так и $max.

См. также:

$tooShort для настраиваемого сообщения о слишком короткой строке.
$tooLong для настраиваемого сообщения о слишком длинной строке.
$notEqual для настраиваемого сообщения о строке, длина которой не соответствует требуемой.

public integer|array $length = null

$max общедоступное свойство

Максимальная длина. Если не задано, это означает, что ограничения по максимальной длине нет.

См. также $tooLong для настраиваемого сообщения о слишком длинной строке.

public integer $max = null

$message общедоступное свойство

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

public string $message = null

$min общедоступное свойство

Минимальная длина. Если не задано, это означает, что ограничения по минимальной длине нет.

См. также $tooShort для настраиваемого сообщения о слишком короткой строке.

public integer $min = null

$notEqual общедоступное свойство

Пользовательское сообщение об ошибке, используемое, когда длина значения не равна $length.

public string $notEqual = null

$tooLong общедоступное свойство

Пользовательское сообщение об ошибке, используемое, когда длина значения больше, чем $max.

public string $tooLong = null

$tooShort общедоступное свойство

Пользовательское сообщение об ошибке, используемое, когда длина значения меньше, чем $min.

public string $tooShort = null

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

clientValidateAttribute() общедоступный метод

Возвращает JavaScript, необходимый для выполнения проверки на стороне клиента.

Вызывает getClientOptions() для генерации массива параметров для проверки на стороне клиента.

Вы можете переопределить этот метод, чтобы вернуть код валидации JavaScript, если валидатор поддерживает валидацию на стороне клиента.

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

attribute: объект, описывающий атрибут, который проверяется.
value: проверяемое значение.
messages: массив, используемый для хранения сообщений об ошибках валидации для атрибута.
deferred: массив, используемый для хранения отложенных объектов для асинхронной проверки
$form: объект jQuery, содержащий элемент формы

Объект attribute содержит следующие свойства:

id: уникальный идентификатор, определяющий атрибут (например, "loginform-username") в форме
name: имя атрибута или выражение (например, "[0]content" для табличных данных)
container: селектор jQuery контейнера поля ввода
input: селектор jQuery поля ввода в контексте формы
error: селектор jQuery тега ошибки в контексте контейнера
status: состояние поля ввода, 0: пустое, не введено ранее, 1: проверенное, 2: ожидается проверка, 3: выполняется проверка

общедоступный строка\|null clientValidateAttribute ( $model, $attribute, $view )
$model	yii\base\Model	Проверяемая модель данных
$attribute	строка	Имя атрибута, который нужно проверить.
$view	yii\web\View	Объект представления, который будет использован для рендеринга представлений или файлов представлений, содержащих форму модели с примененным этим валидатором.
return	строка\|null	Сценарий проверки на стороне клиента. Null, если валидатор не поддерживает проверку на стороне клиента.

getClientOptions() общедоступный метод

Возвращает параметры проверки на стороне клиента.

Этот метод обычно вызывается из clientValidateAttribute(). Вы можете переопределить этот метод, чтобы изменить параметры, которые будут переданы в проверку на стороне клиента.

общедоступный массив getClientOptions ( $model, $attribute )
$model	yii\base\Model	Проверяемая модель
$attribute	строка	Имя атрибута, который проверяется
return	массив	Параметры проверки на стороне клиента

init() общедоступный метод

Инициализирует объект.

Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.

общедоступный void init ( )

validateAttribute() общедоступный метод

Проверяет один атрибут.

Подклассы должны реализовать этот метод для обеспечения фактической логики проверки.

общедоступный void validateAttribute ( $model, $attribute )
$model	yii\base\Model	Проверяемая модель данных
$attribute	строка	Имя атрибута, который нужно проверить.

validateValue() защищённый метод

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

Класс валидатора может реализовать этот метод, чтобы поддерживать проверку данных вне контекста модели данных.

защищённый массив\|null validateValue ( $value )
$value	смешанный	Значение данных, которое необходимо проверить.
return	массив\|null	Сообщение об ошибке и параметры, которые нужно вставить в сообщение об ошибке. Null должен возвращаться, если данные верны.
throws	yii\base\NotSupportedException	если валидатор не поддерживает проверку данных без модели

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-validators-stringvalidator.html