DummyCache::getMultiple() - Code Metrics - Inspection of "Fixes #879: Caching implementation refactored acco..." - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.1 ( 28b26f...4d9204 )

by Alexander

created 2017-08-29 11:44 UTC

DummyCache::getMultiple() A

↳ Parent: DummyCache

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
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	2
crap	2

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\caching;

use yii\base\Component;

/**
 * DummyCache is a placeholder cache component.
 *
 * Application configuration example:
 *
 * ```php
 * return [
 *     'components' => [
 *         'cache' => [
 *             'class' => yii\caching\Cache::class,
 *             'handler' => [
 *                 'class' => yii\caching\DummyCache::class,
 *             ],
 *         ],
 *         // ...
 *     ],
 *     // ...
 * ];
 * ```
 *
 * DummyCache does not cache anything. It is provided so that one can always configure
 * a 'cache' application component and save the check of existence of `\Yii::$app->cache`.
 * By replacing DummyCache with some other cache component, one can quickly switch from
 * non-caching mode to caching mode.
 *
 * For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
 *
 * @author Qiang Xue <[email protected]>
 * @since 2.0
 */
class DummyCache extends Component implements \Psr\SimpleCache\CacheInterface
{
    /**
     * {@inheritdoc}
     */
    public function has($key)
    {
        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function get($key, $default = null)
    {
        return $default;
    }

    /**
     * {@inheritdoc}
     */
    public function set($key, $value, $ttl = null)
    {
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function delete($key)
    {
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function clear()
    {
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function getMultiple($keys, $default = null)
    {
        return array_fill_keys($keys, $default);
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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function setMultiple($values, $ttl = null)
    {
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function deleteMultiple($keys)
    {
        return true;
    }
}


1			<?php
2			/**
3			* @link http://www.yiiframework.com/
4			* @copyright Copyright (c) 2008 Yii Software LLC
5			* @license http://www.yiiframework.com/license/
6			*/
7
8			namespace yii\caching;
9
10			use yii\base\Component;
11
12			/**
13			* DummyCache is a placeholder cache component.
14			*
15			* Application configuration example:
16			*
17			* ```php
18			* return [
19			* 'components' => [
20			* 'cache' => [
21			* 'class' => yii\caching\Cache::class,
22			* 'handler' => [
23			* 'class' => yii\caching\DummyCache::class,
24			* ],
25			* ],
26			* // ...
27			* ],
28			* // ...
29			* ];
30			* ```
31			*
32			* DummyCache does not cache anything. It is provided so that one can always configure
33			* a 'cache' application component and save the check of existence of `\Yii::$app->cache`.
34			* By replacing DummyCache with some other cache component, one can quickly switch from
35			* non-caching mode to caching mode.
36			*
37			* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
38			*
39			* @author Qiang Xue <[email protected]>
40			* @since 2.0
41			*/
42			class DummyCache extends Component implements \Psr\SimpleCache\CacheInterface
43			{
44			/**
45			* {@inheritdoc}
46			*/
47			public function has($key)
48			{
49			return false;
50			}
51
52			/**
53			* {@inheritdoc}
54			*/
55			public function get($key, $default = null)
56			{
57			return $default;
58			}
59
60			/**
61			* {@inheritdoc}
62			*/
63			public function set($key, $value, $ttl = null)
64			{
65			return true;
66			}
67
68			/**
69			* {@inheritdoc}
70			*/
71			public function delete($key)
72			{
73			return true;
74			}
75
76			/**
77			* {@inheritdoc}
78			*/
79			public function clear()
80			{
81			return true;
82			}
83
84			/**
85			* {@inheritdoc}
86			*/
87			public function getMultiple($keys, $default = null)
88			{
89			return array_fill_keys($keys, $default);
			0 ignored issues – show Bug Best Practice introduced 2017-08-10 12:41 UTC by Report Bug Copy Issue Report The return type of `return array_fill_keys($keys, $default);` (`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...
90			}
91
92			/**
93			* {@inheritdoc}
94			*/
95			public function setMultiple($values, $ttl = null)
96			{
97			return true;
98			}
99
100			/**
101			* {@inheritdoc}
102			*/
103			public function deleteMultiple($keys)
104			{
105			return true;
106			}
107			}
108

yiisoft / yii2

Push — 2.1 ( 28b26f...4d9204 )

DummyCache::getMultiple() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like