Token::getUsages() - Code Metrics - Inspection of "Deprecate all the components about token being use..." - yokai-php/security-token-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cbde1c...f4ee14 )

by Yann

created 2018-02-14 13:54 UTC

Token::getUsages() A

↳ Parent: Token

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace Yokai\SecurityTokenBundle\Entity;

use DateTime;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use LogicException;

/**
 * @author Yann Eugoné <[email protected]>
 */
class Token
{
    /**
     * @var int
     */
    private $id;

    /**
     * @var string
     */
    private $userClass;

    /**
     * @var string
     */
    private $userId;

    /**
     * @var string
     */
    private $value;

    /**
     * @var string
     */
    private $purpose;

    /**
     * @var array
     */
    private $payload = [];

    /**
     * @var DateTime
     */
    private $createdAt;

    /**
     * @var array
     */
    private $createdInformation = [];

    /**
     * @var integer
     */
    private $allowedUsages;

    /**
     * @var DateTime
     */
    private $expiresAt;

    /**
     * @var DateTime
     */
    private $keepUntil;

    /**
     * @var Collection|TokenUsage[]
     */
    private $usages;

    /**
     * @param string  $userClass
     * @param string  $userId
     * @param string  $value
     * @param string  $purpose
     * @param string  $validDuration
     * @param string  $keepDuration
     * @param integer $allowedUsages
     * @param array   $payload
     * @param array   $information
     */
    public function __construct(
        $userClass,
        $userId,
        $value,
        $purpose,
        $validDuration,
        $keepDuration,
        $allowedUsages = 1,
        array $payload = [],
        array $information = []
    ) {
        $this->userClass = $userClass;
        $this->userId = $userId;
        $this->value = $value;
        $this->purpose = $purpose;
        $this->createdAt = new DateTime();
        $this->expiresAt = (new DateTime())->modify($validDuration);
        $this->keepUntil = (clone $this->expiresAt)->modify($keepDuration);
        $this->allowedUsages = $allowedUsages;
        $this->payload = $payload;
        $this->createdInformation = $information;
        $this->usages = new ArrayCollection();
    }

    /**
     * @return int
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @return string
     */
    public function getUserClass()
    {
        return $this->userClass;
    }

    /**
     * @return string
     */
    public function getUserId()
    {
        return $this->userId;
    }

    /**
     * @return string
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * @return string
     */
    public function getPurpose()
    {
        return $this->purpose;
    }

    /**
     * @return array
     */
    public function getPayload()
    {
        return $this->payload;
    }

    /**
     * @return DateTime
     */
    public function getCreatedAt()
    {
        return $this->createdAt;
    }

    /**
     * @return array
     */
    public function getCreatedInformation()
    {
        return $this->createdInformation;
    }

    /**
     * @return DateTime
     */
    public function getExpiresAt()
    {
        return $this->expiresAt;
    }

    /**
     * @return DateTime
     */
    public function getKeepUntil()
    {
        return $this->keepUntil;
    }

    /**
     * @return DateTime|null
     *
     * @deprecated since version 2.2 and will be removed in 3.0
     */
    public function getUsedAt()
    {
        @trigger_error(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            'The '.__METHOD__
            .' method is deprecated since version 2.2 and will be removed in 3.0. Use the getLastUsage() method instead.',
            E_USER_DEPRECATED
        );

        $usage = $this->getLastUsage();
        if (null === $usage) {
            return null;
        }

        return $usage->getCreatedAt();
    }

    /**
     * @param DateTime $usedAt
     *
     * @deprecated since version 2.2 and will be removed in 3.0
     */
    public function setUsedAt($usedAt)
    {
        @trigger_error(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            'The '.__METHOD__
            .' method is deprecated since version 2.2 and will be removed in 3.0. Use the getLastUsage() method instead.',
            E_USER_DEPRECATED
        );

        $this->consume([], $usedAt);
    }

    /**
     * @return array

     *
     * @deprecated since version 2.2 and will be removed in 3.0
     */
    public function getUsedInformation()
    {
        @trigger_error(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            'The '.__METHOD__
            .' method is deprecated since version 2.2 and will be removed in 3.0. Use the getLastUsage() method instead.',
            E_USER_DEPRECATED
        );

        $usage = $this->getLastUsage();
        if (null === $usage) {
            return null;
        }

        return $usage->getInformation();
    }

    /**
     * @param array $usedInformation
     *
     * @deprecated since version 2.2 and will be removed in 3.0
     */
    public function setUsedInformation($usedInformation)
    {
        @trigger_error(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            'The '.__METHOD__
            .' method is deprecated since version 2.2 and will be removed in 3.0. Use the getLastUsage() method instead.',
            E_USER_DEPRECATED
        );

        $this->consume($usedInformation);
    }

    /**
     * @return boolean
     */
    public function isExpired()
    {
        return $this->expiresAt < new DateTime();
    }

    /**
     * @deprecated since 2.3 and will be removed in 3.0. Use isConsumed instead.
     * @return boolean
     */
    public function isUsed()
    {
        @trigger_error(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            __METHOD__.' is deprecated. Use '.__CLASS__.'::isConsumed instead',
            E_USER_DEPRECATED
        );

        return $this->isConsumed();
    }

    /**
     * @return boolean
     */
    public function isConsumed()
    {
        return $this->getCountUsages() >= $this->getAllowedUsages();
    }

    /**
     * @return int
     */
    public function getAllowedUsages()
    {
        return $this->allowedUsages;
    }

    /**
     * @return int
     */
    public function getCountUsages()
    {
        return count($this->usages);
    }

    /**
     * @return TokenUsage[]
     */
    public function getUsages()
    {
        return $this->usages->toArray();
    }

    /**
     * @return TokenUsage|null
     */
    public function getLastUsage()
    {
        return $this->usages->last();
    }

    /**
     * @param array         $information
     * @param DateTime|null $date
     */
    public function consume(array $information, DateTime $date = null)
    {
        if ($this->isConsumed()) {
            throw new LogicException(
                sprintf('Token "%d" is already consumed.', $this->id)
            );
        }

        $this->usages->add(new TokenUsage($this, $information, $date));
    }
}


1		<?php
2
3		namespace Yokai\SecurityTokenBundle\Entity;
4
5		use DateTime;
6		use Doctrine\Common\Collections\ArrayCollection;
7		use Doctrine\Common\Collections\Collection;
8		use LogicException;
9
10		/**
11		* @author Yann Eugoné <[email protected]>
12		*/
13		class Token
14		{
15		/**
16		* @var int
17		*/
18		private $id;
19
20		/**
21		* @var string
22		*/
23		private $userClass;
24
25		/**
26		* @var string
27		*/
28		private $userId;
29
30		/**
31		* @var string
32		*/
33		private $value;
34
35		/**
36		* @var string
37		*/
38		private $purpose;
39
40		/**
41		* @var array
42		*/
43		private $payload = [];
44
45		/**
46		* @var DateTime
47		*/
48		private $createdAt;
49
50		/**
51		* @var array
52		*/
53		private $createdInformation = [];
54
55		/**
56		* @var integer
57		*/
58		private $allowedUsages;
59
60		/**
61		* @var DateTime
62		*/
63		private $expiresAt;
64
65		/**
66		* @var DateTime
67		*/
68		private $keepUntil;
69
70		/**
71		* @var Collection\|TokenUsage[]
72		*/
73		private $usages;
74
75		/**
76		* @param string $userClass
77		* @param string $userId
78		* @param string $value
79		* @param string $purpose
80		* @param string $validDuration
81		* @param string $keepDuration
82		* @param integer $allowedUsages
83		* @param array $payload
84		* @param array $information
85		*/
86	10	public function __construct(
87		$userClass,
88		$userId,
89		$value,
90		$purpose,
91		$validDuration,
92		$keepDuration,
93		$allowedUsages = 1,
94		array $payload = [],
95		array $information = []
96		) {
97	10	$this->userClass = $userClass;
98	10	$this->userId = $userId;
99	10	$this->value = $value;
100	10	$this->purpose = $purpose;
101	10	$this->createdAt = new DateTime();
102	10	$this->expiresAt = (new DateTime())->modify($validDuration);
103	10	$this->keepUntil = (clone $this->expiresAt)->modify($keepDuration);
104	10	$this->allowedUsages = $allowedUsages;
105	10	$this->payload = $payload;
106	10	$this->createdInformation = $information;
107	10	$this->usages = new ArrayCollection();
108	10	}
109
110		/**
111		* @return int
112		*/
113		public function getId()
114		{
115		return $this->id;
116		}
117
118		/**
119		* @return string
120		*/
121	2	public function getUserClass()
122		{
123	2	return $this->userClass;
124		}
125
126		/**
127		* @return string
128		*/
129	2	public function getUserId()
130		{
131	2	return $this->userId;
132		}
133
134		/**
135		* @return string
136		*/
137	1	public function getValue()
138		{
139	1	return $this->value;
140		}
141
142		/**
143		* @return string
144		*/
145	1	public function getPurpose()
146		{
147	1	return $this->purpose;
148		}
149
150		/**
151		* @return array
152		*/
153	1	public function getPayload()
154		{
155	1	return $this->payload;
156		}
157
158		/**
159		* @return DateTime
160		*/
161	1	public function getCreatedAt()
162		{
163	1	return $this->createdAt;
164		}
165
166		/**
167		* @return array
168		*/
169	1	public function getCreatedInformation()
170		{
171	1	return $this->createdInformation;
172		}
173
174		/**
175		* @return DateTime
176		*/
177	2	public function getExpiresAt()
178		{
179	2	return $this->expiresAt;
180		}
181
182		/**
183		* @return DateTime
184		*/
185	1	public function getKeepUntil()
186		{
187	1	return $this->keepUntil;
188		}
189
190		/**
191		* @return DateTime\|null
192		*
193		* @deprecated since version 2.2 and will be removed in 3.0
194		*/
195		public function getUsedAt()
196		{
197		@trigger_error(
		0 ignored issues – show Security Best Practice introduced 2017-08-03 10:26 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
198		'The '.__METHOD__
199		.' method is deprecated since version 2.2 and will be removed in 3.0. Use the getLastUsage() method instead.',
200		E_USER_DEPRECATED
201		);
202
203		$usage = $this->getLastUsage();
204		if (null === $usage) {
205		return null;
206		}
207
208		return $usage->getCreatedAt();
209		}
210
211		/**
212		* @param DateTime $usedAt
213		*
214		* @deprecated since version 2.2 and will be removed in 3.0
215		*/
216		public function setUsedAt($usedAt)
217		{
218		@trigger_error(
		0 ignored issues – show Security Best Practice introduced 2017-04-08 08:03 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
219		'The '.__METHOD__
220		.' method is deprecated since version 2.2 and will be removed in 3.0. Use the getLastUsage() method instead.',
221		E_USER_DEPRECATED
222		);
223
224		$this->consume([], $usedAt);
225		}
226
227		/**
228		* @return array
		0 ignored issues – show Documentation introduced 2017-04-09 09:07 UTC by Report Bug Copy Issue Report Should the return type not be `null\|array`? Also, consider making the array more specific, something like `array<String>`, or `String[]`. This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. If the return type contains the type array, this check recommends the use of a more specific type like `String[]` or `array<String>`. Loading history...
229		*
230		* @deprecated since version 2.2 and will be removed in 3.0
231		*/
232		public function getUsedInformation()
233		{
234		@trigger_error(
		0 ignored issues – show Security Best Practice introduced 2017-04-08 08:36 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
235		'The '.__METHOD__
236		.' method is deprecated since version 2.2 and will be removed in 3.0. Use the getLastUsage() method instead.',
237		E_USER_DEPRECATED
238		);
239
240		$usage = $this->getLastUsage();
241		if (null === $usage) {
242		return null;
243		}
244
245		return $usage->getInformation();
246		}
247
248		/**
249		* @param array $usedInformation
250		*
251		* @deprecated since version 2.2 and will be removed in 3.0
252		*/
253		public function setUsedInformation($usedInformation)
254		{
255		@trigger_error(
		0 ignored issues – show Security Best Practice introduced 2017-04-08 08:03 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
256		'The '.__METHOD__
257		.' method is deprecated since version 2.2 and will be removed in 3.0. Use the getLastUsage() method instead.',
258		E_USER_DEPRECATED
259		);
260
261		$this->consume($usedInformation);
262		}
263
264		/**
265		* @return boolean
266		*/
267	4	public function isExpired()
268		{
269	4	return $this->expiresAt < new DateTime();
270		}
271
272		/**
273		* @deprecated since 2.3 and will be removed in 3.0. Use isConsumed instead.
274		* @return boolean
275		*/
276		public function isUsed()
277		{
278		@trigger_error(
		0 ignored issues – show Security Best Practice introduced 2018-02-14 10:08 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
279		__METHOD__.' is deprecated. Use '.__CLASS__.'::isConsumed instead',
280		E_USER_DEPRECATED
281		);
282
283		return $this->isConsumed();
284		}
285
286		/**
287		* @return boolean
288		*/
289	5	public function isConsumed()
290		{
291	5	return $this->getCountUsages() >= $this->getAllowedUsages();
292		}
293
294		/**
295		* @return int
296		*/
297	5	public function getAllowedUsages()
298		{
299	5	return $this->allowedUsages;
300		}
301
302		/**
303		* @return int
304		*/
305	5	public function getCountUsages()
306		{
307	5	return count($this->usages);
308		}
309
310		/**
311		* @return TokenUsage[]
312		*/
313	2	public function getUsages()
314		{
315	2	return $this->usages->toArray();
316		}
317
318		/**
319		* @return TokenUsage\|null
320		*/
321	1	public function getLastUsage()
322		{
323	1	return $this->usages->last();
324		}
325
326		/**
327		* @param array $information
328		* @param DateTime\|null $date
329		*/
330	3	public function consume(array $information, DateTime $date = null)
331		{
332	3	if ($this->isConsumed()) {
333		throw new LogicException(
334		sprintf('Token "%d" is already consumed.', $this->id)
335		);
336		}
337
338	3	$this->usages->add(new TokenUsage($this, $information, $date));
339	3	}
340		}
341

yokai-php / security-token-bundle

Push — master ( cbde1c...f4ee14 )

Token::getUsages() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like