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