PartialCache::cache() - Code Metrics - Inspection of "Merge pull request #19 from jfeid/forget_with_tags" - spatie/laravel-partialcache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2725b3...4f8553 )

by Freek

created 2018-02-15 11:00 UTC

PartialCache::cache() C

↳ Parent: PartialCache

Complexity

Conditions	7
Paths	9

Size

Total Lines	32
Code Lines	19

Duplication

Lines	10
Ratio	31.25 %

Importance

Changes	7
Bugs	2	Features	0

Metric	Value
c	7
b	2
f	0
dl	10
loc	32
rs	6.7272
cc	7
eloc	19
nc	9
nop	6

<?php

namespace Spatie\PartialCache;

use Illuminate\Cache\TaggableStore;
use Illuminate\Contracts\Cache\Factory as CacheManager;
use Illuminate\Contracts\Cache\Repository as Cache;
use Illuminate\Contracts\Config\Repository as Config;
use Illuminate\Contracts\View\Factory as View;
use Spatie\PartialCache\Exceptions\MethodNotSupportedException;

class PartialCache
{
    /**
     * @var \Illuminate\Contracts\View\Factory
     */
    protected $view;

    /**
     * @var \Illuminate\Contracts\Cache\Repository
     */
    protected $cache;

    /**
     * @var \Illuminate\Contracts\Cache\Factory
     */
    protected $cacheManager;

    /**
     * @var string
     */
    protected $cacheKey;

    /**
     * @var bool
     */
    protected $cacheIsTaggable;

    /**
     * @var bool
     */
    protected $enabled;

    /**
     * @param \Illuminate\Contracts\View\Factory      $view
     * @param \Illuminate\Contracts\Cache\Repository  $cache
     * @param \Illuminate\Contracts\Cache\Factory     $cacheManager
     * @param \Illuminate\Contracts\Config\Repository $config
     */
    public function __construct(View $view, Cache $cache, CacheManager $cacheManager, Config $config)
    {
        $this->view = $view;
        $this->cache = $cache;
        $this->cacheManager = $cacheManager;

        $this->cacheKey = $config->get('partialcache.key');
        $this->cacheIsTaggable = is_a($this->cacheManager->driver()->getStore(), TaggableStore::class);
        $this->enabled = $config->get('partialcache.enabled');
    }

    /**
     * Cache a view. If minutes are null, the view is cached forever.
     *
     * @param array        $data
     * @param string       $view
     * @param array        $mergeData
     * @param int          $minutes
     * @param string       $key
     * @param string|array $tag
     *
     * @return string
     */
    public function cache($data, $view, $mergeData = null, $minutes = null, $key = null, $tag = null)
    {
        if (!$this->enabled) {
            return call_user_func($this->renderView($view, $data, $mergeData));

        }

        $viewKey = $this->getCacheKeyForView($view, $key);

        $mergeData = $mergeData ?: [];

        $tags = $this->getTags($tag);

        if ($this->cacheIsTaggable && $minutes === null) {

            return $this->cache
                ->tags($tags)
                ->rememberForever($viewKey, $this->renderView($view, $data, $mergeData));
        }

        if ($this->cacheIsTaggable) {

            return $this->cache
                ->tags($tags)
                ->remember($viewKey, $minutes, $this->renderView($view, $data, $mergeData));
        }

        if ($minutes === null) {
            return $this->cache
                ->rememberForever($viewKey, $this->renderView($view, $data, $mergeData));
        }

        return $this->cache
            ->remember($viewKey, $minutes, $this->renderView($view, $data, $mergeData));
    }

    /**
     * Create a key name for the cached view.
     *
     * @param string $view
     * @param string $key
     *
     * @return string
     */
    public function getCacheKeyForView($view, $key = null)
    {
        $parts = [$this->cacheKey, $view];

        if ($key !== null) {
            $parts[] = $key;
        }

        return implode('.', $parts);
    }

    /**
     * Forget a rendered view.
     *
     * @param string $view
     * @param string $key
     * @param null|string|array $tag
     */
    public function forget($view, $key = null, $tag = null)
    {
        $cacheKey = $this->getCacheKeyForView($view, $key);

        if ($this->cacheIsTaggable) {
            $tags = $this->getTags($tag);
            $this->cache->tags($tags)->forget($cacheKey);
        }

        $this->cache->forget($cacheKey);
    }

    /**
     * Empty all views linked to a tag or the complete partial cache.
     * Note: Only supported by Taggable cache drivers.
     *
     * @param string $tag
     *
     * @throws \Spatie\PartialCache\Exceptions\MethodNotSupportedException
     */
    public function flush($tag = null)
    {
        if (!$this->cacheIsTaggable) {
            throw new MethodNotSupportedException('The cache driver ('.
                get_class($this->cacheManager->driver()).') doesn\'t support the flush method.');
        }

        $tag = $tag ?: $this->cacheKey;
        $this->cache->tags($tag)->flush();
    }

    /**
     * Render a view.
     *
     * @param string $view
     * @param array  $data
     * @param array  $mergeData
     *
     * @return string
     */
    protected function renderView($view, $data, $mergeData)
    {
        $data = $data ?: [];
        $mergeData = $mergeData ?: [];

        return function () use ($view, $data, $mergeData) {
            return $this->view->make($view, $data, $mergeData)->render();
        };
    }

    /**
     * Constructs tag array
     *
     * @param null|string|array $tag
     *
     * @return array
     */
    protected function getTags($tag = null)
    {
        $tags = [$this->cacheKey];

        if ($tag) {
            if (!is_array($tag)) {
                $tag = [$tag];
            }

            $tags = array_merge($tags, $tag);
        }

        return $tags;
    }
}


1		<?php
2
3		namespace Spatie\PartialCache;
4
5		use Illuminate\Cache\TaggableStore;
6		use Illuminate\Contracts\Cache\Factory as CacheManager;
7		use Illuminate\Contracts\Cache\Repository as Cache;
8		use Illuminate\Contracts\Config\Repository as Config;
9		use Illuminate\Contracts\View\Factory as View;
10		use Spatie\PartialCache\Exceptions\MethodNotSupportedException;
11
12		class PartialCache
13		{
14		/**
15		* @var \Illuminate\Contracts\View\Factory
16		*/
17		protected $view;
18
19		/**
20		* @var \Illuminate\Contracts\Cache\Repository
21		*/
22		protected $cache;
23
24		/**
25		* @var \Illuminate\Contracts\Cache\Factory
26		*/
27		protected $cacheManager;
28
29		/**
30		* @var string
31		*/
32		protected $cacheKey;
33
34		/**
35		* @var bool
36		*/
37		protected $cacheIsTaggable;
38
39		/**
40		* @var bool
41		*/
42		protected $enabled;
43
44		/**
45		* @param \Illuminate\Contracts\View\Factory $view
46		* @param \Illuminate\Contracts\Cache\Repository $cache
47		* @param \Illuminate\Contracts\Cache\Factory $cacheManager
48		* @param \Illuminate\Contracts\Config\Repository $config
49		*/
50		public function __construct(View $view, Cache $cache, CacheManager $cacheManager, Config $config)
51		{
52		$this->view = $view;
53		$this->cache = $cache;
54		$this->cacheManager = $cacheManager;
55
56		$this->cacheKey = $config->get('partialcache.key');
57		$this->cacheIsTaggable = is_a($this->cacheManager->driver()->getStore(), TaggableStore::class);
58		$this->enabled = $config->get('partialcache.enabled');
59		}
60
61		/**
62		* Cache a view. If minutes are null, the view is cached forever.
63		*
64		* @param array $data
65		* @param string $view
66		* @param array $mergeData
67		* @param int $minutes
68		* @param string $key
69		* @param string\|array $tag
70		*
71		* @return string
72		*/
73		public function cache($data, $view, $mergeData = null, $minutes = null, $key = null, $tag = null)
74		{
75		if (!$this->enabled) {
76		return call_user_func($this->renderView($view, $data, $mergeData));
		0 ignored issues – show Bug introduced 2016-02-10 12:20 UTC by Report Bug Copy Issue Report It seems like `$mergeData` defined by parameter `$mergeData` on line 73 can also be of type `null`; however, `Spatie\PartialCache\PartialCache::renderView()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
77		}
78
79		$viewKey = $this->getCacheKeyForView($view, $key);
80
81		$mergeData = $mergeData ?: [];
82
83		$tags = $this->getTags($tag);
84
85	View Code Duplication	if ($this->cacheIsTaggable && $minutes === null) {
		0 ignored issues – show Duplication introduced 2016-02-10 12:20 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
86		return $this->cache
87		->tags($tags)
88		->rememberForever($viewKey, $this->renderView($view, $data, $mergeData));
89		}
90
91	View Code Duplication	if ($this->cacheIsTaggable) {
		0 ignored issues – show Duplication introduced 2016-02-10 12:20 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
92		return $this->cache
93		->tags($tags)
94		->remember($viewKey, $minutes, $this->renderView($view, $data, $mergeData));
95		}
96
97		if ($minutes === null) {
98		return $this->cache
99		->rememberForever($viewKey, $this->renderView($view, $data, $mergeData));
100		}
101
102		return $this->cache
103		->remember($viewKey, $minutes, $this->renderView($view, $data, $mergeData));
104		}
105
106		/**
107		* Create a key name for the cached view.
108		*
109		* @param string $view
110		* @param string $key
111		*
112		* @return string
113		*/
114		public function getCacheKeyForView($view, $key = null)
115		{
116		$parts = [$this->cacheKey, $view];
117
118		if ($key !== null) {
119		$parts[] = $key;
120		}
121
122		return implode('.', $parts);
123		}
124
125		/**
126		* Forget a rendered view.
127		*
128		* @param string $view
129		* @param string $key
130		* @param null\|string\|array $tag
131		*/
132		public function forget($view, $key = null, $tag = null)
133		{
134		$cacheKey = $this->getCacheKeyForView($view, $key);
135
136		if ($this->cacheIsTaggable) {
137		$tags = $this->getTags($tag);
138		$this->cache->tags($tags)->forget($cacheKey);
139		}
140
141		$this->cache->forget($cacheKey);
142		}
143
144		/**
145		* Empty all views linked to a tag or the complete partial cache.
146		* Note: Only supported by Taggable cache drivers.
147		*
148		* @param string $tag
149		*
150		* @throws \Spatie\PartialCache\Exceptions\MethodNotSupportedException
151		*/
152		public function flush($tag = null)
153		{
154		if (!$this->cacheIsTaggable) {
155		throw new MethodNotSupportedException('The cache driver ('.
156		get_class($this->cacheManager->driver()).') doesn\'t support the flush method.');
157		}
158
159		$tag = $tag ?: $this->cacheKey;
160		$this->cache->tags($tag)->flush();
161		}
162
163		/**
164		* Render a view.
165		*
166		* @param string $view
167		* @param array $data
168		* @param array $mergeData
169		*
170		* @return string
171		*/
172		protected function renderView($view, $data, $mergeData)
173		{
174		$data = $data ?: [];
175		$mergeData = $mergeData ?: [];
176
177		return function () use ($view, $data, $mergeData) {
178		return $this->view->make($view, $data, $mergeData)->render();
179		};
180		}
181
182		/**
183		* Constructs tag array
184		*
185		* @param null\|string\|array $tag
186		*
187		* @return array
188		*/
189		protected function getTags($tag = null)
190		{
191		$tags = [$this->cacheKey];
192
193		if ($tag) {
194		if (!is_array($tag)) {
195		$tag = [$tag];
196		}
197
198		$tags = array_merge($tags, $tag);
199		}
200
201		return $tags;
202		}
203		}
204

spatie / laravel-partialcache

Push — master ( 2725b3...4f8553 )

PartialCache::cache() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like