LocalAdapter::createValue() - Code Metrics - Inspection of "Fixes incorrect namespace on LocalAdapter" - journeygroup/cache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a51611...9c396e )

by Justin

created 2017-02-09 04:39 UTC

LocalAdapter::createValue() A

↳ Parent: LocalAdapter

Complexity

Conditions	2
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

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

<?php

namespace Journey\Cache\Adapters;

use Journey\Cache\CacheAdapterInterface;
use Journey\Cache\CacheException;

class LocalAdapter implements CacheAdapterInterface
{
    /**
     * A filesystem path to store cache values.
     *
     * @var string
     */
    protected $path;

    /**
     * Initialize a new localcache.
     *
     * @param string $filepath
     */
    public function __construct($filepath)
    {
        if (!is_dir($filepath)) {
            throw new CacheException('Cache file path is not a directory.');
        }
        $this->path = rtrim($filepath, "/");
    }

    /**
     * Must implement a set method.
     *
     * @param  string $key   key to set as the cache value.
     * @param  mixed  $value returns the value of the cached item.
     * @return $this
     */
    public function set($key, $value, $expiration = false)
    {
        $path = $this->filename($key);
        file_put_contents($path, $this->createValue($value, $expiration));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        return $this;
    }

    /**
     * Must implement a get method.
     *
     * @param  string $key   Get a cached item by key.
     * @return mixed         Returns cached item or false.
     */
    public function get($key)
    {
        $path = $this->filename($key);
        $file = @fopen($path, 'r');
        if (!$file) {
            return false;
        }
        $timestamp = fgets($file, 11);
        fclose($file);
        if ($timestamp > time() || $timestamp == "00000000000") {
            return substr(file_get_contents($path), 11);
        }
        return false;
    }

    /**
     * Must implement a delete method.
     *
     * @param  string $key delete a specific cached item by key.
     * @return $this
     */
    public function delete($key)
    {
        $file = $this->filename($key);
        unlink($file);
        return $this;
    }

    /**
     * Clear all of the values set by this cache instance.
     *
     * @return $this
     */
    public function clear()
    {
        $key = $this->key();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        $files = glob($this->path . "/_cache-" . $key . "*.cache");
        $this->setKey();
        $this->key(true);
        foreach ($files as $file) {
            unlink($file);
        }
        return $this;
    }

    /**
     * Returns the filename of a key.
     *
     * @param  string $key name of the key
     * @return void
     */
    public function filename($key)
    {
        return $this->path . "/_cache-" . $this->key() . "-" . $key . ".cache";
    }

    /**
     * Create a parsable value from the data and expiration date.
     *
     * @param  string  $value      value of the store
     * @param  integer $expiration integer value of the expiration (unix timestamp)
     * @return void
     */
    public function createValue($value, $expiration)
    {
        $expiration = $expiration ? str_pad($expiration, 11, "0". STR_PAD_LEFT) : "00000000000";
        return $expiration . $value;
    }

    /**
     * Gets the current cache namespace key.
     *
     * Note: to save on time spent reading/writing to disk, this method uses
     * static caching. Its important that when a cache key gets reset this
     * method has it's local cache reset by passing `true`.
     *
     * @param  boolean $reset resets the static cache.
     * @return void
     */
    public function key($reset = false)
    {
        static $key;
        $key = $reset ? false : $key;
        if (!$key) {
            $path = $this->path . "/.cache_key";
            if (file_exists($path)) {
                $key = file_get_contents($path);
            } else {
                $key = $this->setKey();
            }
        }
        return $key;
    }

    /**
     * Set the current cache key.
     */
    public function setKey()
    {
        $path = $this->path . "/.cache_key";
        $key = bin2hex(openssl_random_pseudo_bytes(6));
        file_put_contents($path, $key);
        return $key;
    }
}


1		<?php
2
3		namespace Journey\Cache\Adapters;
4
5		use Journey\Cache\CacheAdapterInterface;
6		use Journey\Cache\CacheException;
7
8		class LocalAdapter implements CacheAdapterInterface
9		{
10		/**
11		* A filesystem path to store cache values.
12		*
13		* @var string
14		*/
15		protected $path;
16
17		/**
18		* Initialize a new localcache.
19		*
20		* @param string $filepath
21		*/
22	6	public function __construct($filepath)
23		{
24	6	if (!is_dir($filepath)) {
25	1	throw new CacheException('Cache file path is not a directory.');
26		}
27	6	$this->path = rtrim($filepath, "/");
28	6	}
29
30		/**
31		* Must implement a set method.
32		*
33		* @param string $key key to set as the cache value.
34		* @param mixed $value returns the value of the cached item.
35		* @return $this
36		*/
37	4	public function set($key, $value, $expiration = false)
38		{
39	4	$path = $this->filename($key);
40	4	file_put_contents($path, $this->createValue($value, $expiration));
		0 ignored issues – show Documentation introduced 2017-02-09 03:49 UTC by Report Bug Copy Issue Report `$expiration` is of type `boolean`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
41	4	return $this;
42		}
43
44		/**
45		* Must implement a get method.
46		*
47		* @param string $key Get a cached item by key.
48		* @return mixed Returns cached item or false.
49		*/
50	4	public function get($key)
51		{
52	4	$path = $this->filename($key);
53	4	$file = @fopen($path, 'r');
54	4	if (!$file) {
55	2	return false;
56		}
57	2	$timestamp = fgets($file, 11);
58	2	fclose($file);
59	2	if ($timestamp > time() \|\| $timestamp == "00000000000") {
60	1	return substr(file_get_contents($path), 11);
61		}
62	1	return false;
63		}
64
65		/**
66		* Must implement a delete method.
67		*
68		* @param string $key delete a specific cached item by key.
69		* @return $this
70		*/
71	1	public function delete($key)
72		{
73	1	$file = $this->filename($key);
74	1	unlink($file);
75	1	return $this;
76		}
77
78		/**
79		* Clear all of the values set by this cache instance.
80		*
81		* @return $this
82		*/
83	1	public function clear()
84		{
85	1	$key = $this->key();
		0 ignored issues – show Bug introduced 2017-02-09 04:42 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$key` is correct as `$this->key()` (which targets `Journey\Cache\Adapters\LocalAdapter::key()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
86	1	$files = glob($this->path . "/_cache-" . $key . "*.cache");
87	1	$this->setKey();
88	1	$this->key(true);
89	1	foreach ($files as $file) {
90	1	unlink($file);
91	1	}
92	1	return $this;
93		}
94
95		/**
96		* Returns the filename of a key.
97		*
98		* @param string $key name of the key
99		* @return void
100		*/
101	4	public function filename($key)
102		{
103	4	return $this->path . "/_cache-" . $this->key() . "-" . $key . ".cache";
104		}
105
106		/**
107		* Create a parsable value from the data and expiration date.
108		*
109		* @param string $value value of the store
110		* @param integer $expiration integer value of the expiration (unix timestamp)
111		* @return void
112		*/
113	4	public function createValue($value, $expiration)
114		{
115	4	$expiration = $expiration ? str_pad($expiration, 11, "0". STR_PAD_LEFT) : "00000000000";
116	4	return $expiration . $value;
117		}
118
119		/**
120		* Gets the current cache namespace key.
121		*
122		* Note: to save on time spent reading/writing to disk, this method uses
123		* static caching. Its important that when a cache key gets reset this
124		* method has it's local cache reset by passing `true`.
125		*
126		* @param boolean $reset resets the static cache.
127		* @return void
128		*/
129	4	public function key($reset = false)
130		{
131	4	static $key;
132	4	$key = $reset ? false : $key;
133	4	if (!$key) {
134	2	$path = $this->path . "/.cache_key";
135	2	if (file_exists($path)) {
136	1	$key = file_get_contents($path);
137	1	} else {
138	1	$key = $this->setKey();
139		}
140	2	}
141	4	return $key;
142		}
143
144		/**
145		* Set the current cache key.
146		*/
147	2	public function setKey()
148		{
149	2	$path = $this->path . "/.cache_key";
150	2	$key = bin2hex(openssl_random_pseudo_bytes(6));
151	2	file_put_contents($path, $key);
152	2	return $key;
153		}
154		}
155

journeygroup / cache

Push — master ( a51611...9c396e )

LocalAdapter::createValue() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like