Класс yii\mongodb\ActiveFixture
| Наследование | yii\mongodb\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-mongodb/blob/master/ActiveFixture.php |
ActiveFixture представляет фикстуру, основанную на классе MongoDB ActiveRecord или коллекции MongoDB.
Должен быть задан либо $modelClass, либо $collectionName. Также необходимо указать данные фикстуры в файле, указанном в $dataFile, или переопределить getData(), если требуется генерировать данные фикстуры программно.
При загрузке фикстуры сначала вызывается resetCollection() для удаления существующих данных в коллекции. Затем коллекция заполняется данными, возвращёнными методом getData().
После загрузки фикстуры доступ к загруженным данным можно получить через свойство $data. Если задано $modelClass, то можно также получить экземпляр $modelClass с заполненными данными через getModel().
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список присоединённых к этому компоненту поведений | yii\base\Component |
| $collectionName | строка|массив | Имя коллекции, к которой относится данная фикстура. | yii\mongodb\ActiveFixture |
| $data | массив | Строки данных. | yii\test\BaseActiveFixture |
| $dataFile | строка|логическое значение | Путь к файлу или псевдоним пути файла данных, содержащего данные фикстуры, которые возвращаются методом getData(). | yii\test\BaseActiveFixture |
| $db | yii\mongodb\Connection|строка | Объект соединения с БД или идентификатор компонента приложения для соединения с БД. | yii\mongodb\ActiveFixture |
| $depends | массив | Фикстуры, от которых зависит текущая фикстура. | yii\test\Fixture |
| $iterator | ArrayIterator | Итератор для обхода куков в коллекции. | 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\mongodb\ActiveFixture |
| load() | Загружает данные фикстуры. | yii\mongodb\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\BaseActiveFixture |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| getCollection() | Возвращает коллекцию, используемую этой фикстурой. | yii\mongodb\ActiveFixture |
| getCollectionName() | Возвращает имя коллекции, используемой этой фикстурой. | yii\mongodb\ActiveFixture |
| getData() | Возвращает данные фикстуры. | yii\mongodb\ActiveFixture |
| resetCollection() | Удаляет все существующие данные из указанной коллекции и сбрасывает номер последовательности, если он есть. | yii\mongodb\ActiveFixture |
Подробное описание свойств
$collectionName общедоступное свойство
Имя коллекции, к которой относится эта фикстура. Если это свойство не задано, имя коллекции будет определено через $modelClass.
См. также yii\mongodb\Connection::getCollection().
public string|array $collectionName = null
$db общедоступное свойство
Объект подключения к БД или идентификатор компонента приложения для подключения к БД.
public yii\mongodb\Connection|string $db = 'mongodb'
Подробное описание методов
getCollection() защищённый метод
Возвращает коллекцию, используемую этим фикстурой.
| защищённый yii\mongodb\Collection getCollection ( ) | ||
|---|---|---|
| return | yii\mongodb\Collection |
Соответствующая коллекция. |
getCollectionName() защищённый метод
Возвращает имя коллекции, используемой этой фикстурой.
| защищённый массив|строка getCollectionName ( ) | ||
|---|---|---|
| return | массив|строка |
Имя соответствующей коллекции |
getData() защищённый метод
Возвращает данные фикстуры.
Этот метод вызывается \yii\mongodb\loadData(), чтобы получить необходимые данные фикстуры.
По умолчанию, метод попытается вернуть данные фикстуры, включив внешний файл, указанный в $dataFile. Файл должен вернуть массив строк данных (имя столбца => значение столбца), каждая из которых соответствует строке в коллекции.
Если файл данных не существует, возвращается пустой массив.
| защищённый массив getData ( ) | ||
|---|---|---|
| return | массив |
Строки данных, которые будут вставлены в коллекцию. |
init() публичный метод
Инициализирует объект.
Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.
| публичный void init ( ) |
|---|
load() публичный метод
Загружает данные фикстуры.
По умолчанию, метод сначала сбросит коллекцию MongoDB, а затем заполнит её данными, возвращёнными методом getData().
| публичный void load ( ) |
|---|
resetCollection() защищённый метод
Удаляет все существующие данные из указанной коллекции и сбрасывает номер последовательности, если таковой имеется.
Этот метод вызывается перед заполнением данных фикстуры в коллекцию, связанную с этой фикстурой.
| защищённый void resetCollection ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-mongodb-activefixture.html
