NullCache - Code Metrics - chadicus/marvel-api-client - Measure and Improve Code Quality continuously with Scrutinizer

NullCache A
last analyzed 2018-01-26 17:51 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	115
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

Metric	Value
wmc	9
lcom	0
cbo	0
dl	0
loc	115
rs	10
c	0
b	0
f	0

8 Methods

Rating	Name	Size	Complexity
A	get()	4	1
A	set()	4	1
A	delete()	4	1
A	clear()	4	1
A	getMultiple()	9	2
A	setMultiple()	4	1
A	deleteMultiple()	4	1
A	has()	4	1

<?php

namespace Chadicus\Marvel\Api\Cache;

use Psr\SimpleCache\CacheInterface;

/**
 * A PSR-16 implementation which does not save or store any data.
 */
final class NullCache implements CacheInterface
{
    /**
     * Fetches a value from the cache.
     *
     * @param string $key     The unique key of this item in the cache.
     * @param mixed  $default Default value to return if the key does not exist.
     *
     * @return mixed The value of the item from the cache, or $default in case of cache miss.
     */
    public function get($key, $default = null)//@codingStandardsIgnoreLine  Interface does not define type-hints
    {
        return $default;
    }

    /**
     * Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
     *
     * @param string                    $key   The key of the item to store.
     * @param mixed                     $value The value of the item to store, must be serializable.
     * @param null|integer|DateInterval $ttl   Optional. The TTL value of this item. If no value is sent and
     *                                         the driver supports TTL then the library may set a default value
     *                                         for it or let the driver take care of that.
     *
     * @return boolean True on success and false on failure.
     */
    public function set($key, $value, $ttl = null)//@codingStandardsIgnoreLine  Interface does not define type-hints
    {
        return true;
    }

    /**
     * Delete an item from the cache by its unique key.
     *
     * @param string $key The unique cache key of the item to delete.
     *
     * @return boolean True if the item was successfully removed. False if there was an error.
     */
    public function delete($key)//@codingStandardsIgnoreLine  Interface does not define type-hints
    {
        return true;
    }

    /**
     * Wipes clean the entire cache's keys.
     *
     * @return boolean True on success and false on failure.
     */
    public function clear()
    {
        return true;
    }

    /**
     * Obtains multiple cache items by their unique keys.
     *
     * @param iterable $keys    A list of keys that can obtained in a single operation.
     * @param mixed    $default Default value to return for keys that do not exist.
     *
     * @return array A list of key => value pairs. Keys that do not exist or are stale will have $default as value.
     */
    public function getMultiple($keys, $default = null)//@codingStandardsIgnoreLine  Interface does not define type-hints
    {
        $items = [];
        foreach ($keys as $key) {
            $items[$key] = $default;
        }

        return $items;
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 set of key => value pairs in the cache, with an optional TTL.
     *
     * @param iterable                  $values A list of key => value pairs for a multiple-set operation.
     * @param null|integer|DateInterval $ttl    Optional. The TTL value of this item. If no value is sent and
     *                                          the driver supports TTL then the library may set a default value
     *                                          for it or let the driver take care of that.
     *
     * @return boolean True on success and false on failure.
     */
    public function setMultiple($values, $ttl = null)//@codingStandardsIgnoreLine  Interface does not define type-hints
    {
        return true;
    }

    /**
     * Deletes multiple cache items in a single operation.
     *
     * @param iterable $keys A list of string-based keys to be deleted.
     *
     * @return boolean True if the items were successfully removed. False if there was an error.
     */
    public function deleteMultiple($keys)//@codingStandardsIgnoreLine  Interface does not define type-hints
    {
        return true;
    }

    /**
     * Determines whether an item is present in the cache.
     *
     * NOTE: It is recommended that has() is only to be used for cache warming type purposes
     * and not to be used within your live applications operations for get/set, as this method
     * is subject to a race condition where your has() will return true and immediately after,
     * another script can remove it making the state of your app out of date.
     *
     * @param string $key The cache item key.
     *
     * @return boolean
     */
    public function has($key)//@codingStandardsIgnoreLine  Interface does not define type-hints
    {
        return false;
    }
}


1			<?php
2
3			namespace Chadicus\Marvel\Api\Cache;
4
5			use Psr\SimpleCache\CacheInterface;
6
7			/**
8			* A PSR-16 implementation which does not save or store any data.
9			*/
10			final class NullCache implements CacheInterface
11			{
12			/**
13			* Fetches a value from the cache.
14			*
15			* @param string $key The unique key of this item in the cache.
16			* @param mixed $default Default value to return if the key does not exist.
17			*
18			* @return mixed The value of the item from the cache, or $default in case of cache miss.
19			*/
20			public function get($key, $default = null)//@codingStandardsIgnoreLine Interface does not define type-hints
21			{
22			return $default;
23			}
24
25			/**
26			* Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
27			*
28			* @param string $key The key of the item to store.
29			* @param mixed $value The value of the item to store, must be serializable.
30			* @param null\|integer\|DateInterval $ttl Optional. The TTL value of this item. If no value is sent and
31			* the driver supports TTL then the library may set a default value
32			* for it or let the driver take care of that.
33			*
34			* @return boolean True on success and false on failure.
35			*/
36			public function set($key, $value, $ttl = null)//@codingStandardsIgnoreLine Interface does not define type-hints
37			{
38			return true;
39			}
40
41			/**
42			* Delete an item from the cache by its unique key.
43			*
44			* @param string $key The unique cache key of the item to delete.
45			*
46			* @return boolean True if the item was successfully removed. False if there was an error.
47			*/
48			public function delete($key)//@codingStandardsIgnoreLine Interface does not define type-hints
49			{
50			return true;
51			}
52
53			/**
54			* Wipes clean the entire cache's keys.
55			*
56			* @return boolean True on success and false on failure.
57			*/
58			public function clear()
59			{
60			return true;
61			}
62
63			/**
64			* Obtains multiple cache items by their unique keys.
65			*
66			* @param iterable $keys A list of keys that can obtained in a single operation.
67			* @param mixed $default Default value to return for keys that do not exist.
68			*
69			* @return array A list of key => value pairs. Keys that do not exist or are stale will have $default as value.
70			*/
71			public function getMultiple($keys, $default = null)//@codingStandardsIgnoreLine Interface does not define type-hints
72			{
73			$items = [];
74			foreach ($keys as $key) {
75			$items[$key] = $default;
76			}
77
78			return $items;
			0 ignored issues – show Bug Best Practice introduced 2017-04-20 00:56 UTC by Report Bug Copy Issue Report The return type of `return $items;` (`array`) is incompatible with the return type declared by the interface `Psr\SimpleCache\CacheInterface::getMultiple` of type `Psr\SimpleCache\iterable`. 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...
79			}
80
81			/**
82			* Persists a set of key => value pairs in the cache, with an optional TTL.
83			*
84			* @param iterable $values A list of key => value pairs for a multiple-set operation.
85			* @param null\|integer\|DateInterval $ttl Optional. The TTL value of this item. If no value is sent and
86			* the driver supports TTL then the library may set a default value
87			* for it or let the driver take care of that.
88			*
89			* @return boolean True on success and false on failure.
90			*/
91			public function setMultiple($values, $ttl = null)//@codingStandardsIgnoreLine Interface does not define type-hints
92			{
93			return true;
94			}
95
96			/**
97			* Deletes multiple cache items in a single operation.
98			*
99			* @param iterable $keys A list of string-based keys to be deleted.
100			*
101			* @return boolean True if the items were successfully removed. False if there was an error.
102			*/
103			public function deleteMultiple($keys)//@codingStandardsIgnoreLine Interface does not define type-hints
104			{
105			return true;
106			}
107
108			/**
109			* Determines whether an item is present in the cache.
110			*
111			* NOTE: It is recommended that has() is only to be used for cache warming type purposes
112			* and not to be used within your live applications operations for get/set, as this method
113			* is subject to a race condition where your has() will return true and immediately after,
114			* another script can remove it making the state of your app out of date.
115			*
116			* @param string $key The cache item key.
117			*
118			* @return boolean
119			*/
120			public function has($key)//@codingStandardsIgnoreLine Interface does not define type-hints
121			{
122			return false;
123			}
124			}
125

chadicus / marvel-api-client

NullCache A last analyzed 2018-01-26 17:51 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

Duplication Side-by-Side

Filter issues like

NullCache A
last analyzed 2018-01-26 17:51 UTC