Passed
Push — develop ( 5130a6...cbfd9b )
by nguereza
02:50
created

User::jsonSerialize()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 12
Code Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 10
nc 1
nop 0
dl 0
loc 12
rs 9.9332
c 0
b 0
f 0
1
<?php
2
3
/**
4
 * Platine Framework
5
 *
6
 * Platine Framework is a lightweight, high-performance, simple and elegant
7
 * PHP Web framework
8
 *
9
 * This content is released under the MIT License (MIT)
10
 *
11
 * Copyright (c) 2020 Platine Framework
12
 *
13
 * Permission is hereby granted, free of charge, to any person obtaining a copy
14
 * of this software and associated documentation files (the "Software"), to deal
15
 * in the Software without restriction, including without limitation the rights
16
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
 * copies of the Software, and to permit persons to whom the Software is
18
 * furnished to do so, subject to the following conditions:
19
 *
20
 * The above copyright notice and this permission notice shall be included in all
21
 * copies or substantial portions of the Software.
22
 *
23
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
 * SOFTWARE.
30
 */
31
32
/**
33
 *  @file User.php
34
 *
35
 *  The User Entity class
36
 *
37
 *  @package    Platine\Framework\Auth\Entity
38
 *  @author Platine Developers team
39
 *  @copyright  Copyright (c) 2020
40
 *  @license    http://opensource.org/licenses/MIT  MIT License
41
 *  @link   http://www.iacademy.cf
42
 *  @version 1.0.0
43
 *  @filesource
44
 */
45
46
declare(strict_types=1);
47
48
namespace Platine\Framework\Auth\Entity;
49
50
use Platine\Framework\Auth\IdentityInterface;
51
use Platine\Orm\Entity;
52
use Platine\Orm\Mapper\EntityMapperInterface;
53
use Platine\Orm\Query\Query;
54
55
/**
56
 * @class User
57
 * @package Platine\Framework\Auth\Entity
58
 */
59
class User extends Entity implements IdentityInterface
60
{
61
62
    /**
63
     * {@inheritdoc}
64
     */
65
    public static function mapEntity(EntityMapperInterface $mapper): void
66
    {
67
        $mapper->relation('roles')->shareMany(Role::class);
68
        $mapper->useTimestamp();
69
        $mapper->casts([
70
            'created_at' => 'date',
71
            'updated_at' => '?date',
72
        ]);
73
74
        $mapper->filter('status', function (Query $q, $status) {
75
            $q->where('status')->is($status);
76
        });
77
    }
78
79
    /**
80
     * Set roles
81
     * @param Role[] $roles
82
     * @return $this
83
     */
84
    public function setRoles(array $roles): self
85
    {
86
        foreach ($roles as $role) {
87
            $this->mapper()->link('roles', $role);
88
        }
89
90
        return $this;
91
    }
92
93
    /**
94
     * Remove roles
95
     * @param Role[] $roles
96
     * @return $this
97
     */
98
    public function removeRoles(array $roles): self
99
    {
100
        foreach ($roles as $role) {
101
            $this->mapper()->unlink('roles', $role);
102
        }
103
104
        return $this;
105
    }
106
107
    /**
108
     * {@inheritdoc}
109
     */
110
    public function getId()
111
    {
112
        return $this->mapper()->getColumn('id');
113
    }
114
115
    /**
116
     * {@inheritdoc}
117
     */
118
    public function getName(): string
119
    {
120
        return sprintf(
121
            '%s %s',
122
            $this->mapper()->getColumn('firstname'),
123
            $this->mapper()->getColumn('lastname')
124
        );
125
    }
126
127
    /**
128
     * {@inheritdoc}
129
     */
130
    public function getUsername(): string
131
    {
132
        return $this->mapper()->getColumn('username');
133
    }
134
}
135