attributes() public method

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'];
}

public array attributes ( )
return	array	List of attribute names.
throws	yii\base\InvalidConfigException	if not implemented

collectionName() public static method

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.

public static string|array collectionName ( )
return	string|array	The collection name

delete() public method

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

This method performs the following steps in order:

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

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

public integer|boolean delete ( )
return	integer|boolean	The number of documents deleted, or false if the deletion is unsuccessful for some reason. Note that it is possible the number of documents deleted is 0, even though the deletion execution is successful.
throws	yii\db\StaleObjectException	if optimistic locking is enabled and the data being deleted is outdated.
throws	Exception	in case delete failed.

deleteAll() public static method

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]);

public static integer deleteAll ( $condition = [], $options = [] )
$condition	array	Description of the objects to delete. Please refer to yii\mongodb\Query::where() on how to specify this parameter.
$options	array	List of options in format: optionName => optionValue.
return	integer	The number of documents deleted.

deleteInternal() protected method

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

protected void deleteInternal ( )
throws	yii\db\StaleObjectException

equals() public method

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 is new they are also considered not equal.

public boolean equals ( $record )
$record	yii\mongodb\ActiveRecord	Record to compare to
return	boolean	Whether the two active records refer to the same row in the same Mongo collection.

find() public static method

Creates an \yii\mongodb\ActiveQueryInterface instance for query purpose.

The returned \yii\mongodb\ActiveQueryInterface instance can be further customized by calling methods defined in \yii\mongodb\ActiveQueryInterface before one() or all() is called to return populated ActiveRecord instances. For example,

// find the customer whose ID is 1
$customer = Customer::find()->where(['id' => 1])->one();

// find all active customers and order them by their age:
$customers = Customer::find()
    ->where(['status' => 1])
    ->orderBy('age')
    ->all();

This method is also called by yii\db\BaseActiveRecord::hasOne() and yii\db\BaseActiveRecord::hasMany() to create a relational query.

You may override this method to return a customized query. For example,

class Customer extends ActiveRecord
{
    public static function find()
    {
        // use CustomerQuery instead of the default ActiveQuery
        return new CustomerQuery(get_called_class());
    }
}

The following code shows how to apply a default condition for all queries:

class Customer extends ActiveRecord
{
    public static function find()
    {
        return parent::find()->where(['deleted' => false]);
    }
}

// Use andWhere()/orWhere() to apply the default condition
// SELECT FROM customer WHERE `deleted`=:deleted AND age>30
$customers = Customer::find()->andWhere('age>30')->all();

// Use where() to ignore the default condition
// SELECT FROM customer WHERE age>30
$customers = Customer::find()->where('age>30')->all();

public static yii\mongodb\ActiveQuery find ( )
return	yii\mongodb\ActiveQuery	The newly created yii\mongodb\ActiveQuery instance.

getCollection() public static method

Return the Mongo collection instance for this AR class.

public static yii\mongodb\Collection getCollection ( )
return	yii\mongodb\Collection	Collection instance.

getDb() public static method

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.

public static yii\mongodb\Connection getDb ( )
return	yii\mongodb\Connection	The database connection used by this AR class.

insert() public method

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 beforeValidate() when $runValidation is true. If validation fails, it will skip the rest of the steps;
2. call afterValidate() when $runValidation is true.
3. call 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 afterSave();

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

Only the changed attribute values 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();

public boolean insert ( $runValidation = true, $attributes = null )
$runValidation	boolean	Whether to perform validation before saving the record. If the validation fails, the record will not be inserted into the collection.
$attributes	array	List of attributes that need to be saved. Defaults to null, meaning all attributes that are loaded will be saved.
return	boolean	Whether the attributes are valid and the record is inserted successfully.
throws	Exception	in case insert failed.

insertInternal() protected method

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

protected void insertInternal ( $attributes = null )
$attributes

primaryKey() public static method

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.

public static string[] primaryKey ( )
return	string[]	The primary keys of the associated Mongo collection.

toArray() public method

Converts the model into an array.

This method will first identify which fields to be included in the resulting array by calling resolveFields(). It will then turn the model into an array with these fields. If $recursive is true, any embedded objects will also be converted into arrays.

If the model implements the \yii\mongodb\Linkable interface, the resulting array will also have a _link element which refers to a list of links as specified by the interface.

public array toArray ( array $fields = [], array $expand = [], $recursive = true )
$fields	array	The fields being requested. If empty, all fields as specified by fields() will be returned.
$expand	array	The additional fields being requested for exporting. Only fields declared in extraFields() will be considered.
$recursive	boolean	Whether to recursively return array representation of embedded objects.
return	array	The array representation of the object

updateAll() public static method

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]);

public static integer updateAll ( $attributes, $condition = [], $options = [] )
$attributes	array	Attribute values (name-value pairs) to be saved into the collection
$condition	array	Description of the objects to update. Please refer to yii\mongodb\Query::where() on how to specify this parameter.
$options	array	List of options in format: optionName => optionValue.
return	integer	The number of documents updated.

updateAllCounters() public static method

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]);

public static integer updateAllCounters ( $counters, $condition = [], $options = [] )
$counters	array	The counters to be updated (attribute name => increment value). Use negative values if you want to decrement the counters.
$condition	array	Description of the objects to update. Please refer to yii\mongodb\Query::where() on how to specify this parameter.
$options	array	List of options in format: optionName => optionValue.
return	integer	The number of documents updated.

updateInternal() protected method

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

protected void updateInternal ( $attributes = null )
$attributes
throws	yii\db\StaleObjectException