Cache::set() - Code Metrics - ARCANEDEV/GeoIP - Measure and Improve Code Quality continuously with Scrutinizer

Cache::set() A
last analyzed 2018-02-19 19:26 UTC

↳ Parent: Cache

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php namespace Arcanedev\GeoIP;

use Arcanedev\GeoIP\Contracts\GeoIPCache;
use Illuminate\Contracts\Cache\Repository as Store;

/**
 * Class     Cache
 *
 * @package  Arcanedev\GeoIP
 * @author   ARCANEDEV <[email protected]>
 */
class Cache implements GeoIPCache
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /** @var  \Illuminate\Contracts\Cache\Repository */
    protected $store;

    /** @var array */
    protected $tags = [];

    /** @var int */
    protected $expires = 30;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Cache constructor.
     *
     * @param  \Illuminate\Contracts\Cache\Repository  $store
     * @param  array                                   $tags
     * @param  int                                     $expires
     */
    public function __construct(Store $store, array $tags, $expires = 30)
    {
        $this->store   = $store;
        $this->tags    = $tags;
        $this->expires = $expires;
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get the store instance.
     *
     * @return \Illuminate\Contracts\Cache\Repository
     */
    private function store()
    {
        return empty($this->tags) ? $this->store : $this->store->tags($this->tags);
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get an item from the cache.
     *
     * @param  string  $key
     *
     * @return \Arcanedev\GeoIP\Location|null
     */
    public function get($key)
    {
        return is_array($value = $this->store()->get($key)) ? new Location($value) : null;
    }

    /**
     * Set an item in cache.
     *
     * @param  string  $key
     * @param  array   $location
     */
    public function set($key, array $location)
    {
        $this->store()->put($key, $location, $this->expires);
    }

    /**
     * Flush cache for tags.
     */
    public function flush()
    {
        $this->store()->flush();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }
}


1		<?php namespace Arcanedev\GeoIP;
2
3		use Arcanedev\GeoIP\Contracts\GeoIPCache;
4		use Illuminate\Contracts\Cache\Repository as Store;
5
6		/**
7		* Class Cache
8		*
9		* @package Arcanedev\GeoIP
10		* @author ARCANEDEV <[email protected]>
11		*/
12		class Cache implements GeoIPCache
13		{
14		/* -----------------------------------------------------------------
15		\| Properties
16		\| -----------------------------------------------------------------
17		*/
18
19		/** @var \Illuminate\Contracts\Cache\Repository */
20		protected $store;
21
22		/** @var array */
23		protected $tags = [];
24
25		/** @var int */
26		protected $expires = 30;
27
28		/* -----------------------------------------------------------------
29		\| Constructor
30		\| -----------------------------------------------------------------
31		*/
32
33		/**
34		* Cache constructor.
35		*
36		* @param \Illuminate\Contracts\Cache\Repository $store
37		* @param array $tags
38		* @param int $expires
39		*/
40	18	public function __construct(Store $store, array $tags, $expires = 30)
41		{
42	18	$this->store = $store;
43	18	$this->tags = $tags;
44	18	$this->expires = $expires;
45	18	}
46
47		/* -----------------------------------------------------------------
48		\| Getters & Setters
49		\| -----------------------------------------------------------------
50		*/
51
52		/**
53		* Get the store instance.
54		*
55		* @return \Illuminate\Contracts\Cache\Repository
56		*/
57	6	private function store()
58		{
59	6	return empty($this->tags) ? $this->store : $this->store->tags($this->tags);
60		}
61
62		/* -----------------------------------------------------------------
63		\| Main Methods
64		\| -----------------------------------------------------------------
65		*/
66
67		/**
68		* Get an item from the cache.
69		*
70		* @param string $key
71		*
72		* @return \Arcanedev\GeoIP\Location\|null
73		*/
74	6	public function get($key)
75		{
76	6	return is_array($value = $this->store()->get($key)) ? new Location($value) : null;
77		}
78
79		/**
80		* Set an item in cache.
81		*
82		* @param string $key
83		* @param array $location
84		*/
85	6	public function set($key, array $location)
86		{
87	6	$this->store()->put($key, $location, $this->expires);
88	6	}
89
90		/**
91		* Flush cache for tags.
92		*/
93		public function flush()
94		{
95		$this->store()->flush();
		0 ignored issues – show Bug introduced 2018-02-19 19:04 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Cache\Repository` as the method `flush()` does only exist in the following implementations of said interface: `Illuminate\Cache\RedisTaggedCache`, `Illuminate\Cache\TaggedCache`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
96		}
97		}
98

ARCANEDEV / GeoIP

Cache::set() A last analyzed 2018-02-19 19:26 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Cache::set() A
last analyzed 2018-02-19 19:26 UTC