Class yii\test\ArrayFixture

Inheritanceyii\test\ArrayFixture » yii\test\Fixture » yii\base\Component » yii\base\BaseObject
ImplementsArrayAccess, Countable, IteratorAggregate, yii\base\Configurable
Uses Traitsyii\base\ArrayAccessTrait
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/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.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$data array The data rows. yii\test\ArrayFixture
$dataFile string|boolean The file path or path alias of the data file that contains the fixture data to be returned by getData(). yii\test\ArrayFixture
$depends array The fixtures that this fixture depends on. yii\test\Fixture

Public Methods

Hide inherited methods

MethodDescriptionDefined 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
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. yii\test\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. yii\test\ArrayFixture

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getData() Returns the fixture data. yii\test\ArrayFixture

Property Details

$data public property

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

public array $data = []
$dataFile public property

The file path or path alias of the data file that contains the fixture data to be returned by getData(). You can set this property to be false to prevent loading any data.

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

protected array getData ( )
return array

The data to be put into the database

throws yii\base\InvalidConfigException

if the specified data file does not exist.

load() public method

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.

public void load ( )
unload() public method

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.

public void unload ( )