Spec-Zone.ru › Yii 2.0

Class yii\debug\models\search\Debug

Все классы | Свойства | Методы | События | Константы
Наследование yii\debug\models\search\Debug » 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
Доступно с версии 2.0
Исходный код https://github.com/yiisoft/yii2-debug/blob/master/models/search/Debug.php

Модель поиска данных о манифесте запросов.

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

Свойство Тип Описание Определено в
$activeValidators yii\validators\Validator[] Валидаторы, применимые к текущему $сценарий. yii\base\Model
$ajax целое число Значение поиска атрибута ввода AJAX yii\debug\models\search\Debug
$attributes массив Значения атрибутов (имя => значение). yii\base\Model
$behaviors yii\base\Behavior[] Список прикрепленных к этому компоненту поведений. yii\base\Component
$criticalCodes массив Критические коды, используемые для определения параметров строки сетки. yii\debug\models\search\Debug
$errors массив Ошибки для всех атрибутов или указанного атрибута. yii\base\Model
$firstErrors массив Первые ошибки. yii\base\Model
$ip строка Значение поиска атрибута ввода IP yii\debug\models\search\Debug
$iterator ArrayIterator Итератор для обхода элементов в списке. yii\base\Model
$mailCount целое число Общее количество почтовых сообщений. Значение поиска атрибута ввода yii\debug\models\search\Debug
$method строка Значение поиска атрибута ввода метода yii\debug\models\search\Debug
$scenario строка Сценарий, в котором находится эта модель. yii\base\Model
$sqlCount целое число Значение поиска атрибута ввода sql count yii\debug\models\search\Debug
$statusCode строка Значение поиска атрибута ввода кода состояния yii\debug\models\search\Debug
$tag строка Значение поиска атрибута ввода тега yii\debug\models\search\Debug
$url строка Значение поиска атрибута ввода URL yii\debug\models\search\Debug
$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\debug\models\search\Debug
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() Возвращает валидаторы, применимые к текущей $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\base\Object
isAttributeActive() Возвращает значение, указывающее, активен ли атрибут в текущей сценарии. yii\base\Model
isAttributeRequired() Возвращает значение, указывающее, обязателен ли атрибут. yii\base\Model
isAttributeSafe() Возвращает значение, указывающее, является ли атрибут безопасным для массового назначения. yii\base\Model
isCodeCritical() Проверяет, является ли код критическим. yii\debug\models\search\Debug
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\Debug
safeAttributes() Возвращает имена атрибутов, которые безопасно назначить массово в текущей ситуации. yii\base\Model
scenarios() Возвращает список сценариев и соответствующих активных атрибутов. yii\base\Model
search() Возвращает поставщик данных с заполненными моделями. При необходимости применяется фильтр. yii\debug\models\search\Debug
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

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

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

Значение ввода поиска атрибута Ajax

public integer $ajax = null

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

Критические коды, используемые для определения опций строки сетки.

public array $criticalCodes = [400, 404, 500]

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

Значение ввода поиска атрибута Ip

public string $ip = null

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

Общее значение подсчета почты атрибута ввода поиска

public integer $mailCount = null

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

Значение ввода поиска атрибута Method

public string $method = null

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

Значение ввода поиска атрибута Sql count

public integer $sqlCount = null

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

Значение ввода поиска атрибута Status code

public string $statusCode = null

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

Значение ввода поиска атрибута Tag

public string $tag = null

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

Значение ввода поиска атрибута Url

public string $url = null

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

attributeLabels() public method

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

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

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

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

public array attributeLabels ( )
return array

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

isCodeCritical() public method

Проверяет, является ли код критическим.

public boolean isCodeCritical ( $code )
$code integer

rules() public method

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

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

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

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

где

  • список атрибутов: обязательный, указывает массив атрибутов для проверки, для отдельного атрибута можно передать строку;
  • тип валидатора: обязательный, указывает используемый валидатор. Это может быть встроенное имя валидатора, имя метода класса модели, анонимная функция или имя класса валидатора.
  • on: необязательный, указывает массив сценариев scenarios, в которых может применяться правило проверки. Если этот параметр не установлен, правило будет применяться ко всем сценариям.
  • дополнительные пары имя-значение могут быть указаны для инициализации соответствующих свойств валидатора. Обратитесь к 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().

public array rules ( )
return array

Правила проверки

search() public method

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

public yii\data\ArrayDataProvider search ( $params, $models )
$params array

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

$models array

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

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

Spec-Zone.ru

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