# Class yii\elasticsearch\ActiveFixture

Inheritance | yii\elasticsearch\ActiveFixture » yii\test\BaseActiveFixture » yii\test\DbFixture » yii\test\Fixture » yii\base\Component » yii\base\BaseObject
Implements | ArrayAccess, Countable, IteratorAggregate, yii\base\Configurable
Uses Traits | yii\base\ArrayAccessTrait, yii\test\FileFixtureTrait
Available since version | 2.0.2
Source Code | https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveFixture.php

ActiveFixture represents a fixture for testing backed up by an ActiveRecord class or an elastic search index.

Either $modelClass or $index and $type must be set. You should also provide fixture data in the file specified by $dataFile or overriding getData() if you want to use code to generate the fixture data.

When the fixture is being loaded, it will first call resetIndex() to remove any existing data in the index for the $type. It will then populate the index with the data returned by getData().

After the fixture is loaded, you can access the loaded data via the $data property. If you set $modelClass, you will also be able to retrieve an instance of $modelClass with the populated data via getModel().

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component
$data | array |  | yii\base\ArrayAccessTrait
$dataDirectory | string | The directory path or path alias that contains the fixture data | yii\test\FileFixtureTrait
$dataFile | string|boolean | The file path or path alias of the data file that contains the fixture data to be returned by getData(). | yii\elasticsearch\ActiveFixture
$db | yii\elasticsearch\Connection|string | The DB connection object or the application component ID of the DB connection. | yii\elasticsearch\ActiveFixture
$depends | array | The fixtures that this fixture depends on. | yii\test\Fixture
$index | string | The name of the index that this fixture is about. | yii\elasticsearch\ActiveFixture
$iterator | ArrayIterator | An iterator for traversing the cookies in the collection. | yii\base\ArrayAccessTrait
$modelClass | string | The AR model class associated with this fixture. | yii\test\BaseActiveFixture
$type | string | The name of the type that this fixture is about. | yii\elasticsearch\ActiveFixture

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\Component
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component
__construct() | Constructor. | yii\base\BaseObject
__get() | Returns the value of a component property. | yii\base\Component
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component
__set() | Sets the value of a component property. | yii\base\Component
__unset() | Sets a component property to be null. | yii\base\Component
afterLoad() | This method is called AFTER all fixture data have been loaded for the current test. | yii\test\Fixture
afterUnload() | This method is called AFTER all fixture data have been unloaded for the current test. | yii\test\Fixture
attachBehavior() | Attaches a behavior to this component. | yii\base\Component
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component
beforeLoad() | This method is called BEFORE any fixture data is loaded for the current test. | yii\test\Fixture
beforeUnload() | This method is called BEFORE any fixture data is unloaded for the current test. | yii\test\Fixture
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
count() | Returns the number of data items. | yii\base\ArrayAccessTrait
detachBehavior() | Detaches a behavior from the component. | yii\base\Component
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component
getBehavior() | Returns the named behavior object. | yii\base\Component
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component
getIterator() | Returns an iterator for traversing the data. | yii\base\ArrayAccessTrait
getModel() | Returns the AR model by the specified model name. | yii\test\BaseActiveFixture
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component
init() | Initializes the object. | yii\elasticsearch\ActiveFixture
load() | Loads the fixture. | yii\elasticsearch\ActiveFixture
off() | Detaches an existing event handler from this component. | yii\base\Component
offsetExists() | This method is required by the interface ArrayAccess. | yii\base\ArrayAccessTrait
offsetGet() | This method is required by the interface ArrayAccess. | yii\base\ArrayAccessTrait
offsetSet() | This method is required by the interface ArrayAccess. | yii\base\ArrayAccessTrait
offsetUnset() | This method is required by the interface ArrayAccess. | yii\base\ArrayAccessTrait
on() | Attaches an event handler to an event. | yii\base\Component
trigger() | Triggers an event. | yii\base\Component
unload() | Unloads the fixture. | yii\test\BaseActiveFixture

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
getData() | Returns the fixture data. | yii\elasticsearch\ActiveFixture
loadData() | Returns the fixture data. | yii\test\FileFixtureTrait
resetIndex() | Removes all existing data from the specified index and type. | yii\elasticsearch\ActiveFixture

## Property Details

$dataFile public property

The file path or path alias of the data file that contains the fixture data to be returned by getData(). If this is not set, it will default to `FixturePath/data/Index/Type.php`, where `FixturePath` stands for the directory containing this fixture class, `Index` stands for the elasticsearch $index name and `Type` stands for the $type associated with this fixture. You can set this property to be false to prevent loading any data.

public string|boolean $dataFile = null
$db public property

The DB connection object or the application component ID of the DB connection. After the DbFixture object is created, if you want to change this property, you should only assign it with a DB connection object.

public yii\elasticsearch\Connection|string $db = 'elasticsearch'
$index public property

The name of the index that this fixture is about. If this property is not set, the name will be determined via $modelClass.

See also $modelClass.

public string $index = null
$type public property

The name of the type that this fixture is about. If this property is not set, the name will be determined via $modelClass.

See also $modelClass.

public string $type = null

## Method Details

getData() protected method

Returns the fixture data.

The default implementation will try to return the fixture data by including the external file specified by $dataFile. The file should return an array of data rows (column name => column value), each corresponding to a row in the index.

If the data file does not exist, an empty array will be returned.

protected array getData ( )
return | array | The data rows to be inserted into the database index.

init() public method

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

load() public method

Loads the fixture.

The default implementation will first clean up the index by calling resetIndex(). It will then populate the index with the data returned by getData().

If you override this method, you should consider calling the parent implementation so that the data returned by getData() can be populated into the index.

public void load ( )

resetIndex() protected method

Removes all existing data from the specified index and type.

This method is called before populating fixture data into the index associated with this fixture.

protected void resetIndex ( )