ActiveFixture

API reference › yii › test › ActiveFixture

class	`yii\test\ActiveFixture`
Extends	`BaseActiveFixture` » `DbFixture` » `Fixture` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`, `IteratorAggregate`, `ArrayAccess`, `Countable`
Uses traits	`yii\base\ArrayAccessTrait`, `FileFixtureTrait`
Since	2.0
Source	`framework/test/ActiveFixture.php`

ActiveFixture represents a fixture backed up by a ActiveRecord class or a database table.

Either $modelClass or $tableName 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 resetTable() to remove any existing data in the table. It will then populate the table 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().

For more details and usage information on ActiveFixture, see the guide article on fixtures.

Properties

Property	Type	Description	Defined by
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$data`	`array<string, array<string, mixed>>`	The data rows. Default: `[]`.	`BaseActiveFixture`
`$dataDirectory`	`string`	The directory path or path alias that contains the fixture data Default: `null`.	`FileFixtureTrait`
`$dataFile`	`string\|bool\|null`	The file path or path alias of the data file that contains the fixture data to be returned by `getData()`. Default: `null`.	`ActiveFixture`
`$db`	`yii\db\Connection\|array\|string`	The DB connection object or the application component ID of the DB connection. Default: `'db'`.	`DbFixture`
`$depends`	`array`	The fixtures that this fixture depends on. Default: `[]`.	`Fixture`
`$iterator` read-only	`ArrayIterator<array-key, mixed>`	An iterator for traversing the cookies in the collection.	`yii\base\ArrayAccessTrait`
`$modelClass`	`string`	The AR model class associated with this fixture. Default: `null`.	`BaseActiveFixture`
`$tableName`	`string\|null`	The name of the database table that this fixture is about. Default: `null`.	`ActiveFixture`
`$tableSchema` read-only	`yii\db\TableSchema`	The schema information of the database table associated with this fixture.	`ActiveFixture`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__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`
`__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.	`Fixture`
`afterUnload()`	This method is called AFTER all fixture data have been unloaded for the current 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.	`Fixture`
`beforeUnload()`	This method is called BEFORE any fixture data is unloaded for the current 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()` static	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.	`BaseActiveFixture`
`getTableSchema()`		`ActiveFixture`
`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.	`ActiveFixture`
`load()`	Loads the fixture.	`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.	`ActiveFixture`
`getData()` protected	Returns the fixture data.	`ActiveFixture`
`loadData()` protected	Returns the fixture data.	`FileFixtureTrait`
`resetTable()` protected	Removes all existing data from the specified table and resets sequence number to 1 (if any).	`ActiveFixture`

Property details

$dataFile

public string|bool|null $dataFile = null

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/TableName.php, where FixturePath stands for the directory containing this fixture class, and TableName stands for the name of the table associated with this fixture. You can set this property to be false to prevent loading any data.

$tableName

public string|null $tableName = null

The name of the database table that this fixture is about.

If this property is not set, the table name will be determined via $modelClass.

Method details

getTableSchema()

public function getTableSchema(): yii\db\TableSchema

Returns

yii\db\TableSchema: The schema information of the database table associated with this fixture.

Throws

yii\base\InvalidConfigException: if the table does not exist

init()

public function init(): mixed

Initializes the object.

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

Returns

mixed

load()

public function load(): mixed

Loads the fixture.

It populate the table 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 table.

Returns

mixed

unload()

public function unload(): mixed

Unloads the fixture.

This method is called after every test method finishes. You may override this method to perform necessary cleanup work for the fixture.

Returns

mixed

getData()

protected function getData(): array

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 table.

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

Returns

array: The data rows to be inserted into the database table.

resetTable()

protected function resetTable(): mixed

Removes all existing data from the specified table and resets sequence number to 1 (if any).

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

Returns

mixed