attributes() public method

Returns the list of all attribute names of the model.

This method could be overridden by child classes to define available attributes. Note: all attributes defined in base Active Record class should be always present in returned array. For example:

public function attributes()
{
    return array_merge(
        parent::attributes(),
        ['tags', 'status']
    );
}

extractFileName() protected method

Extracts filename from given raw file value.

find() public static method

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

The returned \yii\mongodb\file\ActiveQueryInterface instance can be further customized by calling methods defined in \yii\mongodb\file\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\mongodb\file\BaseActiveRecord::hasOne() and \yii\mongodb\file\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();

getCollection() public static method

Return the Mongo GridFS collection instance for this AR class.

getFileContent() public method

Returns the associated file content.

getFileResource() public method

This method returns a stream resource that can be used with all file functions in PHP, which deal with reading files. The contents of the file are pulled out of MongoDB on the fly, so that the whole file does not have to be loaded into memory first.

insertInternal() protected method

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

refreshFile() public method

Refreshes the \yii\mongodb\file\file attribute from file collection, using current primary key.

updateInternal() protected method

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

writeFile() public method

Writes the the internal file content into the given filename.