Item::expiresAt() - 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

Item::expiresAt() 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 Psr\Cache\CacheItemInterface as ItemInterface;
use Psr\Cache\CacheItemPoolInterface as ItemPoolInterface;

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

    /**
     * The pool that the item belongs to.
     * @var ItemPoolInterface
     */
    // protected $pool;

    /**
     * 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)
    {
        if (strpbrk($key, '{}()/\@:')) {
            throw new InvalidArgumentException(
                'Item key contains an invalide character.' . $key
            );
        }
        $this->key = $key;
        $this->value = $value;
        $this->hit = $hit;
        $this->setExpiration($ttl);
    }

    /**
     * {@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; // TODO: check wether we should we do this?

        return $this;
    }

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

    /**
     * {@inheritdoc}
     */
    public function exists()
    {
        // TODO: review!
        return $this->hit;
    }

    /**
     * {@inheritdoc}
     */
    public function isRegenerating()
    {
        return false; // TODO
    }

    /**
     * {@inheritdoc}
     */
    public function setExpiration($ttl = null)

    {
        if ($ttl instanceof \DateTime) {
            $this->expiration = $ttl;
        } elseif (is_numeric($ttl)) {
            $this->expiration = new \DateTime('now +' . $ttl . ' seconds');
        } elseif (is_null($ttl)) {
             // stored permanently or for as long as the default value.
            $this->expiration = new \DateTime(self::DEFAULT_EXPIRATION);
        } else {
            throw new InvalidArgumentException(
                'Integer or \DateTime object expected.'
            );
        }

        return $this;
    }

    /**
     * {@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)
    {
        return $this->setExpiration($expiration);
    }

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

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

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

        } elseif (null === $time) {
            // stored permanently or for as long as the default value.
            $this->expiration = new \DateTime(self::DEFAULT_EXPIRATION);
        } else {
            throw new InvalidArgumentException(
                'Integer or \DateInterval object expected.'
            );
        }

        return $this;
    }

}


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 pool that the item belongs to.
24			* @var ItemPoolInterface
25			*/
26			// protected $pool;
27
28			/**
29			* The cache key for the item.
30			* @var string
31			*/
32			protected $key;
33
34			/**
35			* The raw (unserialized) cached value.
36			* @var mixed
37			*/
38			protected $value;
39
40			/**
41			* Wether the item has been saved to the cache yet.
42			* @var bool
43			*/
44			protected $hit = false;
45
46			/**
47			* The expiration date.
48			* @var \DateTime
49			*/
50			protected $expiration;
51
52			/**
53			* Constructs a new Item.
54			* You should never use this directly. It is used internally to create items
55			* from the pool.
56			* @param string $key The item key
57			* @param mixed $value The item value (unserialized)
58			* @param \DateTime\|integer\|null $ttl
59			* @param bool $hit Was this item retrived from cache?
60			*/
61	799		public function __construct($key, $value = null, $ttl = null, $hit = false)
62			{
63	799		if (strpbrk($key, '{}()/\@:')) {
64	34		throw new InvalidArgumentException(
65			'Item key contains an invalide character.' . $key
66	34		);
67			}
68	799		$this->key = $key;
69	799		$this->value = $value;
70	799		$this->hit = $hit;
71	799		$this->setExpiration($ttl);
72	799		}
73
74			/**
75			* {@inheritdoc}
76			*/
77	391		public function getKey()
78			{
79	391		return $this->key;
80			}
81
82			/**
83			* {@inheritdoc}
84			*/
85	425		public function get()
86			{
87	425		return $this->hit ? $this->value : null;
88			}
89
90			/**
91			* {@inheritdoc}
92			*/
93	357		public function set($value = null)
94			{
95	357		$this->value = $value;
96	357		$this->hit = false; // TODO: check wether we should we do this?
97
98	357		return $this;
99			}
100
101			/**
102			* {@inheritdoc}
103			*/
104	425		public function isHit()
105			{
106	425		return $this->hit;
107			}
108
109			/**
110			* {@inheritdoc}
111			*/
112	136		public function exists()
113			{
114			// TODO: review!
115	136		return $this->hit;
116			}
117
118			/**
119			* {@inheritdoc}
120			*/
121	34		public function isRegenerating()
122			{
123	34		return false; // TODO
124			}
125
126			/**
127			* {@inheritdoc}
128			*/
129	799	View Code Duplication	public function setExpiration($ttl = null)
			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...
130			{
131	799		if ($ttl instanceof \DateTime) {
132	68		$this->expiration = $ttl;
133	799		} elseif (is_numeric($ttl)) {
134	221		$this->expiration = new \DateTime('now +' . $ttl . ' seconds');
135	799		} elseif (is_null($ttl)) {
136			// stored permanently or for as long as the default value.
137	799		$this->expiration = new \DateTime(self::DEFAULT_EXPIRATION);
138	799		} else {
139	34		throw new InvalidArgumentException(
140			'Integer or \DateTime object expected.'
141	34		);
142			}
143
144	799		return $this;
145			}
146
147			/**
148			* {@inheritdoc}
149			*/
150	136		public function getExpiration()
151			{
152	136		return $this->expiration;
153			}
154
155			/**
156			* Returns the time to live in second.
157			*
158			* @return integer
159			*/
160	425		public function getTtlInSecond()
161			{
162	425		return $this->expiration->format('U') - time();
163			}
164
165			/**
166			* Sets the cache hit for this item.
167			*
168			* @param boolean $hit
169			* @return static
170			* The invoked object.
171			*/
172	357		public function setHit($hit)
173			{
174	357		$this->hit = (bool) $hit;
175
176	357		return $this;
177			}
178
179			/**
180			* {@inheritdoc}
181			*/
182			public function expiresAt($expiration)
183			{
184			return $this->setExpiration($expiration);
185			}
186
187			/**
188			* {@inheritdoc}
189			*/
190		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...
191			{
192			if ($time instanceof \DateInterval) {
193			$this->expiration = new \DateTime();
194			$this->expiration->add($time);
195
196			} elseif (is_numeric($time)) {
197			$this->expiration = new \DateTime('now +' . $time . ' seconds');
198
199			} elseif (null === $time) {
200			// stored permanently or for as long as the default value.
201			$this->expiration = new \DateTime(self::DEFAULT_EXPIRATION);
202			} else {
203			throw new InvalidArgumentException(
204			'Integer or \DateInterval object expected.'
205			);
206			}
207
208			return $this;
209			}
210
211			}
212

frqnck / apix-cache

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

Item::expiresAt() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like