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