Class yii\mongodb\ActiveFixture
| Inheritance | yii\mongodb\ActiveFixture » yii\test\BaseActiveFixture » yii\test\DbFixture » yii\test\Fixture » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | ArrayAccess, Countable, IteratorAggregate, yii\base\Configurable |
| Uses Traits | yii\base\ArrayAccessTrait, yii\test\FileFixtureTrait |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-mongodb/blob/master/ActiveFixture.php |
ActiveFixture represents a fixture backed up by a MongoDB ActiveRecord class or a MongoDB collection.
Either $modelClass or $collectionName 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 resetCollection() to remove any existing data in the collection. It will then populate the collection 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().
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $collectionName | string|array | The collection name that this fixture is about. | yii\mongodb\ActiveFixture |
| $data | array | The data rows. | yii\test\BaseActiveFixture |
| $dataDirectory | string | The directory path or path alias that contains the fixture data | yii\test\FileFixtureTrait |
| $dataFile | string|boolean | The file path or path alias of the data file that contains the fixture data to be returned by \yii\test\getData(). | yii\test\FileFixtureTrait |
| $db | yii\mongodb\Connection|string | The DB connection object or the application component ID of the DB connection. | yii\mongodb\ActiveFixture |
| $depends | array | The fixtures that this fixture depends on. | yii\test\Fixture |
| $modelClass | string | The AR model class associated with this fixture. | yii\test\BaseActiveFixture |
Public Methods
| 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\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 |
| 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() | {@inheritdoc} | yii\mongodb\ActiveFixture |
| load() | Loads the fixture data. | yii\mongodb\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() | {@inheritdoc} | yii\test\BaseActiveFixture |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| getCollection() | Returns collection used by this fixture. | yii\mongodb\ActiveFixture |
| getCollectionName() | Returns collection name used by this fixture. | yii\mongodb\ActiveFixture |
| getData() | Returns the fixture data. | yii\mongodb\ActiveFixture |
| loadData() | Returns the fixture data. | yii\test\FileFixtureTrait |
| resetCollection() | Removes all existing data from the specified collection and resets sequence number if any. | yii\mongodb\ActiveFixture |
Property Details
The collection name that this fixture is about. If this property is not set, the collection name will be determined via $modelClass.
See also yii\mongodb\Connection::getCollection().
The DB connection object or the application component ID of the DB connection.
Method Details
Returns collection used by this fixture.
| protected yii\mongodb\Collection getCollection ( ) | ||
| return | yii\mongodb\Collection | Related collection. |
|---|---|---|
Returns collection name used by this fixture.
| protected array|string getCollectionName ( ) | ||
| return | array|string | Related collection name |
|---|---|---|
Returns the fixture data.
This method is called by loadData() to get the needed 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 collection.
If the data file does not exist, an empty array will be returned.
| protected array getData ( ) | ||
| return | array | The data rows to be inserted into the collection. |
|---|---|---|
{@inheritdoc}
| public void init ( ) |
Loads the fixture data.
The default implementation will first reset the MongoDB collection and then populate it with the data returned by getData().
| public void load ( ) |
Removes all existing data from the specified collection and resets sequence number if any.
This method is called before populating fixture data into the collection associated with this fixture.
| protected void resetCollection ( ) |