Item::expiresAt() - Code Metrics - frqnck/apix-cache - Measure and Improve Code Quality continuously with Scrutinizer

Item::expiresAt() B
last analyzed 2017-05-02 13:14 UTC

↳ Parent: Project

Complexity

Conditions	4
Paths	4

Size

Total Lines	22
Code Lines	12

Duplication

Lines	22
Ratio	100 %

Code Coverage

Tests	4
CRAP Score	4

Importance

Changes

Metric	Value
dl	22
loc	22
ccs	4
cts	4
cp	1
rs	8.9197
c	0
b	0
f	0
cc	4
eloc	12
nc	4
nop	1
crap	4

<?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 Psr\Cache\CacheItemInterface as ItemInterface;
use Psr\Cache\CacheItemPoolInterface as ItemPoolInterface;

class Item implements ItemInterface
{
    const DEFAULT_EXPIRATION = 'now +1 year';

    /**
     * The cache key for the item.
     * @var string
     */
    protected $key;

    /**
     * The raw (unserialized) cached value.
     * @var mixed
     */
    protected $value;

    /**
     * Wether the item has been saved to the cache yet.
     * @var bool
     */
    protected $hit = false;

    /**
     * The expiration date.
     * @var \DateTime
     */
    protected $expiration;

    /**
     * Constructs a new Item.
     * You should never use this directly. It is used internally to create items
     * from the pool.
     * @param string                 $key   The item key
     * @param mixed                  $value The item value (unserialized)
     * @param \DateTime|integer|null $ttl
     * @param bool                   $hit   Was this item retrived from cache?
     */
    public function __construct($key, $value = null, $ttl = null, $hit = false)
    {
        $this->key = self::normalizedKey($key);
        $this->value = $value;
        $this->hit = $hit;
        $this->expiresAt($ttl);

    }

    /**
     * Returns a normalised key.
     *
     * @return string
     */
    public static function normalizedKey($key)
    {
        if (!is_string($key) || empty($key) || strpbrk($key, '{}()/\@:') ) {
            throw new InvalidArgumentException(
                'Item key (' . var_export($key, true) . ') is invalid.'
            );
        }

        return $key;
    }

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

    /**
     * {@inheritdoc}
     */
    public function get()
    {
        return $this->hit ? $this->value : null;
    }

    /**
     * {@inheritdoc}
     */
    public function set($value = null)
    {
        $this->value = $value;
        $this->hit = false;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function isHit()
    {
        return $this->hit && $this->getTtlInSecond() > 0;
    }

    /**
     * {@inheritdoc}
     */
    public function getExpiration()
    {
        return $this->expiration;
    }

    /**
     * Returns the time to live in second.
     *
     * @return integer
     */
    public function getTtlInSecond()
    {
        return $this->expiration->format('U') - time();
    }

    /**
     * Sets the cache hit for this item.
     *
     * @param  boolean $hit
     * @return static The invoked object.
     */
    public function setHit($hit)
    {
        $this->hit = (bool) $hit;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function expiresAt($expiration = null)

    {
        if ($expiration instanceof \DateTime) {
            $this->expiration = $expiration;

        } elseif (is_int($expiration)) {
            $this->expiration = new \DateTime(
                'now +' . $expiration . ' seconds'
            );

        } elseif (null === $expiration) {
            $this->expiration = new \DateTime(self::DEFAULT_EXPIRATION);

        } else {

            throw new InvalidArgumentException(
                'Integer or \DateTime object expected.'
            );
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function expiresAfter($time)

    {
        if ($time instanceof \DateInterval) {
            $this->expiration = new \DateTime();
            $this->expiration->add($time);

        } elseif (is_int($time)) {
            $this->expiration = new \DateTime('now +' . $time . ' seconds');

        } elseif (null === $time) {
            $this->expiration = new \DateTime(self::DEFAULT_EXPIRATION);

        } else {

            throw new InvalidArgumentException(
                'Integer or \DateInterval object expected.'
            );
        }

        return $this;
    }

    /**
     * Returns the item value.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->value;
    }

}


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 Psr\Cache\CacheItemInterface as ItemInterface;
16			use Psr\Cache\CacheItemPoolInterface as ItemPoolInterface;
17
18			class Item implements ItemInterface
19			{
20			const DEFAULT_EXPIRATION = 'now +1 year';
21
22			/**
23			* The cache key for the item.
24			* @var string
25			*/
26			protected $key;
27
28			/**
29			* The raw (unserialized) cached value.
30			* @var mixed
31			*/
32			protected $value;
33
34			/**
35			* Wether the item has been saved to the cache yet.
36			* @var bool
37			*/
38			protected $hit = false;
39
40			/**
41			* The expiration date.
42			* @var \DateTime
43			*/
44			protected $expiration;
45
46			/**
47			* Constructs a new Item.
48			* You should never use this directly. It is used internally to create items
49			* from the pool.
50			* @param string $key The item key
51			* @param mixed $value The item value (unserialized)
52			* @param \DateTime\|integer\|null $ttl
53			* @param bool $hit Was this item retrived from cache?
54			*/
55			public function __construct($key, $value = null, $ttl = null, $hit = false)
56			{
57			$this->key = self::normalizedKey($key);
58			$this->value = $value;
59			$this->hit = $hit;
60			$this->expiresAt($ttl);
			0 ignored issues – show Bug introduced 2016-06-20 14:05 UTC by Report Bug Copy Issue Report It seems like `$ttl` defined by parameter `$ttl` on line 55 can also be of type `integer` or `object<DateTime>`; however, `Apix\Cache\PsrCache\Item::expiresAt()` does only seem to accept `object<DateTimeInterface>\|null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
61	1037		}
62
63	1037		/**
64	34		* Returns a normalised key.
65			*
66	34		* @return string
67			*/
68	1037		public static function normalizedKey($key)
69	1037		{
70	1037		if (!is_string($key) \|\| empty($key) \|\| strpbrk($key, '{}()/\@:') ) {
71	1037		throw new InvalidArgumentException(
72	1037		'Item key (' . var_export($key, true) . ') is invalid.'
73			);
74			}
75
76			return $key;
77	459		}
78
79	459		/**
80			* {@inheritdoc}
81			*/
82			public function getKey()
83			{
84			return $this->key;
85	493		}
86
87	493		/**
88			* {@inheritdoc}
89			*/
90			public function get()
91			{
92			return $this->hit ? $this->value : null;
93	425		}
94
95	425		/**
96	425		* {@inheritdoc}
97			*/
98	425		public function set($value = null)
99			{
100			$this->value = $value;
101			$this->hit = false;
102
103			return $this;
104	493		}
105
106	493		/**
107			* {@inheritdoc}
108			*/
109			public function isHit()
110			{
111			return $this->hit && $this->getTtlInSecond() > 0;
112			}
113
114			/**
115			* {@inheritdoc}
116			*/
117			public function getExpiration()
118			{
119			return $this->expiration;
120			}
121
122			/**
123			* Returns the time to live in second.
124			*
125			* @return integer
126			*/
127			public function getTtlInSecond()
128			{
129			return $this->expiration->format('U') - time();
130			}
131
132			/**
133			* Sets the cache hit for this item.
134			*
135			* @param boolean $hit
136			* @return static The invoked object.
137			*/
138			public function setHit($hit)
139			{
140			$this->hit = (bool) $hit;
141
142			return $this;
143			}
144	272
145			/**
146	272		* {@inheritdoc}
147			*/
148		View Code Duplication	public function expiresAt($expiration = null)
			0 ignored issues – show Duplication introduced 2016-01-06 16:35 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
149			{
150			if ($expiration instanceof \DateTime) {
151			$this->expiration = $expiration;
152
153			} elseif (is_int($expiration)) {
154	493		$this->expiration = new \DateTime(
155			'now +' . $expiration . ' seconds'
156	493		);
157
158			} elseif (null === $expiration) {
159			$this->expiration = new \DateTime(self::DEFAULT_EXPIRATION);
160
161			} else {
162
163			throw new InvalidArgumentException(
164			'Integer or \DateTime object expected.'
165			);
166	425		}
167
168	425		return $this;
169			}
170	425
171			/**
172			* {@inheritdoc}
173			*/
174		View Code Duplication	public function expiresAfter($time)
			0 ignored issues – show Duplication introduced 2016-01-05 18:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
175			{
176	1037		if ($time instanceof \DateInterval) {
177			$this->expiration = new \DateTime();
178	1037		$this->expiration->add($time);
179	68
180			} elseif (is_int($time)) {
181	1037		$this->expiration = new \DateTime('now +' . $time . ' seconds');
182	221
183	221		} elseif (null === $time) {
184	221		$this->expiration = new \DateTime(self::DEFAULT_EXPIRATION);
185
186	1037		} else {
187	1037
188			throw new InvalidArgumentException(
189	1037		'Integer or \DateInterval object expected.'
190			);
191	34		}
192
193	34		return $this;
194			}
195
196	1037		/**
197			* Returns the item value.
198			*
199			* @return string
200			*/
201			public function __toString()
202	170		{
203			return $this->value;
204	170		}
205	34
206			}
207

frqnck / apix-cache

Item::expiresAt() B last analyzed 2017-05-02 13:14 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Item::expiresAt() B
last analyzed 2017-05-02 13:14 UTC