Spec-Zone.ru › Yii 2.0

Класс yii\debug\models\search\User

Все классы | Свойства | Методы | События | Константы
Наследование yii\debug\models\search\User » yii\base\Model » yii\base\Component » yii\base\Object
Реализует ArrayAccess, IteratorAggregate, yii\base\Arrayable, yii\base\Configurable
Использует трейты yii\base\ArrayableTrait
Доступно с версии 2.0.10
Исходный код https://github.com/yiisoft/yii2-debug/blob/master/models/search/User.php

Модель поиска для реализации интерфейса IdentityInterface

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

Свойство Тип Описание Определено в
$activeValidators yii\validators\Validator[] Валидаторы, применимые к текущему $сценарий. yii\base\Model
$attributes массив Значения атрибутов (имя => значение). yii\base\Model
$behaviors yii\base\Behavior[] Список поведений, прикрепленных к этому компоненту yii\base\Component
$errors массив Ошибки для всех атрибутов или указанного атрибута. yii\base\Model
$firstErrors массив Первые ошибки. yii\base\Model
$identityImplement yii\base\Model Реализация интерфейса IdentityInterface yii\debug\models\search\User
$iterator ArrayIterator Итератор для обхода элементов в списке. yii\base\Model
$сценарий строка Сценарий, в котором находится эта модель. yii\base\Model
$validators ArrayObject|yii\validators\Validator[] Все валидаторы, объявленные в модели. yii\base\Model

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

Метод Описание Определено в
__call() Вызывает именованный метод, который не является методом класса. yii\base\Object
__clone() Этот метод вызывается после создания объекта путем клонирования существующего. yii\base\Component
__construct() Конструктор. yii\base\Object
__get() Возвращает значение свойства компонента. yii\debug\models\search\User
__isset() Проверяет, установлено ли свойство, т.е. определено и не равно null. yii\base\Object
__set() Устанавливает значение свойства компонента. yii\debug\models\search\User
__unset() Устанавливает свойство объекта в null. yii\base\Object
activeAttributes() Возвращает имена атрибутов, которые подлежат валидации в текущем сценарии. yii\base\Model
addError() Добавляет новую ошибку к указанному атрибуту. yii\base\Model
addErrors() Добавляет список ошибок. yii\base\Model
afterValidate() Этот метод вызывается после завершения валидации. yii\base\Model
attachBehavior() Прикрепляет поведение к этому компоненту. yii\base\Component
attachBehaviors() Прикрепляет список поведений к компоненту. yii\base\Component
attributeHints() Возвращает подсказки к атрибутам. yii\base\Model
attributeLabels() Возвращает метки атрибутов. yii\base\Model
attributes() Возвращает список имён атрибутов. yii\debug\models\search\User
beforeValidate() Этот метод вызывается перед началом валидации. yii\base\Model
behaviors() Возвращает список поведений, по которым должен действовать этот компонент. yii\base\Component
canGetProperty() Возвращает значение, указывающее, можно ли считать свойство. yii\base\Object
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Object
className() Возвращает полное имя этого класса. yii\base\Object
clearErrors() Удаляет ошибки для всех атрибутов или одного атрибута. yii\base\Model
createValidators() Создаёт объекты валидаторов на основе правил валидации, указанных в rules(). yii\base\Model
detachBehavior() Открепляет поведение от компонента. yii\base\Component
detachBehaviors() Открепляет все поведения от компонента. yii\base\Component
ensureBehaviors() Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. yii\base\Component
extraFields() Возвращает список полей, которые можно дополнительно расширить и вернуть методом toArray(). yii\base\ArrayableTrait
fields() Возвращает список полей, которые по умолчанию должны возвращаться методом toArray(), когда не указаны конкретные поля. yii\base\ArrayableTrait
formName() Возвращает имя формы, которое должен использовать этот класс модели. yii\base\Model
generateAttributeLabel() Генерирует удобочитаемую метку атрибута на основе имени атрибута. yii\base\Model
getActiveValidators() Возвращает валидаторы, применимые к текущему $scenario. yii\base\Model
getAttributeHint() Возвращает подсказку для указанного атрибута. yii\base\Model
getAttributeLabel() Возвращает текстовую метку для указанного атрибута. yii\base\Model
getAttributes() Возвращает значения атрибутов. yii\base\Model
getBehavior() Возвращает объект именованного поведения. yii\base\Component
getBehaviors() Возвращает все поведения, прикреплённые к этому компоненту. yii\base\Component
getErrors() Возвращает ошибки для всех атрибутов или одного атрибута. yii\base\Model
getFirstError() Возвращает первую ошибку указанного атрибута. yii\base\Model
getFirstErrors() Возвращает первую ошибку каждого атрибута в модели. yii\base\Model
getIterator() Возвращает итератор для обхода атрибутов в модели. yii\base\Model
getScenario() Возвращает сценарий, в котором используется эта модель. yii\base\Model
getValidators() Возвращает все валидаторы, объявленные в rules(). yii\base\Model
hasErrors() Возвращает значение, указывающее, есть ли ошибки валидации. yii\base\Model
hasEventHandlers() Возвращает значение, указывающее, есть ли обработчики, прикреплённые к указанному событию. yii\base\Component
hasMethod() Возвращает значение, указывающее, определён ли метод. yii\base\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует объект. yii\debug\models\search\User
isAttributeActive() Возвращает значение, указывающее, активен ли атрибут в текущем сценарии. yii\base\Model
isAttributeRequired() Возвращает значение, указывающее, обязателен ли атрибут. yii\base\Model
isAttributeSafe() Возвращает значение, указывающее, безопасен ли атрибут для массового назначения. yii\base\Model
load() Заполняет модель входными данными. yii\base\Model
loadMultiple() Заполняет набор моделей данными от конечного пользователя. yii\base\Model
off() Отсоединяет существующий обработчик событий от этого компонента. yii\base\Component
offsetExists() Возвращает, существует ли элемент по указанному смещению. yii\base\Model
offsetGet() Возвращает элемент по указанному смещению. yii\base\Model
offsetSet() Устанавливает элемент по указанному смещению. yii\base\Model
offsetUnset() Устанавливает значение элемента по указанному смещению в null. yii\base\Model
on() Присоединяет обработчик событий к событию. yii\base\Component
onUnsafeAttribute() Этот метод вызывается, когда небезопасный атрибут массово присваивается. yii\base\Model
rules() Возвращает правила валидации для атрибутов. yii\debug\models\search\User
safeAttributes() Возвращает имена атрибутов, которые безопасно массово присваивать в текущей ситуации. yii\base\Model
scenarios() Возвращает список сценариев и соответствующих активных атрибутов. yii\base\Model
search() yii\debug\models\search\User
setAttributes() Устанавливает значения атрибутов массовым способом. yii\base\Model
setScenario() Устанавливает сценарий для модели. yii\base\Model
toArray() Преобразует модель в массив. yii\base\ArrayableTrait
trigger() Вызывает событие. yii\base\Component
validate() Выполняет проверку данных. yii\base\Model
validateMultiple() Проверяет несколько моделей. yii\base\Model

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

Метод Описание Определено
resolveFields() Определяет, какие поля могут быть возвращены методом toArray(). yii\base\ArrayableTrait

События

Событие Тип Описание Определено
EVENT_AFTER_VALIDATE yii\base\Event Событие, генерируемое в конце validate() yii\base\Model
EVENT_BEFORE_VALIDATE yii\base\ModelEvent Событие, генерируемое в начале validate(). yii\base\Model

Константы

Константа Значение Описание Определено
SCENARIO_DEFAULT 'default' Имя сценария по умолчанию. yii\base\Model

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

$identityImplement public property

Реализация интерфейса IdentityInterface

public yii\base\Model $identityImplement = null

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

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

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

Этот метод будет проверять в следующем порядке и действовать соответственно:

  • свойство, определённое геттером: вернуть результат геттера
  • свойство поведения: вернуть значение свойства поведения

Не вызывайте этот метод напрямую, так как это магический метод PHP, который будет неявно вызываться при выполнении $value = $component->property;.

общедоступный смешанный __get ( $name )
$name строка

Имя свойства

return смешанный

Значение свойства или значение свойства поведения

throws yii\base\UnknownPropertyException

если свойство не определено

throws yii\base\InvalidCallException

если свойство только для записи.

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

Устанавливает значение свойства компонента.

Этот метод будет проверять в следующем порядке и действовать соответственно:

  • свойство, определённое сеттером: установить значение свойства
  • событие в формате "on xyz": присоединить обработчик к событию "xyz"
  • поведение в формате "as xyz": присоединить поведение с именем "xyz"
  • свойство поведения: установить значение свойства поведения

Не вызывайте этот метод напрямую, так как это магический метод PHP, который будет неявно вызываться при выполнении $component->property = $value;.

общедоступный void __set ( $name, $value )
$name строка

Имя свойства или имя события

$value смешанный

Значение свойства

throws yii\base\UnknownPropertyException

если свойство не определено

throws yii\base\InvalidCallException

если свойство только для чтения.

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

Возвращает список имён атрибутов.

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

общедоступный массив attributes ( )
return массив

Список имён атрибутов.

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

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

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

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

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

Возвращает правила валидации для атрибутов.

Правила валидации используются методом validate() для проверки того, являются ли значения атрибутов допустимыми. Дочерние классы могут переопределить этот метод, чтобы объявить различные правила валидации.

Каждое правило представляет собой массив со следующей структурой:

[
    ['attribute1', 'attribute2'],
    'validator type',
    'on' => ['scenario1', 'scenario2'],
    //...other parameters...
]

где

  • список атрибутов: обязательный, указывает массив атрибутов для валидации, для одиночного атрибута можно передать строку;
  • тип валидатора: обязательный, указывает используемый валидатор. Это может быть встроенное имя валидатора, имя метода модели класса, анонимная функция или имя класса валидатора.
  • on: необязательный, указывает массив сценариев, в которых правило валидации может применяться. Если этот параметр не установлен, правило будет применяться ко всем сценариям.
  • дополнительные пары имя-значение могут быть указаны для инициализации соответствующих свойств валидатора. Для возможных свойств обратитесь к API отдельных классов валидаторов.

Валидатор может быть либо объектом класса, расширяющего \yii\debug\models\search\Validator, либо методом класса модели (называемый встроенным валидатором), который имеет следующий сигнатуру:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

В $attribute выше ссылается на атрибут, который в данный момент валидируется, а $params содержит массив настроек валидатора, таких как max в случае валидатора string. Значение атрибута, который в данный момент валидируется, можно получить как $this->$attribute. Обратите внимание на $ перед attribute; это используется значение переменной $attribute в качестве имени свойства для доступа.

Yii также предоставляет набор \yii\debug\models\search\Validator::builtInValidators. Каждый из них имеет псевдоним, который можно использовать при указании правила валидации.

Ниже приведены некоторые примеры:

[
    // built-in "required" validator
    [['username', 'password'], 'required'],
    // built-in "string" validator customized with "min" and "max" properties
    ['username', 'string', 'min' => 3, 'max' => 12],
    // built-in "compare" validator that is used in "register" scenario only
    ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
    // an inline validator defined via the "authenticate()" method in the model class
    ['password', 'authenticate', 'on' => 'login'],
    // a validator of class "DateRangeValidator"
    ['dateRange', 'DateRangeValidator'],
];

Обратите внимание, для наследования правил, определённых в родительском классе, дочернему классу необходимо объединить родительские правила с правилами дочернего класса, используя функции, такие как array_merge().

общедоступный массив rules ( )
return массив

Правила валидации

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

общедоступный void search ( $params )
$params

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

Spec-Zone.ru

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