Spec-Zone.ru › Yii 2.0

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

Все классы | Свойства | Методы | События | Константы
Наследование yii\debug\models\search\Log » 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/Log.php

Модель поиска для текущего журнала запросов.

Общедоступные свойства

Свойство Тип Описание Определено
$activeValidators yii\validators\Validator[] Валидаторы, применимые к текущему $сценарий. yii\base\Model
$attributes массив Значения атрибутов (имя => значение). yii\base\Model
$behaviors yii\base\Behavior[] Список поведений, присоединённых к этому компоненту yii\base\Component
$category строка Ввод поиска по атрибуту метода yii\debug\models\search\Log
$errors массив Ошибки для всех атрибутов или указанного атрибута. yii\base\Model
$firstErrors массив Первые ошибки. yii\base\Model
$iterator ArrayIterator Итератор для обхода элементов в списке. yii\base\Model
$level строка Значение ввода поиска по атрибуту IP yii\debug\models\search\Log
$message целое число Значение ввода поиска по атрибуту сообщения yii\debug\models\search\Log
$scenario строка Сценарий, в котором находится эта модель. 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\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\Log
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
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\Log
safeAttributes() Возвращает имена атрибутов, которые безопасно назначить массово в текущем сценарии. yii\base\Model
scenarios() Возвращает список сценариев и соответствующие активные атрибуты. yii\base\Model
search() Возвращает поставщик данных с заполненными моделями. При необходимости применяется фильтр. yii\debug\models\search\Log
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

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

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

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

public string $category = null

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

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

public string $level = null

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

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

public integer $message = null

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

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

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

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

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

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

public массив attributeLabels ( )
возвращает массив

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

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().

public массив rules ( )
возвращает массив

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

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-debug-models-search-log.html

Spec-Zone.ru

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