APCUCache - Code Metrics - Inspection of "Accepted PSR-16 Interface implemented." - soupmix/cache-apcu - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 55cafa...b8c0e9 )

by Mehmet

created 2017-01-03 19:50 UTC

APCUCache A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
wmc	17
c	2
b	0
f	1
lcom	1
cbo	1
dl	0
loc	106
ccs	21
cts	21
cp	1
rs	10

11 Methods

Rating	Name	Size	Complexity
A	get()	6	2
A	set()	5	1
A	delete()	5	1
A	clear()	4	1
A	getMultiple()	8	2
A	setMultiple()	8	2
A	deleteMultiple()	9	2
A	increment()	5	1
A	decrement()	5	1
A	has()	4	1
A	checkReservedCharacters()	9	3

<?php

namespace Soupmix\Cache;

use Soupmix\Cache\Exceptions\InvalidArgumentException;
use Psr\SimpleCache\CacheInterface;

class APCUCache implements CacheInterface
{
    const PSR16_RESERVED_CHARACTERS = ['{','}','(',')','/','@',':'];

    /**
     * {@inheritDoc}
     */
    public function get($key, $default = null)
    {
        $this->checkReservedCharacters($key);
        $value = apcu_fetch($key);
        return $value ?: $default;
    }

    /**
     * {@inheritDoc}
     */
    public function set($key, $value, $ttl = null)
    {
        $this->checkReservedCharacters($key);
        return apcu_store($key, $value, (int) $ttl);

    }

    /**
     * {@inheritDoc}
     */
    public function delete($key)
    {
        $this->checkReservedCharacters($key);
        return (bool) apcu_delete($key);
    }

    /**
     * {@inheritDoc}
     */
    public function clear()
    {
        return apcu_clear_cache();
    }
    /**
     * {@inheritDoc}
     */
    public function getMultiple($keys, $default = null)
    {
        $defaults = array_fill(0, count($keys), $default);
        foreach ($keys as $key){
            $this->checkReservedCharacters($key);
        }
        return array_merge(apcu_fetch($keys), $defaults);
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)
    {
        foreach ($values as $key => $value ){
            $this->checkReservedCharacters($key);
        }
        $result =  apcu_store($values, null , $ttl);
        return empty($result);
    }

    /**
     * {@inheritDoc}
     */
    public function deleteMultiple($keys)
    {
        $ret = [];
        foreach ($keys as $key ){
            $this->checkReservedCharacters($key);
            $ret[$key] = apcu_delete($key);
        }
        return $ret;
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());
}
    }

    public function increment($key, $step = 1)
    {
        $this->checkReservedCharacters($key);
        return apcu_inc($key, $step);
    }

    public function decrement($key, $step = 1)
    {
        $this->checkReservedCharacters($key);
        return apcu_dec($key, $step);
    }

    /**
     * {@inheritDoc}
     */
    public function has($key) {
        $this->checkReservedCharacters($key);
        return apcu_exists($key);

    }

    private function checkReservedCharacters($key)
    {
        foreach (self::PSR16_RESERVED_CHARACTERS as $needle) {
            if (strpos($key, $needle) !== false) {
                $message = sprintf('%s string is not a legal value.', $key);
                throw new InvalidArgumentException($message);
            }
        }
    }
}

1		<?php
2
3		namespace Soupmix\Cache;
4
5		use Soupmix\Cache\Exceptions\InvalidArgumentException;
6		use Psr\SimpleCache\CacheInterface;
7
8		class APCUCache implements CacheInterface
9		{
10		const PSR16_RESERVED_CHARACTERS = ['{','}','(',')','/','@',':'];
11
12		/**
13		* {@inheritDoc}
14		*/
15		public function get($key, $default = null)
16	1	{
17		$this->checkReservedCharacters($key);
18	1	$value = apcu_fetch($key);
19	1	return $value ?: $default;
20		}
21
22		/**
23		* {@inheritDoc}
24		*/
25		public function set($key, $value, $ttl = null)
26		{
27		$this->checkReservedCharacters($key);
28		return apcu_store($key, $value, (int) $ttl);
		0 ignored issues – show Bug Compatibility introduced 2017-01-03 19:57 UTC by Report Bug Copy Issue Report The expression `apcu_store($key, $value, (int) $ttl);` of type `boolean\|array` adds the type `array` to the return on line 28 which is incompatible with the return type declared by the interface `Psr\SimpleCache\CacheInterface::set` of type `boolean`. Loading history...
29		}
30
31	3	/**
32		* {@inheritDoc}
33	3	*/
34		public function delete($key)
35		{
36		$this->checkReservedCharacters($key);
37		return (bool) apcu_delete($key);
38		}
39
40		/**
41		* {@inheritDoc}
42	1	*/
43		public function clear()
44	1	{
45		return apcu_clear_cache();
46		}
47		/**
48		* {@inheritDoc}
49		*/
50		public function getMultiple($keys, $default = null)
51	1	{
52		$defaults = array_fill(0, count($keys), $default);
53	1	foreach ($keys as $key){
54		$this->checkReservedCharacters($key);
55		}
56		return array_merge(apcu_fetch($keys), $defaults);
		0 ignored issues – show Bug Best Practice introduced 2017-01-03 19:57 UTC by Report Bug Copy Issue Report The return type of `return array_merge(apcu_fetch($keys), $defaults);` (`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...
57		}
58
59		/**
60		* {@inheritDoc}
61		*/
62	1	public function setMultiple($values, $ttl = null)
63		{
64	1	foreach ($values as $key => $value ){
65		$this->checkReservedCharacters($key);
66		}
67		$result = apcu_store($values, null , $ttl);
68		return empty($result);
69		}
70
71		/**
72		* {@inheritDoc}
73		*/
74		public function deleteMultiple($keys)
75	1	{
76		$ret = [];
77	1	foreach ($keys as $key ){
78	1	$this->checkReservedCharacters($key);
79		$ret[$key] = apcu_delete($key);
80		}
81		return $ret;
		0 ignored issues – show Bug Best Practice introduced 2017-01-03 19:57 UTC by Report Bug Copy Issue Report The return type of `return $ret;` (`array`) is incompatible with the return type declared by the interface `Psr\SimpleCache\CacheInterface::deleteMultiple` 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...
82		}
83
84		public function increment($key, $step = 1)
85		{
86		$this->checkReservedCharacters($key);
87	1	return apcu_inc($key, $step);
88		}
89	1
90	1	public function decrement($key, $step = 1)
91	1	{
92		$this->checkReservedCharacters($key);
93	1	return apcu_dec($key, $step);
94		}
95
96		/**
97		* {@inheritDoc}
98		*/
99		public function has($key) {
100		$this->checkReservedCharacters($key);
101		return apcu_exists($key);
		0 ignored issues – show Bug Compatibility introduced 2017-01-03 19:57 UTC by Report Bug Copy Issue Report The expression `apcu_exists($key);` of type `boolean\|string[]` adds the type `string[]` to the return on line 101 which is incompatible with the return type declared by the interface `Psr\SimpleCache\CacheInterface::has` of type `boolean`. Loading history...
102		}
103	1
104		private function checkReservedCharacters($key)
105	1	{
106		foreach (self::PSR16_RESERVED_CHARACTERS as $needle) {
107		if (strpos($key, $needle) !== false) {
108		$message = sprintf('%s string is not a legal value.', $key);
109		throw new InvalidArgumentException($message);
110		}
111		}
112		}
113		}

soupmix / cache-apcu

Push — master ( 55cafa...b8c0e9 )

APCUCache A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

11 Methods

Duplication Side-by-Side

Filter issues like