Spec-Zone.ru › Yii 2.0

Класс yii\validators\ImageValidator

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

ImageValidator проверяет, является ли атрибут допустимым изображением.

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

Свойство Тип Описание Определено в
$attributeNames массив Имена атрибутов. yii\validators\Validator
$attributes массив|строка Атрибуты, которые должны быть проверены этим валидатором. yii\validators\Validator
$behaviors yii\base\Behavior[] Список поведений, прикрепленных к этому компоненту. yii\base\Component
$builtInValidators массив Список встроенных валидаторов (имя => класс или конфигурация). yii\validators\Validator
$checkExtensionByMimeType булево Проверять тип файла (расширение) по MIME-типу. yii\validators\FileValidator
$enableClientValidation булево Включить валидацию на стороне клиента для этого валидатора. yii\validators\Validator
$except массив|строка Сценарии, для которых валидатор не должен применяться. yii\validators\Validator
$extensions массив|строка Список разрешенных расширений имен файлов для загрузки. yii\validators\FileValidator
$isEmpty вызов функции PHP-вызов, который заменяет стандартную реализацию isEmpty(). yii\validators\Validator
$maxFiles целое число Максимальное количество файлов для данного атрибута. yii\validators\FileValidator
$maxHeight целое число Максимальная ширина в пикселях. yii\validators\ImageValidator
$maxSize целое число Максимальный размер в байтах для загружаемого файла. yii\validators\FileValidator
$maxWidth целое число Максимальная ширина в пикселях. yii\validators\ImageValidator
$message строка Сообщение об ошибке, используемое, когда файл загружен некорректно. yii\validators\FileValidator
$mimeTypes массив|строка Список MIME-типов файлов, которые разрешено загружать. yii\validators\FileValidator
$minHeight целое число Минимальная высота в пикселях. yii\validators\ImageValidator
$minSize целое число Минимальный размер в байтах для загружаемого файла. yii\validators\FileValidator
$minWidth целое число Минимальная ширина в пикселях. yii\validators\ImageValidator
$notImage строка Сообщение об ошибке, используемое, когда загружаемый файл не является изображением. yii\validators\ImageValidator
$on массив|строка Сценарии, для которых может применяться валидатор. yii\validators\Validator
$overHeight строка Сообщение об ошибке, если изображение превышает $maxHeight. yii\validators\ImageValidator
$overWidth строка Сообщение об ошибке, если изображение превышает $maxWidth. yii\validators\ImageValidator
$sizeLimit целое число Предел размера загружаемых файлов. yii\validators\FileValidator
$skipOnEmpty булево Пропустить данное правило валидации, если значение атрибута равно null или пустая строка. yii\validators\Validator
$skipOnError булево Пропустить данное правило валидации, если у атрибута уже есть ошибка валидации согласно предыдущим правилам. yii\validators\Validator
$tooBig строка Сообщение об ошибке, если загруженный файл слишком большой. yii\validators\FileValidator
$tooMany строка Сообщение об ошибке, если количество одновременных загрузок превысило лимит. yii\validators\FileValidator
$tooSmall строка Сообщение об ошибке, если загруженный файл слишком мал. yii\validators\FileValidator
$underHeight строка Сообщение об ошибке, если высота изображения меньше $minHeight. yii\validators\ImageValidator
$underWidth строка Сообщение об ошибке, если ширина изображения меньше $minWidth. yii\validators\ImageValidator
$uploadRequired строка Сообщение об ошибке, если файл не загружен. yii\validators\FileValidator
$when вызов функции PHP-вызов, результат которого определяет, нужно ли применять этот валидатор. yii\validators\Validator
$whenClient строка Имя JavaScript-функции, результат которой определяет, нужно ли применять этот валидатор на стороне клиента. yii\validators\Validator
$wrongExtension строка Сообщение об ошибке, используемое, когда у загруженного файла имя расширения не указано в списке $extensions. yii\validators\FileValidator
$wrongMimeType строка Сообщение об ошибке, используемое, когда тип MIME файла не разрешен свойством $mimeTypes. yii\validators\FileValidator

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

Метод Описание Определено в
__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\ImageValidator
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\ImageValidator
getSizeLimit() Возвращает максимальный размер разрешенных для загрузки файлов. yii\validators\FileValidator
hasEventHandlers() Возвращает значение, указывающее, прикреплён ли обработчик к указанному событию. yii\base\Component
hasMethod() Возвращает значение, указывающее, определён ли метод. yii\base\Component
hasProperty() Возвращает значение, указывающее, определено ли свойство для этого компонента. yii\base\Component
init() Инициализирует объект. yii\validators\ImageValidator
isActive() Возвращает значение, указывающее, активен ли валидатор для данного сценария и атрибута. yii\validators\Validator
isEmpty() Проверяет, пустое ли заданное значение. yii\validators\FileValidator
off() Открепляет существующий обработчик событий от этого компонента. yii\base\Component
on() Прикрепляет обработчик событий к событию. yii\base\Component
trigger() Вызывает событие. yii\base\Component
validate() Проверяет заданное значение. yii\validators\Validator
validateAttribute() Проверяет один атрибут. yii\validators\FileValidator
validateAttributes() Проверяет указанный объект. yii\validators\Validator

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

Метод Описание Определено в
formatMessage() Форматирует сообщение с помощью I18N, или простой strtr, если \Yii::$app недоступен. yii\validators\Validator
validateExtension() Проверяет, имеет ли загруженный файл правильный тип (расширение) в соответствии с текущими настройками валидатора. yii\validators\FileValidator
validateImage() Проверяет изображение. yii\validators\ImageValidator
validateMimeType() Проверяет тип MIME $file против списка в свойстве $mimeTypes yii\validators\FileValidator
validateValue() Проверяет значение. yii\validators\ImageValidator

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

$maxHeight публичное свойство

Максимальная ширина в пикселях. По умолчанию null, что означает отсутствие ограничения.

См. также $overWidth для настраиваемого сообщения, используемого, когда высота изображения слишком большая.

public integer $maxHeight = null

$maxWidth публичное свойство

Максимальная ширина в пикселях. По умолчанию null, что означает отсутствие ограничения.

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

public integer $maxWidth = null

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

Минимальная высота в пикселях. По умолчанию null, что означает отсутствие ограничения.

См. также $underHeight для настраиваемого сообщения, используемого, когда высота изображения слишком мала.

public integer $minHeight = null

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

Минимальная ширина в пикселях. По умолчанию null, что означает отсутствие ограничения.

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

public integer $minWidth = null

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

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

  • {attribute}: имя атрибута
  • {file}: имя загруженного файла
public string $notImage = null

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

Сообщение об ошибке, используемое, когда изображение превышает $maxHeight. В сообщении можно использовать следующие маркеры:

  • {attribute}: имя атрибута
  • {file}: имя загруженного файла
  • {limit}: значение $maxHeight 
public string $overHeight = null

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

Сообщение об ошибке, используемое, когда изображение превышает $maxWidth. В сообщении можно использовать следующие маркеры:

  • {attribute}: имя атрибута
  • {file}: имя загруженного файла
  • {limit}: значение $maxWidth 
public string $overWidth = null

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

Сообщение об ошибке, используемое, когда изображение меньше $minHeight. В сообщении можно использовать следующие маркеры:

  • {attribute}: имя атрибута
  • {file}: имя загруженного файла
  • {limit}: значение $minHeight 
public string $underHeight = null

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

Сообщение об ошибке, используемое, когда изображение меньше $minWidth. В сообщении можно использовать следующие маркеры:

  • {attribute}: имя атрибута
  • {file}: имя загруженного файла
  • {limit}: значение $minWidth 
public string $underWidth = 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 ( )

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

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

защищенный массив|null validateImage ( $image )
$image yii\web\UploadedFile

Загруженный файл, переданный для проверки по набору правил
return массив|null

Сообщение об ошибке и параметры, которые должны быть вставлены в сообщение об ошибке. Null должен быть возвращён, если данные валидны.

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-imagevalidator.html

Spec-Zone.ru

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