| Inheritance | yii\test\BaseActiveFixture » yii\test\DbFixture » yii\test\Fixture » yii\base\Component » yii\base\Object |
|---|---|
| Implements | ArrayAccess, Countable, IteratorAggregate, yii\base\Configurable |
| Uses Traits | yii\base\ArrayAccessTrait |
| Subclasses | yii\elasticsearch\ActiveFixture, yii\mongodb\ActiveFixture, yii\sphinx\ActiveFixture, yii\test\ActiveFixture |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/test/BaseActiveFixture.php |
BaseActiveFixture is the base class for fixture classes that support accessing fixture data as ActiveRecord objects.
For more details and usage information on BaseActiveFixture, see the guide article on fixtures.
| Property | Type | Description | Defined By |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
| $data | array | The data rows. | yii\test\BaseActiveFixture |
| $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\BaseActiveFixture |
| $db | yii\db\Connection|array|string | The DB connection object or the application component ID of the DB connection. | yii\test\DbFixture |
| $depends | array | The fixtures that this fixture depends on. | yii\test\Fixture |
| $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 |
| 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\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 |
| 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\test\DbFixture |
| load() | Loads the fixture. | yii\test\BaseActiveFixture |
| 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 |
| Method | Description | Defined By |
|---|---|---|
| getData() | Returns the fixture data. | yii\test\BaseActiveFixture |
The data rows. Each array element represents one row of data (column name => column value).
public array $data = []
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
The AR model class associated with this fixture.
public string $modelClass = null
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. |
Returns the AR model by the specified model name.
A model name is the key of the corresponding data row in $data.
| public null|yii\db\ActiveRecord getModel ( $name ) | ||
|---|---|---|
| $name | string |
The model name. |
| return | null|yii\db\ActiveRecord |
The AR model, or null if the model cannot be found in the database |
| throws | yii\base\InvalidConfigException |
if $modelClass is not set. |
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 ( ) |
|---|
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 ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-test-baseactivefixture.html