Pool::hasItem() - Code Metrics - Inspection of "Updated PSR-Cache (Draft) to PSR-Cache (Accepted)" - frqnck/apix-cache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 86501b...832a42 )

by Franck

created 2016-01-05 18:05 UTC

Pool::hasItem() A

↳ Parent: Project

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	1
Bugs	0	Features	0

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

<?php

/**
 *
 * This file is part of the Apix Project.
 *
 * (c) Franck Cassedanne <franck at ouarz.net>
 *
 * @license     http://opensource.org/licenses/BSD-3-Clause  New BSD License
 *
 */

namespace Apix\Cache\PsrCache;

use Apix\Cache\Adapter as CacheAdapter;
use Psr\Cache\CacheItemInterface as ItemInterface;
use Psr\Cache\CacheItemPoolInterface as ItemPoolInterface;

class Pool implements ItemPoolInterface
{

    /**
     *
     * @var CacheAdapter
     */
    protected $cache_adapter;

    /**
     * Deferred cache items to be saved later.
     *
     * @var array   Collection of \Apix\PsrCache\Item.
     */
    protected $deferred = array();

    /**
     * Constructor.
     */
    public function __construct(CacheAdapter $cache_adapter)
    {
        $this->cache_adapter = $cache_adapter;

        $options = array(
            'prefix_key' => 'cask-key-',  // prefix cache keys
            'tag_enable' => false         // wether to enable tagging
        );
        $this->cache_adapter->setOptions($options);
    }

    /**
     * {@inheritdoc}
     */
    public function getItem($key)
    {
        $value = $this->cache_adapter->loadKey($key);

        return new Item(
            $this->cache_adapter->removePrefixKey($key),
            $value,
            $this->cache_adapter->getTtl($key) ?: null,
            (bool) $value // indicates wether it is loaded from cache or not.
        );
    }

    /**
     * {@inheritdoc}
     */
    public function getItems(array $keys = array())
    {
        $items = array();
        foreach ($keys as $key) {
            $items[$key] = $this->getItem($key);
        }

        return $items;
    }

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

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

    /**
     * {@inheritdoc}
     */
    public function deleteItems(array $keys)
    {
        foreach ($keys as $key) {
            $this->cache_adapter->delete($key);
        }

        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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function deleteItem($key)
    {
        return $this->deleteItems(array($key));
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 save(ItemInterface $item)
    {
        $ttl = $item->getTtlInSecond();

        $item->setHit(true);
        $success = $this->cache_adapter->save(
                        $item->get(),             // value to store
                        $item->getKey(),          // its key
                        null,                     // disable tags support
                        is_null($ttl) ? 0 : $ttl  // ttl in sec or null for ever
                    );
        $item->setHit($success);

        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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function saveDeferred(ItemInterface $item)
    {
        $this->deferred[] = $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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function commit()
    {
        foreach ($this->deferred as $key => $item) {
            $this->save($item);
            if ( $item->isHit() ) {
                unset($this->deferred[$key]);
            }
        }

        return empty($this->deferred);
    }

    /**
     * Returns the cache adapter for this pool.
     *
     * @return CacheAdapter
     */
    public function getCacheAdapter()
    {
        return $this->cache_adapter;
    }

}


1		<?php
2
3		/**
4		*
5		* This file is part of the Apix Project.
6		*
7		* (c) Franck Cassedanne <franck at ouarz.net>
8		*
9		* @license http://opensource.org/licenses/BSD-3-Clause New BSD License
10		*
11		*/
12
13		namespace Apix\Cache\PsrCache;
14
15		use Apix\Cache\Adapter as CacheAdapter;
16		use Psr\Cache\CacheItemInterface as ItemInterface;
17		use Psr\Cache\CacheItemPoolInterface as ItemPoolInterface;
18
19		class Pool implements ItemPoolInterface
20		{
21
22		/**
23		*
24		* @var CacheAdapter
25		*/
26		protected $cache_adapter;
27
28		/**
29		* Deferred cache items to be saved later.
30		*
31		* @var array Collection of \Apix\PsrCache\Item.
32		*/
33		protected $deferred = array();
34
35		/**
36		* Constructor.
37		*/
38	204	public function __construct(CacheAdapter $cache_adapter)
39		{
40	204	$this->cache_adapter = $cache_adapter;
41
42		$options = array(
43	204	'prefix_key' => 'cask-key-', // prefix cache keys
44		'tag_enable' => false // wether to enable tagging
45	204	);
46	204	$this->cache_adapter->setOptions($options);
47	204	}
48
49		/**
50		* {@inheritdoc}
51		*/
52	136	public function getItem($key)
53		{
54	136	$value = $this->cache_adapter->loadKey($key);
55
56	136	return new Item(
57	136	$this->cache_adapter->removePrefixKey($key),
58	136	$value,
59	136	$this->cache_adapter->getTtl($key) ?: null,
60		(bool) $value // indicates wether it is loaded from cache or not.
61	136	);
62		}
63
64		/**
65		* {@inheritdoc}
66		*/
67	68	public function getItems(array $keys = array())
68		{
69	68	$items = array();
70	68	foreach ($keys as $key) {
71	68	$items[$key] = $this->getItem($key);
72	68	}
73
74	68	return $items;
75		}
76
77		/**
78		* {@inheritdoc}
79		*/
80		public function hasItem($key)
81		{
82		return $this->getItem($key)->isHit();
83		}
84
85		/**
86		* {@inheritdoc}
87		*/
88	34	public function clear()
89		{
90	34	return $this->cache_adapter->flush(true);
91		}
92
93		/**
94		* {@inheritdoc}
95		*/
96	34	public function deleteItems(array $keys)
97		{
98	34	foreach ($keys as $key) {
99	34	$this->cache_adapter->delete($key);
100	34	}
101
102	34	return $this;
		0 ignored issues – show Bug Best Practice introduced 2016-01-05 17:43 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Apix\Cache\PsrCache\Pool`) 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...
103		}
104
105		/**
106		* {@inheritdoc}
107		*/
108		public function deleteItem($key)
109		{
110		return $this->deleteItems(array($key));
		0 ignored issues – show Bug Best Practice introduced 2016-01-05 18:17 UTC by Report Bug Copy Issue Report The return type of `return $this->deleteItems(array($key));` (`Apix\Cache\PsrCache\Pool`) is incompatible with the return type declared by the interface `Psr\Cache\CacheItemPoolInterface::deleteItem` 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...
111		}
112
113		/**
114		* {@inheritdoc}
115		*/
116	136	public function save(ItemInterface $item)
117		{
118	136	$ttl = $item->getTtlInSecond();
119
120	136	$item->setHit(true);
121	136	$success = $this->cache_adapter->save(
122	136	$item->get(), // value to store
123	136	$item->getKey(), // its key
124	136	null, // disable tags support
125	136	is_null($ttl) ? 0 : $ttl // ttl in sec or null for ever
126	136	);
127	136	$item->setHit($success);
128
129	136	return $this;
		0 ignored issues – show Bug Best Practice introduced 2016-01-05 17:43 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Apix\Cache\PsrCache\Pool`) 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...
130		}
131
132		/**
133		* {@inheritdoc}
134		*/
135	34	public function saveDeferred(ItemInterface $item)
136		{
137	34	$this->deferred[] = $item;
138
139	34	return $this;
		0 ignored issues – show Bug Best Practice introduced 2016-01-05 17:43 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Apix\Cache\PsrCache\Pool`) 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...
140		}
141
142		/**
143		* {@inheritdoc}
144		*/
145	34	public function commit()
146		{
147	34	foreach ($this->deferred as $key => $item) {
148	34	$this->save($item);
149	34	if ( $item->isHit() ) {
150	34	unset($this->deferred[$key]);
151	34	}
152	34	}
153
154	34	return empty($this->deferred);
155		}
156
157		/**
158		* Returns the cache adapter for this pool.
159		*
160		* @return CacheAdapter
161		*/
162	102	public function getCacheAdapter()
163		{
164	102	return $this->cache_adapter;
165		}
166
167		}
168

frqnck / apix-cache

Push — master ( 86501b...832a42 )

Pool::hasItem() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like