Class yii\test\Fixture

Inheritanceyii\test\Fixture » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable
Subclassesyii\elasticsearch\ActiveFixture, yii\mongodb\ActiveFixture, yii\sphinx\ActiveFixture, yii\test\ActiveFixture, yii\test\ArrayFixture, yii\test\BaseActiveFixture, yii\test\DbFixture, yii\test\InitDbFixture
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/test/Fixture.php

Fixture represents a fixed state of a test environment.

Each fixture instance represents a particular aspect of a test environment. For example, you may use UserFixture to initialize the user database table with a set of known data. You may load the fixture when running every test method so that the user table always contains the fixed data and thus allows your test predictable and repeatable.

A fixture may depend on other fixtures, specified via the $depends property. When a fixture is being loaded, its dependent fixtures will be automatically loaded BEFORE the fixture; and when the fixture is being unloaded, its dependent fixtures will be unloaded AFTER the fixture.

You should normally override load() to specify how to set up a fixture; and override unload() for clearing up a fixture.

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

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$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\Object
__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\Object
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
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\Object
load() Loads the fixture. yii\test\Fixture
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
trigger() Triggers an event. yii\base\Component
unload() Unloads the fixture. yii\test\Fixture

Property Details

$depends public property

The fixtures that this fixture depends on. This must be a list of the dependent fixture class names.

public array $depends = []

Method Details

afterLoad() public method

This method is called AFTER all fixture data have been loaded for the current test.

public void afterLoad ( )
afterUnload() public method

This method is called AFTER all fixture data have been unloaded for the current test.

public void afterUnload ( )
beforeLoad() public method

This method is called BEFORE any fixture data is loaded for the current test.

public void beforeLoad ( )
beforeUnload() public method

This method is called BEFORE any fixture data is unloaded for the current test.

public void beforeUnload ( )
load() public method

Loads the fixture.

This method is called before performing every test method. You should override this method with concrete implementation about how to set up the fixture.

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 ( )