OtpToken::plainText() - Code Metrics - Inspection of "feat: Reimplements the package (wip)" - erdemkeren/laravel-otp - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#20)

by Hilmi Erdem

created 2021-11-22 21:29 UTC

OtpToken::plainText() A

↳ Parent: OtpToken

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

<?php
/*
 * Copyright (c) 2021. Hilmi Erdem Keren
 * license MIT
 */

namespace Erdemkeren\Otp;

use Carbon\Carbon;

/**
 * Class OtpToken.
 */
class OtpToken
{
    /**
     * OtpToken constructor.
     *
     * @param  array  $attributes
     */
    public function __construct(private array $attributes)
    {
        if (! array_key_exists('created_at', $this->attributes)) {
            $this->attributes['created_at'] = $this->getNow();
            $this->attributes['updated_at'] = $this->getNow();
        }
    }

    /**
     * Get the plain text.
     *
     * @return string|null
     */
    public function plainText(): ?string
    {
        return $this->getAttributeValue('plain_text');
    }

    /**
     * Get the cipher text of the token.
     *
     * @return string
     */
    public function cipherText(): string
    {
        return $this->getAttributeValue('cipher_text');
    }

    /**
     * Get the expiry time of the token.
     *
     * @return int
     */
    public function expiryTime(): int
    {
        return $this->getAttributeValue('expiry_time');
    }

    /**
     * Get the time left for the expiration.
     *
     * @return int
     */
    public function timeLeft(): int
    {
        return $this->getNow()->diffInSeconds($this->expiresAt(), false);
    }

    /**
     * Get the expiry date.
     *
     * @return Carbon
     */
    public function expiresAt(): Carbon
    {
        return (clone $this->createdAt())->addSeconds($this->expiryTime());
    }

    /**
     * Get the authenticable id.
     *
     * @return int|string
     */
    public function authenticableId(): int|string
    {
        return $this->getAttributeValue('authenticable_id');
    }

    /**
     * Get the date token was created.
     *
     * @return Carbon
     */
    public function createdAt(): Carbon
    {
        return new Carbon($this->getAttributeValue('created_at'));
    }

    /**
     * Get the last date the token was updated.
     *
     * @return Carbon
     */
    public function updatedAt(): Carbon
    {
        return new Carbon($this->getAttributeValue('updated_at'));
    }

    /**
     * Get a new instance of the token
     * with an extended expiry time.
     *
     * @param  int  $secs
     * @return $this
     */
    public function extend(int $secs): self
    {
        return new static(array_merge($this->attributes, [
            'expiry_time' => $this->expiryTime() + $secs,
            'updated_at' => $this->getNow(),
        ]));
    }

    /**
     * Get a new instance of the token
     * with a refreshed expiry time.
     */
    public function refresh(): self
    {
        return $this->extend($this->getNow()->diffInSeconds($this->updatedAt()));
    }

    /**
     * Get a new instance of the token
     * that is expired.
     */
    public function invalidate(): self
    {
        return new static(array_merge($this->attributes, [
            'expiry_time' => 0,
            'updated_at' => $this->getNow(),
        ]));
    }

    /**
     * Determine if the token is expired or not.
     *
     * @return bool
     */
    public function expired(): bool
    {
        return $this->timeLeft() <= 0;
    }

    /**
     * Get the token without the plain text.
     *
     * return self
     */
    public function withoutPlainText(): self
    {
        return new static(array_filter(array_merge($this->attributes, [
            'plain_text' => null,
        ])));
    }

    /**
     * Get the array representation of the token.
     *
     * @return array
     */
    public function toArray(): array
    {
        return $this->attributes;
    }

    /**
     * Get the date time at the moment.
     *
     * @return Carbon
     */
    private function getNow(): Carbon
    {
        return Carbon::now();
    }

    /**
     * Get the value of an attribute.
     *
     * @param  string  $key
     * @return mixed
     */
    private function getAttributeValue(string $key): mixed
    {
        return array_key_exists($key, $this->attributes)
            ? $this->attributes[$key]
            : null;
    }
}


1			<?php
2			/*
3			* Copyright (c) 2021. Hilmi Erdem Keren
4			* license MIT
5			*/
6
7			namespace Erdemkeren\Otp;
8
9			use Carbon\Carbon;
10
11			/**
12			* Class OtpToken.
13			*/
14			class OtpToken
15			{
16			/**
17			* OtpToken constructor.
18			*
19			* @param array $attributes
20			*/
21			public function __construct(private array $attributes)
22			{
23			if (! array_key_exists('created_at', $this->attributes)) {
24			$this->attributes['created_at'] = $this->getNow();
25			$this->attributes['updated_at'] = $this->getNow();
26			}
27			}
28
29			/**
30			* Get the plain text.
31			*
32			* @return string\|null
33			*/
34			public function plainText(): ?string
35			{
36			return $this->getAttributeValue('plain_text');
37			}
38
39			/**
40			* Get the cipher text of the token.
41			*
42			* @return string
43			*/
44			public function cipherText(): string
45			{
46			return $this->getAttributeValue('cipher_text');
47			}
48
49			/**
50			* Get the expiry time of the token.
51			*
52			* @return int
53			*/
54			public function expiryTime(): int
55			{
56			return $this->getAttributeValue('expiry_time');
57			}
58
59			/**
60			* Get the time left for the expiration.
61			*
62			* @return int
63			*/
64			public function timeLeft(): int
65			{
66			return $this->getNow()->diffInSeconds($this->expiresAt(), false);
67			}
68
69			/**
70			* Get the expiry date.
71			*
72			* @return Carbon
73			*/
74			public function expiresAt(): Carbon
75			{
76			return (clone $this->createdAt())->addSeconds($this->expiryTime());
77			}
78
79			/**
80			* Get the authenticable id.
81			*
82			* @return int\|string
83			*/
84			public function authenticableId(): int\|string
85			{
86			return $this->getAttributeValue('authenticable_id');
87			}
88
89			/**
90			* Get the date token was created.
91			*
92			* @return Carbon
93			*/
94			public function createdAt(): Carbon
95			{
96			return new Carbon($this->getAttributeValue('created_at'));
97			}
98
99			/**
100			* Get the last date the token was updated.
101			*
102			* @return Carbon
103			*/
104			public function updatedAt(): Carbon
105			{
106			return new Carbon($this->getAttributeValue('updated_at'));
107			}
108
109			/**
110			* Get a new instance of the token
111			* with an extended expiry time.
112			*
113			* @param int $secs
114			* @return $this
115			*/
116			public function extend(int $secs): self
117			{
118			return new static(array_merge($this->attributes, [
119			'expiry_time' => $this->expiryTime() + $secs,
120			'updated_at' => $this->getNow(),
121			]));
122			}
123
124			/**
125			* Get a new instance of the token
126			* with a refreshed expiry time.
127			*/
128			public function refresh(): self
129			{
130			return $this->extend($this->getNow()->diffInSeconds($this->updatedAt()));
131			}
132
133			/**
134			* Get a new instance of the token
135			* that is expired.
136			*/
137			public function invalidate(): self
138			{
139			return new static(array_merge($this->attributes, [
140			'expiry_time' => 0,
141			'updated_at' => $this->getNow(),
142			]));
143			}
144
145			/**
146			* Determine if the token is expired or not.
147			*
148			* @return bool
149			*/
150			public function expired(): bool
151			{
152			return $this->timeLeft() <= 0;
153			}
154
155			/**
156			* Get the token without the plain text.
157			*
158			* return self
159			*/
160			public function withoutPlainText(): self
161			{
162			return new static(array_filter(array_merge($this->attributes, [
163			'plain_text' => null,
164			])));
165			}
166
167			/**
168			* Get the array representation of the token.
169			*
170			* @return array
171			*/
172			public function toArray(): array
173			{
174			return $this->attributes;
175			}
176
177			/**
178			* Get the date time at the moment.
179			*
180			* @return Carbon
181			*/
182			private function getNow(): Carbon
183			{
184			return Carbon::now();
185			}
186
187			/**
188			* Get the value of an attribute.
189			*
190			* @param string $key
191			* @return mixed
192			*/
193			private function getAttributeValue(string $key): mixed
194			{
195			return array_key_exists($key, $this->attributes)
196			? $this->attributes[$key]
197			: null;
198			}
199			}
200

erdemkeren / laravel-otp

Pull Request — master (#20)

OtpToken::plainText() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like