Абстрактный класс yii\test\BaseActiveFixture
| Наследование | yii\test\BaseActiveFixture » yii\test\DbFixture » yii\test\Fixture » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | ArrayAccess, Countable, IteratorAggregate, yii\base\Configurable |
| Использует трейты | yii\base\ArrayAccessTrait |
| Подклассы | yii\elasticsearch\ActiveFixture, yii\mongodb\ActiveFixture, yii\sphinx\ActiveFixture, yii\test\ActiveFixture |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/test/BaseActiveFixture.php |
BaseActiveFixture — базовый класс для классов фикстур, которые поддерживают доступ к данным фикстур в качестве объектов ActiveRecord.
Для получения более подробной информации и справок по использованию BaseActiveFixture, обратитесь к статье руководства о фикстурах.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список прикреплённых к этому компоненту поведений | yii\base\Component |
| $data | массив | Строки данных. | yii\test\BaseActiveFixture |
| $dataFile | строка|логическое значение | Путь к файлу или псевдоним пути файла данных, содержащего данные фикстуры, которые будут возвращаться методом getData(). | yii\test\BaseActiveFixture |
| $db | yii\db\Connection|массив|строка | Объект подключения к базе данных или идентификатор компонента приложения для подключения к базе данных. | yii\test\DbFixture |
| $depends | массив | Фикстуры, от которых зависит эта фикстура. | yii\test\Fixture |
| $iterator | ArrayIterator | Итератор для обхода файлов cookie в коллекции. | yii\base\ArrayAccessTrait |
| $modelClass | строка | Класс модели AR, связанный с этой фикстурой. | yii\test\BaseActiveFixture |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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 |
| afterLoad() | Этот метод вызывается ПОСЛЕ загрузки всех данных фикстуры для текущего теста. | yii\test\Fixture |
| afterUnload() | Этот метод вызывается ПОСЛЕ разгрузки всех данных фикстуры для текущего теста. | yii\test\Fixture |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| beforeLoad() | Этот метод вызывается ДО загрузки любых данных фикстуры для текущего теста. | yii\test\Fixture |
| beforeUnload() | Этот метод вызывается ДО разгрузки любых данных фикстуры для текущего теста. | yii\test\Fixture |
| behaviors() | Возвращает список поведений, по которым должен вести себя этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Component |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Component |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| count() | Возвращает количество элементов данных. | yii\base\ArrayAccessTrait |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все присоединенные к этому компоненту поведения. | yii\base\Component |
| getIterator() | Возвращает итератор для обхода данных. | yii\base\ArrayAccessTrait |
| getModel() | Возвращает модель AR по указанному имени модели. | yii\test\BaseActiveFixture |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, присоединенный к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Component |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для этого компонента. | yii\base\Component |
| init() | Инициализирует объект. | yii\test\DbFixture |
| load() | Загружает фикстуру. | yii\test\BaseActiveFixture |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| offsetExists() | Этот метод необходим для интерфейса ArrayAccess. | yii\base\ArrayAccessTrait |
| offsetGet() | Этот метод необходим для интерфейса ArrayAccess. | yii\base\ArrayAccessTrait |
| offsetSet() | Этот метод необходим для интерфейса ArrayAccess. | yii\base\ArrayAccessTrait |
| offsetUnset() | Этот метод необходим для интерфейса ArrayAccess. | yii\base\ArrayAccessTrait |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| trigger() | Вызывает событие. | yii\base\Component |
| unload() | Разгружает фикстуру. | yii\test\BaseActiveFixture |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| getData() | Возвращает данные фикстуры. | yii\test\BaseActiveFixture |
Подробное описание свойств
$data общедоступное свойство
Строки данных. Каждый элемент массива представляет одну строку данных (имя столбца => значение столбца).
public array $data = []
$dataFile общедоступное свойство
Путь к файлу или псевдоним пути файла данных, содержащего данные фикстуры, которые должны быть возвращены методом getData(). Вы можете установить это свойство в false, чтобы предотвратить загрузку каких-либо данных.
public string|boolean $dataFile = null
$modelClass общедоступное свойство
Класс модели AR, связанный с этой фикстурой.
public string $modelClass = null
Подробное описание методов
getData() защищённый метод
Возвращает данные фикстуры.
Реализация по умолчанию попытается вернуть данные фикстуры, включив внешний файл, указанный в $dataFile. Файл должен возвращать массив данных, который будет сохранён в $data после вставки в базу данных.
| защищённый массив getData ( ) | ||
|---|---|---|
| return | массив |
Данные, которые должны быть помещены в базу данных |
| throws | yii\base\InvalidConfigException |
если указанный файл данных не существует. |
getModel() публичный метод
Возвращает модель AR по заданному имени модели.
Имя модели — это ключ соответствующей строки данных в $data.
| публичный null|yii\db\ActiveRecord getModel ( $name ) | ||
|---|---|---|
| $name | строка |
Имя модели. |
| return | null|yii\db\ActiveRecord |
Модель AR или null, если модель не найдена в базе данных |
| throws | yii\base\InvalidConfigException |
если $modelClass не задан. |
load() публичный метод
Загружает фикстуру.
Реализация по умолчанию просто сохраняет данные, возвращаемые методом getData(), в $data. Обычно необходимо переопределить этот метод, поместив данные в базу данных.
| публичный void load ( ) |
|---|
unload() публичный метод
Разгружает фикстуру.
Этот метод вызывается после завершения каждого тестового метода. Вы можете переопределить этот метод, чтобы выполнить необходимые действия по очистке для фикстуры.
| публичный void unload ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-test-baseactivefixture.html
