UserVO::jsonSerialize() - Code Metrics - Inspection of "return Job when dispatching a background event" - brainexe/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b1744c...51aee2 )

by Matze

created 2017-01-04 21:15 UTC

UserVO::jsonSerialize() A

↳ Parent: UserVO

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 BrainExe\Core\Authentication;

use JsonSerializable;

/**
 * @todo it's too project specific...

 * @api
 */
class UserVO implements JsonSerializable
{

    const PROPERTY_AVATAR = 'avatar';
    const PROPERTY_EMAIL  = 'email';

    const ROLE_ADMIN = 'admin';
    const ROLE_USER  = 'user';

    const AVATAR_1 = 'avatar1.png';
    const AVATAR_2 = 'avatar2.png';
    const AVATAR_3 = 'avatar3.png';
    const AVATAR_4 = 'avatar4.png';
    const AVATAR_5 = 'avatar5.png';

    const DEFAULT_AVATAR = self::AVATAR_5;

    const ROLES = [
        self::ROLE_ADMIN,
        self::ROLE_USER
    ];

    const ROLE_MAP = [
        self::ROLE_USER => [self::ROLE_ADMIN]
    ];

    const AVATARS = [
        self::AVATAR_1,
        self::AVATAR_2,
        self::AVATAR_3,
        self::AVATAR_4,
        self::AVATAR_5,
    ];

    /**
     * @var int
     */
    public $id = 0;

    /**
     * @var string
     */
    public $username;

    /**
     * @var string
     */
    public $password_hash;

    /**
     * @var string
     */
    public $one_time_secret;

    /**
     * @todo needed in VO?

     * @var string
     */
    public $password;

    /**
     * @var string
     */
    public $email;

    /**
     * @var string[]
     */
    public $roles = [];

    /**
     * @var string
     */
    public $avatar;

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

    /**
     * @param string $role
     * @return bool
     */
    public function hasRole(string $role) : bool
    {
        if (in_array($role, $this->roles)) {
            return true;
        };

        if (!empty(self::ROLE_MAP[$role])) {
            foreach (self::ROLE_MAP[$role] as $slaveRole) {
                if ($this->hasRole($slaveRole)) {
                    return true;
                }
            }
        }

        return false;
    }

    /**
     * @return string[]
     */
    public function getRoles() : array
    {
        return $this->roles;
    }

    /**
     * {@inheritdoc}
     */
    public function getPassword() :string
    {
        return $this->password_hash;
    }

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

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

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

    /**
     * @return array
     */
    public function toArray()
    {
        return [
            'userId'   => $this->id,
            'username' => $this->username,
            'roles'    => $this->roles,
            'email'    => $this->email,
            'avatar'   => $this->avatar,
        ];
    }
}


1		<?php
2
3		namespace BrainExe\Core\Authentication;
4
5		use JsonSerializable;
6
7		/**
8		* @todo it's too project specific...
		0 ignored issues – show Coding Style introduced 2016-10-24 19:50 UTC by Report Bug Copy Issue Report Comment refers to a TODO task This check looks `TODO` comments that have been left in the code. ``TODO``s show that something is left unfinished and should be attended to. Loading history...
9		* @api
10		*/
11		class UserVO implements JsonSerializable
12		{
13
14		const PROPERTY_AVATAR = 'avatar';
15		const PROPERTY_EMAIL = 'email';
16
17		const ROLE_ADMIN = 'admin';
18		const ROLE_USER = 'user';
19
20		const AVATAR_1 = 'avatar1.png';
21		const AVATAR_2 = 'avatar2.png';
22		const AVATAR_3 = 'avatar3.png';
23		const AVATAR_4 = 'avatar4.png';
24		const AVATAR_5 = 'avatar5.png';
25
26		const DEFAULT_AVATAR = self::AVATAR_5;
27
28		const ROLES = [
29		self::ROLE_ADMIN,
30		self::ROLE_USER
31		];
32
33		const ROLE_MAP = [
34		self::ROLE_USER => [self::ROLE_ADMIN]
35		];
36
37		const AVATARS = [
38		self::AVATAR_1,
39		self::AVATAR_2,
40		self::AVATAR_3,
41		self::AVATAR_4,
42		self::AVATAR_5,
43		];
44
45		/**
46		* @var int
47		*/
48		public $id = 0;
49
50		/**
51		* @var string
52		*/
53		public $username;
54
55		/**
56		* @var string
57		*/
58		public $password_hash;
59
60		/**
61		* @var string
62		*/
63		public $one_time_secret;
64
65		/**
66		* @todo needed in VO?
		0 ignored issues – show Coding Style introduced 2016-10-24 19:50 UTC by Report Bug Copy Issue Report Comment refers to a TODO task This check looks `TODO` comments that have been left in the code. ``TODO``s show that something is left unfinished and should be attended to. Loading history...
67		* @var string
68		*/
69		public $password;
70
71		/**
72		* @var string
73		*/
74		public $email;
75
76		/**
77		* @var string[]
78		*/
79		public $roles = [];
80
81		/**
82		* @var string
83		*/
84		public $avatar;
85
86		/**
87		* @return int
88		*/
89	1	public function getId() : int
90		{
91	1	return $this->id;
92		}
93
94		/**
95		* @param string $role
96		* @return bool
97		*/
98	3	public function hasRole(string $role) : bool
99		{
100	3	if (in_array($role, $this->roles)) {
101	3	return true;
102		};
103
104	3	if (!empty(self::ROLE_MAP[$role])) {
105	1	foreach (self::ROLE_MAP[$role] as $slaveRole) {
106	1	if ($this->hasRole($slaveRole)) {
107	1	return true;
108		}
109		}
110		}
111
112	3	return false;
113		}
114
115		/**
116		* @return string[]
117		*/
118	1	public function getRoles() : array
119		{
120	1	return $this->roles;
121		}
122
123		/**
124		* {@inheritdoc}
125		*/
126	1	public function getPassword() :string
127		{
128	1	return $this->password_hash;
129		}
130
131		/**
132		* {@inheritdoc}
133		*/
134	1	public function getSalt()
135		{
136	1	return $this->username;
137		}
138
139		/**
140		* {@inheritdoc}
141		*/
142	1	public function getUsername()
143		{
144	1	return $this->username;
145		}
146
147		/**
148		* @return array
149		*/
150	1	public function jsonSerialize()
151		{
152	1	return $this->toArray();
153		}
154
155		/**
156		* @return array
157		*/
158	1	public function toArray()
159		{
160		return [
161	1	'userId' => $this->id,
162	1	'username' => $this->username,
163	1	'roles' => $this->roles,
164	1	'email' => $this->email,
165	1	'avatar' => $this->avatar,
166		];
167		}
168		}
169

brainexe / core

Push — master ( b1744c...51aee2 )

UserVO::jsonSerialize() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like