FixedTaggingCachePool::hasItem() - Code Metrics - php-cache/cache-bundle - Measure and Improve Code Quality continuously with Scrutinizer

FixedTaggingCachePool::hasItem() A
last analyzed 2018-03-19 23:39 UTC

↳ Parent: FixedTaggingCachePool

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	2

<?php

/*
 * This file is part of php-cache\cache-bundle package.
 *
 * (c) 2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Cache\CacheBundle\Cache;

use Cache\TagInterop\TaggableCacheItemInterface;
use Cache\TagInterop\TaggableCacheItemPoolInterface;
use Psr\Cache\CacheItemInterface;

/**
 * This class is a decorator for a TaggableCacheItemPoolInterface. It tags everything with predefined tags.
 *
 * @author Tobias Nyholm <[email protected]>
 *
 * @internal
 */
class FixedTaggingCachePool implements TaggableCacheItemPoolInterface
{
    /**
     * @type TaggableCacheItemPoolInterface
     */
    private $cache;

    /**
     * @type array
     */
    private $tags;

    /**
     * @param TaggableCacheItemPoolInterface $cache
     * @param array                          $tags
     */
    public function __construct(TaggableCacheItemPoolInterface $cache, array $tags)
    {
        $this->cache = $cache;
        $this->tags  = $tags;
    }

    /**
     * {@inheritdoc}
     */
    public function getItem($key)
    {
        return $this->cache->getItem($key);
    }

    /**
     * {@inheritdoc}
     */
    public function getItems(array $keys = [])
    {
        return $this->cache->getItems($keys);
    }

    /**
     * {@inheritdoc}
     */
    public function hasItem($key)
    {
        return $this->cache->hasItem($key);
    }

    /**
     * {@inheritdoc}
     */
    public function clear()
    {
        return $this->cache->clear();
    }

    /**
     * {@inheritdoc}
     */
    public function deleteItem($key)
    {
        return $this->cache->deleteItem($key);
    }

    /**
     * {@inheritdoc}
     */
    public function deleteItems(array $keys)
    {
        return $this->cache->deleteItems($keys);
    }

    /**
     * {@inheritdoc}
     */
    public function save(CacheItemInterface $item)

    {
        if (!$item instanceof TaggableCacheItemInterface) {
            throw new \InvalidArgumentException('Cache items are not transferable between pools. Item MUST implement TaggableCacheItemInterface.');
        }

        $item->setTags($this->tags);

        return $this->cache->save($item);
    }

    /**
     * {@inheritdoc}
     */
    public function saveDeferred(CacheItemInterface $item)

    {
        if (!$item instanceof TaggableCacheItemInterface) {
            throw new \InvalidArgumentException('Cache items are not transferable between pools. Item MUST implement TaggableCacheItemInterface.');
        }

        $item->setTags($this->tags);

        return $this->cache->saveDeferred($item);
    }

    /**
     * {@inheritdoc}
     */
    public function commit()
    {
        return $this->cache->commit();
    }

    /**
     * {@inheritdoc}
     */
    public function invalidateTag($tag)
    {
        return $this->invalidateTag($tag);
    }

    /**
     * {@inheritdoc}
     */
    public function invalidateTags(array $tags)
    {
        return $this->cache - $this->invalidateTags($tags);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


1		<?php
2
3		/*
4		* This file is part of php-cache\cache-bundle package.
5		*
6		* (c) 2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
7		*
8		* This source file is subject to the MIT license that is bundled
9		* with this source code in the file LICENSE.
10		*/
11
12		namespace Cache\CacheBundle\Cache;
13
14		use Cache\TagInterop\TaggableCacheItemInterface;
15		use Cache\TagInterop\TaggableCacheItemPoolInterface;
16		use Psr\Cache\CacheItemInterface;
17
18		/**
19		* This class is a decorator for a TaggableCacheItemPoolInterface. It tags everything with predefined tags.
20		*
21		* @author Tobias Nyholm <[email protected]>
22		*
23		* @internal
24		*/
25		class FixedTaggingCachePool implements TaggableCacheItemPoolInterface
26		{
27		/**
28		* @type TaggableCacheItemPoolInterface
29		*/
30		private $cache;
31
32		/**
33		* @type array
34		*/
35		private $tags;
36
37		/**
38		* @param TaggableCacheItemPoolInterface $cache
39		* @param array $tags
40		*/
41		public function __construct(TaggableCacheItemPoolInterface $cache, array $tags)
42		{
43		$this->cache = $cache;
44		$this->tags = $tags;
45		}
46
47		/**
48		* {@inheritdoc}
49		*/
50		public function getItem($key)
51		{
52		return $this->cache->getItem($key);
53		}
54
55		/**
56		* {@inheritdoc}
57		*/
58		public function getItems(array $keys = [])
59		{
60		return $this->cache->getItems($keys);
61		}
62
63		/**
64		* {@inheritdoc}
65		*/
66		public function hasItem($key)
67		{
68		return $this->cache->hasItem($key);
69		}
70
71		/**
72		* {@inheritdoc}
73		*/
74		public function clear()
75		{
76		return $this->cache->clear();
77		}
78
79		/**
80		* {@inheritdoc}
81		*/
82		public function deleteItem($key)
83		{
84		return $this->cache->deleteItem($key);
85		}
86
87		/**
88		* {@inheritdoc}
89		*/
90		public function deleteItems(array $keys)
91		{
92		return $this->cache->deleteItems($keys);
93		}
94
95		/**
96		* {@inheritdoc}
97		*/
98	View Code Duplication	public function save(CacheItemInterface $item)
		0 ignored issues – show Duplication introduced 2017-07-31 20:18 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
99		{
100		if (!$item instanceof TaggableCacheItemInterface) {
101		throw new \InvalidArgumentException('Cache items are not transferable between pools. Item MUST implement TaggableCacheItemInterface.');
102		}
103
104		$item->setTags($this->tags);
105
106		return $this->cache->save($item);
107		}
108
109		/**
110		* {@inheritdoc}
111		*/
112	View Code Duplication	public function saveDeferred(CacheItemInterface $item)
		0 ignored issues – show Duplication introduced 2017-07-31 20:18 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
113		{
114		if (!$item instanceof TaggableCacheItemInterface) {
115		throw new \InvalidArgumentException('Cache items are not transferable between pools. Item MUST implement TaggableCacheItemInterface.');
116		}
117
118		$item->setTags($this->tags);
119
120		return $this->cache->saveDeferred($item);
121		}
122
123		/**
124		* {@inheritdoc}
125		*/
126		public function commit()
127		{
128		return $this->cache->commit();
129		}
130
131		/**
132		* {@inheritdoc}
133		*/
134		public function invalidateTag($tag)
135		{
136		return $this->invalidateTag($tag);
137		}
138
139		/**
140		* {@inheritdoc}
141		*/
142		public function invalidateTags(array $tags)
143		{
144		return $this->cache - $this->invalidateTags($tags);
		0 ignored issues – show Bug Best Practice introduced 2017-03-29 09:19 UTC by Report Bug Copy Issue Report The return type of `return $this->cache - $t...>invalidateTags($tags);` (`integer\|double`) is incompatible with the return type declared by the interface `Cache\TagInterop\Taggabl...terface::invalidateTags` of type `boolean`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
145		}
146		}
147

php-cache / cache-bundle

FixedTaggingCachePool::hasItem() A last analyzed 2018-03-19 23:39 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

FixedTaggingCachePool::hasItem() A
last analyzed 2018-03-19 23:39 UTC