GeneaLabs\LaravelModelCaching\CachedBuilder

Complexity

Total Complexity

27

Size/Duplication

Total Lines	201
Duplicated Lines	0 %

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	min()	0	11	2
A	pluck()	0	12	3
A	value()	0	11	2
A	find()	0	11	2
A	delete()	0	6	1
A	retrieveCachedValue()	0	14	1
A	avg()	0	11	2
A	max()	0	11	2
A	count()	0	11	2
B	cachedValue()	0	26	2
A	cursor()	0	11	2
A	sum()	0	11	2
A	get()	0	11	2
A	first()	0	11	2

<?php namespace GeneaLabs\LaravelModelCaching;

use GeneaLabs\LaravelModelCaching\Traits\Cachable;
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;

/**
 * @SuppressWarnings(PHPMD.TooManyPublicMethods)
 */
class CachedBuilder extends EloquentBuilder
{
    use Cachable;

    public function avg($column)
    {
        if (! $this->isCachable) {
            return parent::avg($column);

The method avg() does not exist on Illuminate\Database\Eloquent\Builder. Are you sure you never get this type here, but always one of the subclasses?

        }

        $arguments = func_get_args();
        $cacheKey = $this->makeCacheKey(['*'], null, "-avg_{$column}");
        $method = 'avg';

        return $this->cachedValue($arguments, $cacheKey, $method);
    }

    public function count($columns = ['*'])
    {
        if (! $this->isCachable) {
            return parent::count($columns);

The method count() does not exist on Illuminate\Database\Eloquent\Builder. Are you sure you never get this type here, but always one of the subclasses?

        }

        $arguments = func_get_args();
        $cacheKey = $this->makeCacheKey(['*'], null, "-count");
        $method = 'count';

        return $this->cachedValue($arguments, $cacheKey, $method);
    }

    public function cursor()
    {
        if (! $this->isCachable) {
            return collect(parent::cursor());
        }

        $arguments = func_get_args();
        $cacheKey = $this->makeCacheKey(['*'], null, "-cursor");
        $method = 'cursor';

        return $this->cachedValue($arguments, $cacheKey, $method);
    }

    public function delete()
    {
        $this->cache($this->makeCacheTags())
            ->flush();

        return parent::delete();
    }

    /**
     * @SuppressWarnings(PHPMD.ShortVariable)
     */
    public function find($id, $columns = ['*'])
    {
        if (! $this->isCachable) {
            return parent::find($id, $columns);
        }

        $arguments = func_get_args();
        $cacheKey = $this->makeCacheKey($columns);
        $method = 'find';

        return $this->cachedValue($arguments, $cacheKey, $method);
    }

    public function first($columns = ['*'])
    {
        if (! $this->isCachable) {
            return parent::first($columns);
        }

        $arguments = func_get_args();
        $cacheKey = $this->makeCacheKey($columns);
        $method = 'first';

        return $this->cachedValue($arguments, $cacheKey, $method);
    }

    public function get($columns = ['*'])
    {
        if (! $this->isCachable) {
            return parent::get($columns);
        }

        $arguments = func_get_args();
        $cacheKey = $this->makeCacheKey($columns);
        $method = 'get';

        return $this->cachedValue($arguments, $cacheKey, $method);
    }

    public function max($column)
    {
        if (! $this->isCachable) {
            return parent::max($column);

The method max() does not exist on Illuminate\Database\Eloquent\Builder. Are you sure you never get this type here, but always one of the subclasses?

        }

        $arguments = func_get_args();
        $cacheKey = $this->makeCacheKey(['*'], null, "-max_{$column}");
        $method = 'max';

        return $this->cachedValue($arguments, $cacheKey, $method);
    }

    public function min($column)
    {
        if (! $this->isCachable) {
            return parent::min($column);

The method min() does not exist on Illuminate\Database\Eloquent\Builder. Are you sure you never get this type here, but always one of the subclasses?

        }

        $arguments = func_get_args();
        $cacheKey = $this->makeCacheKey(['*'], null, "-min_{$column}");
        $method = 'min';

        return $this->cachedValue($arguments, $cacheKey, $method);
    }

    public function pluck($column, $key = null)
    {
        if (! $this->isCachable) {
            return parent::pluck($column, $key);
        }

        $keyDifferentiator = "-pluck_{$column}" . ($key ? "_{$key}" : "");
        $arguments = func_get_args();
        $cacheKey = $this->makeCacheKey([$column], null, $keyDifferentiator);
        $method = 'pluck';

        return $this->cachedValue($arguments, $cacheKey, $method);
    }

    public function sum($column)
    {
        if (! $this->isCachable) {
            return parent::sum($column);

The method sum() does not exist on Illuminate\Database\Eloquent\Builder. Are you sure you never get this type here, but always one of the subclasses?

        }

        $arguments = func_get_args();
        $cacheKey = $this->makeCacheKey(['*'], null, "-sum_{$column}");
        $method = 'sum';

        return $this->cachedValue($arguments, $cacheKey, $method);
    }

    public function value($column)
    {
        if (! $this->isCachable) {
            return parent::value($column);
        }

        $arguments = func_get_args();
        $cacheKey = $this->makeCacheKey(['*'], null, "-value_{$column}");
        $method = 'value';

        return $this->cachedValue($arguments, $cacheKey, $method);
    }

    public function cachedValue(array $arguments, string $cacheKey, string $method)
    {
        $cacheTags = $this->makeCacheTags();
        $hashedCacheKey = sha1($cacheKey);

        $result = $this->retrieveCachedValue(
            $arguments,
            $cacheKey,
            $cacheTags,
            $hashedCacheKey,
            $method
        );

        if ($result['key'] !== $cacheKey) {
            cache()->tags($cacheTags)->forget($hashedCacheKey);
        }

        $result = $this->retrieveCachedValue(
            $arguments,
            $cacheKey,
            $cacheTags,
            $hashedCacheKey,
            $method
        );

        return $result['value'];
    }

    protected function retrieveCachedValue(
        array $arguments,
        string $cacheKey,
        array $cacheTags,
        string $hashedCacheKey,
        string $method
    ) {
        return $this->cache($cacheTags)
            ->rememberForever(
                $hashedCacheKey,
                function () use ($arguments, $cacheKey, $method) {
                    return [
                        'key' => $cacheKey,
                        'value' => parent::{$method}(...$arguments),
                    ];
                }
            );
    }
}