Класс yii\test\ActiveFixture
| Наследование | yii\test\ActiveFixture » yii\test\BaseActiveFixture » yii\test\DbFixture » yii\test\Fixture » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | ArrayAccess, Countable, IteratorAggregate, yii\base\Configurable |
| Использует Трейты | yii\base\ArrayAccessTrait |
| Доступно начиная с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/test/ActiveFixture.php |
ActiveFixture представляет фикстуру, основанную на классе ActiveRecord или таблице базы данных.
Необходимо задать либо $modelClass, либо $tableName. Также вы должны предоставить данные фикстуры в файле, указанном в $dataFile, или переопределить getData(), если вы хотите использовать код для генерации данных фикстуры.
При загрузке фикстуры, она сначала вызовет resetTable() для удаления любых существующих данных в таблице. Затем она заполнит таблицу данными, возвращенными getData().
После загрузки фикстуры, вы можете получить доступ к загруженным данным через свойство $data. Если вы задали $modelClass, вы также сможете получить экземпляр $modelClass с заполненными данными через getModel().
Для получения более подробной информации и использования ActiveFixture, см. статью руководства о фикстурах.
Публичные Свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список присоединенных к этому компоненту поведений | yii\base\Component |
| $data | массив | Строки данных. | yii\test\BaseActiveFixture |
| $dataFile | строка|булево | Путь к файлу или псевдоним пути файла данных, содержащего данные фикстуры, которые должны возвращаться методом getData(). | yii\test\ActiveFixture |
| $db | yii\db\Connection|массив|строка | Объект подключения к БД или идентификатор компонента приложения для подключения к БД. | yii\test\DbFixture |
| $depends | массив | Фикстуры, от которых зависит эта фикстура. | yii\test\Fixture |
| $iterator | ArrayIterator | Итератор для обхода файлов cookie в коллекции. | yii\base\ArrayAccessTrait |
| $modelClass | строка | Класс модели AR, связанной с этой фикстурой. | yii\test\BaseActiveFixture |
| $tableName | строка | Имя таблицы базы данных, к которой относится эта фикстура. | yii\test\ActiveFixture |
| $tableSchema | yii\db\TableSchema | Схематическая информация таблицы базы данных, связанной с этой фикстурой. | yii\test\ActiveFixture |
Публичные Методы
| Метод | Описание | Определено в |
|---|---|---|
| __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 |
| getTableSchema() | yii\test\ActiveFixture | |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли какой-либо обработчик, прикрепленный к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Component |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для этого компонента. | yii\base\Component |
| init() | Инициализирует объект. | yii\test\ActiveFixture |
| load() | Загружает фикстуру. | yii\test\ActiveFixture |
| 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\ActiveFixture |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| getData() | Возвращает данные фикстуры. | yii\test\ActiveFixture |
| resetTable() | Удаляет все существующие данные из указанной таблицы и сбрасывает номер последовательности до 1 (если таковой имеется). | yii\test\ActiveFixture |
Подробное описание свойств
$dataFile общедоступное свойство
Путь к файлу или псевдоним пути файла данных, содержащего данные фикстуры, которые должны возвращаться методом getData(). Если это свойство не установлено, оно по умолчанию будет равно FixturePath/data/TableName.php, где FixturePath обозначает директорию, содержащую этот класс фикстуры, а TableName обозначает имя таблицы, связанной с этой фикстурой. Вы можете установить это свойство в значение false, чтобы предотвратить загрузку данных.
public string|boolean $dataFile = null
$tableName общедоступное свойство
Имя таблицы базы данных, к которой относится эта фикстура. Если это свойство не установлено, имя таблицы будет определено через $modelClass.
См. также $modelClass.
public string $tableName = null
$tableSchema общедоступное только для чтения свойство
Справочная информация по схеме таблицы базы данных, связанной с этой фикстурой.
public yii\db\TableSchema getTableSchema ( )
Подробное описание методов
getData() protected method
Возвращает данные фикстуры.
Реализация по умолчанию попытается вернуть данные фикстуры, включив внешний файл, указанный в $dataFile. Файл должен возвращать массив строк данных (имя столбца => значение столбца), каждая из которых соответствует строке в таблице.
Если файл данных не существует, будет возвращён пустой массив.
| protected array getData ( ) | ||
|---|---|---|
| return | array |
Строки данных, которые должны быть вставлены в таблицу базы данных. |
getTableSchema() public method
| public yii\db\TableSchema getTableSchema ( ) | ||
|---|---|---|
| return | yii\db\TableSchema |
Информация о схеме таблицы базы данных, связанной с этой фикстурой. |
| throws | yii\base\InvalidConfigException |
если таблица не существует |
init() public method
Инициализирует объект.
Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.
| public void init ( ) |
|---|
load() public method
Загружает фикстуру.
Заполняет таблицу данными, возвращаемыми getData().
Если вы переопределяете этот метод, вы должны рассмотреть возможность вызова родительской реализации, чтобы данные, возвращаемые getData(), можно было заполнить в таблицу.
| public void load ( ) |
|---|
resetTable() protected method
Удаляет все существующие данные из указанной таблицы и сбрасывает порядковый номер до 1 (если есть).
Этот метод вызывается перед заполнением данных фикстуры в таблицу, связанную с этой фикстурой.
| protected void resetTable ( ) |
|---|
unload() public method
Выгружает фикстуру.
Этот метод вызывается после завершения каждого тестового метода. Вы можете переопределить этот метод, чтобы выполнить необходимые действия по очистке для фикстуры.
| public void unload ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-test-activefixture.html
