How ActiveRecord does support cache

[raminious]

Before I open this issue, I searched for hours in Github, Google and Yii forums

As explained in Yii2 documentations there are a way to cache queries using $db instance.

$result = $db->cache(function ($db) {

    // the result of the SQL query will be served from the cache
    // if query caching is enabled and the query result is found in the cache
    return $db->createCommand('SELECT * FROM customer WHERE id=1')->queryOne();

});

But because I don't like write SQL code in ActiveRecord, how should implement query cache feature with ActiveRecord ?

Such as yii1 way:

$customer = new Customer();

$cacheDependency = new yii\caching\DbDependency('SELECT MAX(...) FROM customer');

$custome->find()
    ->where(['id' => 1])
    ->cache(3600, $cacheDependency)
    ...
    ->one();

I searched about this issue and traced ActiveRecord where found I should override in yii\db\Query and change one() and all() methods.

For example current one() method in yii\db\Query is:

public function one($db = null)
    {
        return $this->createCommand($db)->queryOne();
    }

And must to be change to:

yii\base\ActiveQuery :

public function cache($duration = 0, $dependency = null)
{
    $this->cacheDuration = $duration;
    $this->cacheDependency = $dependency;
}

public function one($db = null)
{
    $row = parent::one($db, $this->cacheDuration > 0);
    if ($row !== false) {
        $models = $this->populate([$row]);
        return reset($models) ?: null;
    } else {
        return null;
    }
}

For yii\base\Query :

public function one($db = null, $shouldCache = false)
{
    if ($db === null)
        $db = Yii::$app->getDb();

    if ($shouldCache == true){
        return $db->cache(function ($db) {
            return $this->createCommand($db)->queryOne();
        }, $this->cacheDuration, $this->cacheDependency);
    } else {
        return $this->createCommand($db)->queryOne();
    }
}

Note: I didn't tested above codes

Am I in right way or there is cleaner solution to implement cache in ActiveRecords ?

[samdark]

$result = Post::getDb()->cache(function ($db) {
    return Post::find()->one();
});

Indeed docs aren't clear about it.

[raminious]

@samdark thank you

[callmez]

Why not make ActiveRecord cache better to use?
like @raminious said

$custome->find()
    ->where(['id' => 1])
    ->cache(3600, $cacheDependency)
    ...
    ->one();

this is better implement than

$result = Post::getDb()->cache(function ($db) {
    return Post::find()->one();
});

[cebe]

because the current code is more general and works for all db queries, not only AR. You can also run multiple queries inside the callback.