NullCacheItemPool::getItem() - Code Metrics - kuzmichus/cache - Measure and Improve Code Quality continuously with Scrutinizer

NullCacheItemPool::getItem() A
last analyzed 2016-03-01 09:05 UTC

↳ Parent: NullCacheItemPool

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/**
 *
 * PHP version 5.5
 *
 * @package Psr\Cache
 * @author  Sergey V.Kuzin <[email protected]>
 * @license MIT
 */

namespace Psr\Cache;

class NullCacheItemPool implements CacheItemPoolInterface

{
    /**
     * Returns a Cache Item representing the specified key.
     *
     * This method must always return an ItemInterface object, even in case of
     * a cache miss. It MUST NOT return null.
     *
     * @param string $key
     *   The key for which to return the corresponding Cache Item.
     * @return \Psr\Cache\CacheItemInterface
     *   The corresponding Cache Item.
     * @throws \Psr\Cache\InvalidArgumentException
     *   If the $key string is not a legal value a \Psr\Cache\InvalidArgumentException
     *   MUST be thrown.
     */
    public function getItem($key)
    {
        return new NullCacheItem($key);
    }

    /**
     * Returns a traversable set of cache items.
     *
     * @param array $keys
     * An indexed array of keys of items to retrieve.
     * @return array|\Traversable
     * A traversable collection of Cache Items keyed by the cache keys of
     * each item. A Cache item will be returned for each key, even if that
     * key is not found. However, if no keys are specified then an empty
     * traversable MUST be returned instead.
     */
    public function getItems(array $keys = array())
    {
        // TODO: Implement getItems() method.
    }

    /**
     * Deletes all items in the pool.
     *
     * @return boolean
     *   True if the pool was successfully cleared. False if there was an error.
     */
    public function clear()
    {
        return true;
    }

    /**
     * Removes multiple items from the pool.
     *
     * @param array $keys
     * An array of keys that should be removed from the pool.
     * @return static
     * The invoked object.
     */
    public function deleteItems(array $keys)
    {
        return $this;
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());
}
    }

    /**
     * Persists a cache item immediately.
     *
     * @param CacheItemInterface $item
     *   The cache item to save.
     *
     * @return static
     *   The invoked object.
     */
    public function save(CacheItemInterface $item)
    {
        return $this;
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());
}
    }

    /**
     * Sets a cache item to be persisted later.
     *
     * @param CacheItemInterface $item
     *   The cache item to save.
     * @return static
     *   The invoked object.
     */
    public function saveDeferred(CacheItemInterface $item)
    {
        return $this;
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());
}
    }

    /**
     * Persists any deferred cache items.
     *
     * @return bool
     *   TRUE if all not-yet-saved items were successfully saved. FALSE otherwise.
     */
    public function commit()
    {
        return true;
    }
}


1			<?php
2			/**
3			*
4			* PHP version 5.5
5			*
6			* @package Psr\Cache
7			* @author Sergey V.Kuzin <[email protected]>
8			* @license MIT
9			*/
10
11			namespace Psr\Cache;
12
13			class NullCacheItemPool implements CacheItemPoolInterface
			0 ignored issues – show Bug introduced 2016-03-01 09:04 UTC by Report Bug Copy Issue Report There is at least one abstract method in this class. Maybe declare it as abstract, or implement the remaining methods: deleteItem, hasItem Loading history...
14			{
15			/**
16			* Returns a Cache Item representing the specified key.
17			*
18			* This method must always return an ItemInterface object, even in case of
19			* a cache miss. It MUST NOT return null.
20			*
21			* @param string $key
22			* The key for which to return the corresponding Cache Item.
23			* @return \Psr\Cache\CacheItemInterface
24			* The corresponding Cache Item.
25			* @throws \Psr\Cache\InvalidArgumentException
26			* If the $key string is not a legal value a \Psr\Cache\InvalidArgumentException
27			* MUST be thrown.
28			*/
29			public function getItem($key)
30			{
31			return new NullCacheItem($key);
32			}
33
34			/**
35			* Returns a traversable set of cache items.
36			*
37			* @param array $keys
38			* An indexed array of keys of items to retrieve.
39			* @return array\|\Traversable
40			* A traversable collection of Cache Items keyed by the cache keys of
41			* each item. A Cache item will be returned for each key, even if that
42			* key is not found. However, if no keys are specified then an empty
43			* traversable MUST be returned instead.
44			*/
45			public function getItems(array $keys = array())
46			{
47			// TODO: Implement getItems() method.
48			}
49
50			/**
51			* Deletes all items in the pool.
52			*
53			* @return boolean
54			* True if the pool was successfully cleared. False if there was an error.
55			*/
56			public function clear()
57			{
58			return true;
59			}
60
61			/**
62			* Removes multiple items from the pool.
63			*
64			* @param array $keys
65			* An array of keys that should be removed from the pool.
66			* @return static
67			* The invoked object.
68			*/
69			public function deleteItems(array $keys)
70			{
71			return $this;
			0 ignored issues – show Bug Best Practice introduced 2016-03-01 09:04 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Psr\Cache\NullCacheItemPool`) is incompatible with the return type declared by the interface `Psr\Cache\CacheItemPoolInterface::deleteItems` 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...
72			}
73
74			/**
75			* Persists a cache item immediately.
76			*
77			* @param CacheItemInterface $item
78			* The cache item to save.
79			*
80			* @return static
81			* The invoked object.
82			*/
83			public function save(CacheItemInterface $item)
84			{
85			return $this;
			0 ignored issues – show Bug Best Practice introduced 2016-03-01 09:04 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Psr\Cache\NullCacheItemPool`) is incompatible with the return type declared by the interface `Psr\Cache\CacheItemPoolInterface::save` 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...
86			}
87
88			/**
89			* Sets a cache item to be persisted later.
90			*
91			* @param CacheItemInterface $item
92			* The cache item to save.
93			* @return static
94			* The invoked object.
95			*/
96			public function saveDeferred(CacheItemInterface $item)
97			{
98			return $this;
			0 ignored issues – show Bug Best Practice introduced 2016-03-01 09:04 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Psr\Cache\NullCacheItemPool`) is incompatible with the return type declared by the interface `Psr\Cache\CacheItemPoolInterface::saveDeferred` 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...
99			}
100
101			/**
102			* Persists any deferred cache items.
103			*
104			* @return bool
105			* TRUE if all not-yet-saved items were successfully saved. FALSE otherwise.
106			*/
107			public function commit()
108			{
109			return true;
110			}
111			}
112

kuzmichus / cache

NullCacheItemPool::getItem() A last analyzed 2016-03-01 09:05 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

NullCacheItemPool::getItem() A
last analyzed 2016-03-01 09:05 UTC