Spec-Zone.ru › Yii 2.0

Класс yii\httpclient\debug\SearchModel

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

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

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

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

Метод Описание Определён в
__call() Вызывает именованный метод, который не является методом класса. yii\base\Object
__clone() Этот метод вызывается после создания объекта путём клонирования существующего. yii\base\Component
__construct() Конструктор. yii\base\Object
__get() Возвращает значение свойства объекта. yii\base\Object
__isset() Проверяет, установлено ли свойство, т.е. определено и не равно null. yii\base\Object
__set() Устанавливает значение свойства объекта. yii\base\Object
__unset() Устанавливает свойство объекта в null. yii\base\Object
activeAttributes() Возвращает имена атрибутов, которые подлежат валидации в текущем сценарии. yii\base\Model
addCondition() Добавляет условие фильтрации для заданного атрибута yii\debug\models\search\Base
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\httpclient\debug\SearchModel
attributes() Возвращает список имён атрибутов. yii\base\Model
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() Возвращает валидаторы, применимые к текущему $сценарий. 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\base\Object
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\httpclient\debug\SearchModel
safeAttributes() Возвращает имена атрибутов, которые безопасны для массового присваивания в текущей ситуации. yii\base\Model
scenarios() Возвращает список сценариев и соответствующих активных атрибутов. yii\base\Model
search() Возвращает поставщик данных с заполненными моделями. Если необходимо, применяется фильтр. yii\httpclient\debug\SearchModel
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

Подробности свойств

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

Метод входного значения поиска

public string $method = null

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

Атрибут запроса входного значения поиска

public integer $request = null

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

Тип входного значения поиска

public string $type = null

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

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

Возвращает метки атрибутов.

Метки атрибутов используются в основном для отображения. Например, задан атрибут firstName, мы можем объявить метку First Name, которая более удобна для пользователя и может отображаться конечным пользователям.

По умолчанию метка атрибута генерируется с помощью generateAttributeLabel(). Этот метод позволяет явно указать метки атрибутов.

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

public массив attributeLabels ( )
return массив

Метки атрибутов (имя => метка)

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

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

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

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

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

где

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

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

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

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

Yii также предоставляет набор встроенных валидаторов \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().

public массив rules ( )
return массив

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

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

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

public yii\data\ArrayDataProvider search ( $params, $models )
$params массив

Массив значений параметров, индексированных по именам параметров

$models массив

Данные для возврата поставщиком

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

Spec-Zone.ru

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