Completed
Push — master ( 8dafd6...46bcfe )
by Anton
02:53
created

initializeHasExpiredAtHelpers()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 0
dl 0
loc 3
rs 10
c 0
b 0
f 0
1
<?php
2
3
/*
4
 * This file is part of Laravel Eloquent Flag.
5
 *
6
 * (c) Anton Komarev <[email protected]>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
declare(strict_types=1);
13
14
namespace Cog\Flag\Traits\Inverse;
15
16
use Illuminate\Support\Carbon;
17
18
trait HasExpiredAtHelpers
19
{
20
    public function initializeHasExpiredAtHelpers(): void
21
    {
22
        $this->dates[] = 'expired_at';
0 ignored issues
show
Bug Best Practice introduced by
The property dates does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.
Loading history...
23
    }
24
25
    /**
26
     * Set expired flag.
27
     *
28
     * @return static
29
     */
30
    public function setExpiredFlag()
31
    {
32
        $this->setAttribute('expired_at', Carbon::now());
0 ignored issues
show
Bug introduced by
It seems like setAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

32
        $this->/** @scrutinizer ignore-call */ 
33
               setAttribute('expired_at', Carbon::now());
Loading history...
33
34
        return $this;
35
    }
36
37
    /**
38
     * Unset expired flag.
39
     *
40
     * @return static
41
     */
42
    public function unsetExpiredFlag()
43
    {
44
        $this->setAttribute('expired_at', null);
45
46
        return $this;
47
    }
48
49
    /**
50
     * If entity is expired.
51
     *
52
     * @return bool
53
     */
54
    public function isExpired(): bool
55
    {
56
        return !is_null($this->getAttributeValue('expired_at'));
0 ignored issues
show
Bug introduced by
It seems like getAttributeValue() must be provided by classes using this trait. How about adding it as abstract method to this trait? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

56
        return !is_null($this->/** @scrutinizer ignore-call */ getAttributeValue('expired_at'));
Loading history...
57
    }
58
59
    /**
60
     * If entity is opened.
61
     *
62
     * @return bool
63
     */
64
    public function isUnexpired(): bool
65
    {
66
        return !$this->isExpired();
67
    }
68
69
    /**
70
     * Mark entity as expired.
71
     *
72
     * @return void
73
     */
74
    public function expire(): void
75
    {
76
        $this->setExpiredFlag()->save();
0 ignored issues
show
Bug introduced by
It seems like save() must be provided by classes using this trait. How about adding it as abstract method to this trait? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

76
        $this->setExpiredFlag()->/** @scrutinizer ignore-call */ save();
Loading history...
77
78
        $this->fireModelEvent('expired', false);
0 ignored issues
show
Bug introduced by
It seems like fireModelEvent() must be provided by classes using this trait. How about adding it as abstract method to this trait? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

78
        $this->/** @scrutinizer ignore-call */ 
79
               fireModelEvent('expired', false);
Loading history...
79
    }
80
81
    /**
82
     * Mark entity as opened.
83
     *
84
     * @return void
85
     */
86
    public function unexpire(): void
87
    {
88
        $this->unsetExpiredFlag()->save();
89
90
        $this->fireModelEvent('unexpired', false);
91
    }
92
}
93