ArrayFixture

API reference › yii › test › ArrayFixture

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

ArrayFixture represents arbitrary fixture that can be loaded from PHP files.

For more details and usage information on ArrayFixture, 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: `[]`.	`ArrayFixture`
`$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`.	`FileFixtureTrait`
`$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`

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`
`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\base\BaseObject`
`load()`	Loads the fixture.	`ArrayFixture`
`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.	`ArrayFixture`
`getData()` protected	Returns the fixture data.	`ArrayFixture`
`loadData()` protected	Returns the fixture data.	`FileFixtureTrait`

Property details

$data

public array<string, array<string, mixed>> $data = []

The data rows.

Each array element represents one row of data (column name => column value).

Method details

load()

public function load(): mixed

Loads the fixture.

The default implementation simply stores the data returned by getData() in $data. You should usually override this method by putting the data into the underlying database.

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<string, array<string, mixed>>

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 the data array that will be stored in $data after inserting into the database.

Returns

array<string, array<string, mixed>>: The data to be put into the database

Throws

yii\base\InvalidConfigException: if the specified data file does not exist.