Abstract Class yii\mongodb\ActiveRecord

Returns the list of all attribute names of the model.

This method must be overridden by child classes to define available attributes. Note: primary key attribute "_id" should be always present in returned array. For example:

public function attributes()
{
    return ['_id', 'name', 'address', 'status'];
}

Declares the name of the Mongo collection associated with this AR class.

Collection name can be either a string or array:

• if string considered as the name of the collection inside the default database.
• if array - first element considered as the name of the database, second - as name of collection inside that database

By default this method returns the class name as the collection name by calling \yii\helpers\Inflector::camel2id(). For example, 'Customer' becomes 'customer', and 'OrderItem' becomes 'order_item'. You may override this method if the collection is not named after this convention.

Deletes the document corresponding to this active record from the collection.

This method performs the following steps in order:

1. call \yii\mongodb\beforeDelete(). If the method returns false, it will skip the rest of the steps;
2. delete the document from the collection;
3. call \yii\mongodb\afterDelete().

In the above step 1 and 3, events named \yii\mongodb\EVENT_BEFORE_DELETE and \yii\mongodb\EVENT_AFTER_DELETE will be raised by the corresponding methods.

Deletes documents in the collection using the provided conditions.

WARNING: If you do not specify any condition, this method will delete documents rows in the collection.

For example, to delete all customers whose status is 3:

Customer::deleteAll(['status' => 3]);

See also yii\mongodb\ActiveRecord::delete().

Returns a value indicating whether the given active record is the same as the current one.

The comparison is made by comparing the collection names and the primary key values of the two active records. If one of the records \yii\mongodb\isNewRecord they are also considered not equal.

Return the Mongo collection instance for this AR class.

Returns the Mongo connection used by this AR class.

By default, the "mongodb" application component is used as the Mongo connection. You may override this method if you want to use a different database connection.

Inserts a row into the associated Mongo collection using the attribute values of this record.

This method performs the following steps in order:

1. call \yii\mongodb\beforeValidate() when $runValidation is true. If validation fails, it will skip the rest of the steps;
2. call \yii\mongodb\afterValidate() when $runValidation is true.
3. call \yii\mongodb\beforeSave(). If the method returns false, it will skip the rest of the steps;
4. insert the record into collection. If this fails, it will skip the rest of the steps;
5. call \yii\mongodb\afterSave();

In the above step 1, 2, 3 and 5, events \yii\mongodb\EVENT_BEFORE_VALIDATE, \yii\mongodb\EVENT_BEFORE_INSERT, \yii\mongodb\EVENT_AFTER_INSERT and \yii\mongodb\EVENT_AFTER_VALIDATE will be raised by the corresponding methods.

Only the \yii\mongodb\dirtyAttributes will be inserted into database.

If the primary key is null during insertion, it will be populated with the actual value after insertion.

For example, to insert a customer record:

$customer = new Customer();
$customer->name = $name;
$customer->email = $email;
$customer->insert();

See also yii\mongodb\ActiveRecord::insert().

Returns the primary key name(s) for this AR class.

The default implementation will return ['_id'].

Note that an array should be returned even for a collection with single primary key.

Updates all documents in the collection using the provided attribute values and conditions.

For example, to change the status to be 1 for all customers whose status is 2:

Customer::updateAll(['status' => 1], ['status' => 2]);

Updates all documents in the collection using the provided counter changes and conditions.

For example, to increment all customers' age by 1,

Customer::updateAllCounters(['age' => 1]);

See also yii\mongodb\ActiveRecord::update().