Cacheable - Code Metrics - rinvex/laravel-repositories - Measure and Improve Code Quality continuously with Scrutinizer

Cacheable A
last analyzed 2020-05-31 01:03 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	246
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

Metric	Value
wmc	27
lcom	2
cbo	0
dl	0
loc	246
rs	10
c	0
b	0
f	0

13 Methods

Rating	Name	Size	Complexity
A	generateCacheHash()	16	1
A	storeCacheKeys()	10	3
A	getCacheKeys()	8	3
A	setCacheLifetime()	6	1
A	getCacheLifetime()	5	1
A	setCacheDriver()	6	1
A	getCacheDriver()	4	1
A	enableCacheClear()	6	1
A	isCacheClearEnabled()	4	1
A	forgetCache()	18	4
A	cacheCallback()	36	5
A	resetCachedRepository()	9	1
A	flushCacheKeys()	18	4

<?php

declare(strict_types=1);

namespace Rinvex\Repository\Traits;

use Closure;

trait Cacheable
{
    /**
     * The repository cache lifetime.
     *
     * @var int
     */
    protected $cacheLifetime;

    /**
     * The repository cache driver.
     *
     * @var string
     */
    protected $cacheDriver;

    /**
     * Indicate if the repository cache clear is enabled.
     *
     * @var bool
     */
    protected $cacheClearEnabled = true;

    /**
     * Generate unique query hash.
     *
     * @param $args
     *
     * @return string
     */
    protected function generateCacheHash($args): string
    {
        return md5(json_encode($args + [
            $this->getRepositoryId(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->getModel(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->getCacheDriver(),
            $this->getCacheLifetime(),
            $this->relations,
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->where,
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->whereIn,
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->whereNotIn,
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->offset,
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->limit,
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->orderBy,
class MyClass { }

$x = new MyClass();
$x->foo = true;
        ]));
    }

    /**
     * Store cache keys by mimicking cache tags.
     *
     * @param string $class
     * @param string $method
     * @param string $hash
     *
     * @return void
     */
    protected function storeCacheKeys($class, $method, $hash): void
    {
        $keysFile = $this->getContainer('config')->get('rinvex.repository.cache.keys_file');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $cacheKeys = $this->getCacheKeys($keysFile);

        if (! isset($cacheKeys[$class]) || ! in_array($method.'.'.$hash, $cacheKeys[$class])) {
            $cacheKeys[$class][] = $method.'.'.$hash;
            file_put_contents($keysFile, json_encode($cacheKeys));
        }
    }

    /**
     * Get cache keys.
     *
     * @param string $file
     *
     * @return array
     */
    protected function getCacheKeys($file): array
    {
        if (! file_exists($file)) {
            file_put_contents($file, null);
        }

        return json_decode(file_get_contents($file), true) ?: [];
    }

    /**
     * Flush cache keys by mimicking cache tags.
     *
     * @return array
     */
    protected function flushCacheKeys(): array
    {
        $flushedKeys = [];
        $calledClass = static::class;
        $config = $this->getContainer('config')->get('rinvex.repository.cache');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $cacheKeys = $this->getCacheKeys($config['keys_file']);

        if (isset($cacheKeys[$calledClass]) && is_array($cacheKeys[$calledClass])) {
            foreach ($cacheKeys[$calledClass] as $cacheKey) {
                $flushedKeys[] = $calledClass.'@'.$cacheKey;
            }

            unset($cacheKeys[$calledClass]);
            file_put_contents($config['keys_file'], json_encode($cacheKeys));
        }

        return $flushedKeys;
    }

    /**
     * {@inheritdoc}
     */
    public function setCacheLifetime($cacheLifetime)
    {
        $this->cacheLifetime = $cacheLifetime;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getCacheLifetime(): int
    {
        // Return value even if it's zero "0" (which means cache is disabled)
        return $this->cacheLifetime ?? $this->getContainer('config')->get('rinvex.repository.cache.lifetime');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * {@inheritdoc}
     */
    public function setCacheDriver($cacheDriver)
    {
        $this->cacheDriver = $cacheDriver;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getCacheDriver(): ?string

    {
        return $this->cacheDriver;
    }

    /**
     * {@inheritdoc}
     */
    public function enableCacheClear($status = true)
    {
        $this->cacheClearEnabled = $status;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function isCacheClearEnabled(): bool
    {
        return $this->cacheClearEnabled;
    }

    /**
     * {@inheritdoc}
     */
    public function forgetCache()
    {
        if ($this->getCacheLifetime()) {
            // Flush cache tags
            if (method_exists($this->getContainer('cache')->getStore(), 'tags')) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $this->getContainer('cache')->tags($this->getRepositoryId())->flush();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            } else {
                // Flush cache keys, then forget actual cache
                foreach ($this->flushCacheKeys() as $cacheKey) {
                    $this->getContainer('cache')->forget($cacheKey);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                }
            }

            $this->getContainer('events')->dispatch($this->getRepositoryId().'.entity.cache.flushed', [$this]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return $this;
    }

    /**
     * Cache given callback.
     *
     * @param string   $class
     * @param string   $method
     * @param array    $args
     * @param \Closure $closure
     *
     * @return mixed
     */
    protected function cacheCallback($class, $method, $args, Closure $closure)
    {
        $repositoryId = $this->getRepositoryId();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $lifetime = $this->getCacheLifetime();
        $hash = $this->generateCacheHash($args);
        $cacheKey = $class.'@'.$method.'.'.$hash;

        // Switch cache driver on runtime
        if ($driver = $this->getCacheDriver()) {
            $this->getContainer('cache')->setDefaultDriver($driver);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        // We need cache tags, check if default driver supports it
        if (method_exists($this->getContainer('cache')->getStore(), 'tags')) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $result = $lifetime === -1
                ? $this->getContainer('cache')->tags($repositoryId)->rememberForever($cacheKey, $closure)
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                : $this->getContainer('cache')->tags($repositoryId)->remember($cacheKey, $lifetime, $closure);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

            // We're done, let's clean up!
            $this->resetRepository();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

            return $result;
        }

        // Default cache driver doesn't support tags, let's do it manually
        $this->storeCacheKeys($class, $method, $hash);

        $result = $lifetime === -1
            ? $this->getContainer('cache')->rememberForever($cacheKey, $closure)
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            : $this->getContainer('cache')->remember($cacheKey, $lifetime, $closure);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        // We're done, let's clean up!
        $this->resetCachedRepository();

        return $result;
    }

    /**
     * Reset cached repository to its defaults.
     *
     * @return $this
     */
    protected function resetCachedRepository()
    {
        $this->resetRepository();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $this->cacheLifetime = null;
        $this->cacheDriver = null;

        return $this;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Rinvex\Repository\Traits;
6
7			use Closure;
8
9			trait Cacheable
10			{
11			/**
12			* The repository cache lifetime.
13			*
14			* @var int
15			*/
16			protected $cacheLifetime;
17
18			/**
19			* The repository cache driver.
20			*
21			* @var string
22			*/
23			protected $cacheDriver;
24
25			/**
26			* Indicate if the repository cache clear is enabled.
27			*
28			* @var bool
29			*/
30			protected $cacheClearEnabled = true;
31
32			/**
33			* Generate unique query hash.
34			*
35			* @param $args
36			*
37			* @return string
38			*/
39			protected function generateCacheHash($args): string
40			{

rinvex / laravel-repositories

Cacheable A last analyzed 2020-05-31 01:03 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

13 Methods

Duplication Side-by-Side

Filter issues like

Cacheable A
last analyzed 2020-05-31 01:03 UTC