User::_getName() - Code Metrics - Inspection of "sanitize user's real name (#193)" - quickapps/cms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.0 ( 4f2e56...7d648f )

by Christopher

created 2018-04-05 18:42 UTC

User::_getName() A

↳ Parent: User

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	0
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * Licensed under The GPL-3.0 License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @since    2.0.0
 * @author   Christopher Castro <[email protected]>
 * @link     http://www.quickappscms.org
 * @license  http://opensource.org/licenses/gpl-3.0.html GPL-3.0 License
 */
namespace User\Model\Entity;

use Cake\Auth\DefaultPasswordHasher;
use Cake\Error\FatalErrorException;
use Cake\ORM\Entity;
use Cake\ORM\TableRegistry;
use Cake\Utility\Security;
use CMS\Core\StaticCacheTrait;

/**
 * Represents single "user" in "users" database table.
 *
 */
class User extends Entity
{

    use StaticCacheTrait;

    /**
     * Updates this user's Token value.
     *
     * The new token is persisted in DB and in this entity property.
     *
     * @return $this
     * @throws \Cake\Error\FatalErrorException When an invalid user entity was given
     * @see \User\Model\Table\UsersTable::updateToken()
     */
    public function updateToken()
    {
        return TableRegistry::get('User.Users')->updateToken($this);
    }

    /**
     * Whether this use belongs to the administrator role.
     *
     * @return bool
     */
    public function isAdmin()
    {
        $roles = $this->_getRoleIds();

        return in_array(ROLE_ID_ADMINISTRATOR, $roles);
    }

    /**
     * Verifies this user is allowed access the given ACO.
     *
     * ### Usage:
     *
     * ```php
     * // Checks if current user is allowed to edit created contents:
     * user()->isAllowed('Content/Admin/Manage/edit');
     * ```
     *
     * @param string $aco An ACO path. e.g. `Plugin/Prefix/Controller/action`
     * @return bool True if user can access ACO, false otherwise
     */
    public function isAllowed($aco)
    {
        $cacheKey = 'isAllowed(' . $this->get('id') . ", {$aco})";
        $cache = static::cache($cacheKey);
        if ($cache === null) {
            $cache = TableRegistry::get('User.Permissions')->check($this, $aco);
            static::cache($cacheKey, $cache);
        }

        return $cache;
    }

    /**
     * Gets user default-avatar image's URL.
     *
     * Powered by Gravatar, it uses user's email to get avatar image URL from
     * Gravatar service.
     *
     * @return string URL to user's avatar
     * @link http://www.gravatar.com
     */
    protected function _getAvatar()
    {
        return $this->avatar();
    }

    /**
     * Gets user's real name.
     *
     * @return string Name
     */
    protected function _getName()
    {
        $name = isset($this->_properties['name']) ? $this->_properties['name'] : '';

        return h($name);
    }

    /**
     * Gets user avatar image's URL.
     *
     * Powered by Gravatar, it uses user's email to get avatar image URL from
     * Gravatar service.
     *
     * Use this method instead of `avatar` property when you need to customize
     * avatar's parameters such as `size`, etc.
     *
     * ```php
     * $user->avatar(['s' => 150]); // instead of: $user->avatar;
     * ```
     *
     * @param array $options Array of options for Gravatar API
     * @return string URL to user's avatar
     * @link http://www.gravatar.com
     */
    public function avatar($options = [])
    {
        $options = (array)$options;
        $options += [
            's' => 80,
            'd' => 'mm',
            'r' => 'g'
        ];

        $url = 'http://www.gravatar.com/avatar/';
        $url .= md5(strtolower(trim($this->get('email'))));
        $url .= "?s={$options['s']}&d={$options['d']}&r={$options['r']}";

        return $url;
    }

    /**
     * Hashes the password if not empty.
     *
     * @param string $password The RAW password
     * @return string Encrypted password
     */
    protected function _setPassword($password)
    {
        if (!empty($password)) {
            return (new DefaultPasswordHasher)->hash($password);
        }

        return $password;
    }

    /**
     * Gets an array list of role IDs this user belongs to.
     *
     * @return array
     */
    protected function _getRoleIds()
    {
        $ids = [];
        if (!$this->has('roles')) {
            return $ids;
        }
        foreach ($this->roles as $k => $role) {
            $ids[] = $role->id;
        }

        return $ids;
    }

    /**
     * Gets an array list of role NAMES this user belongs to.
     *
     * @return array
     */
    protected function _getRoleNames()
    {
        $names = [];
        if (!$this->has('roles')) {
            return $names;
        }
        foreach ($this->roles as $k => $role) {
            $names[] = $role->name;
        }

        return $names;
    }

    /**
     * Gets an array list of role NAMES this user belongs to.
     *
     * @return array
     */
    protected function _getRoleSlugs()
    {
        $slugs = [];
        if (!$this->has('roles')) {
            return $slugs;
        }
        foreach ($this->roles as $role) {
            $slugs[] = $role->slug;
        }

        return $slugs;
    }

    /**
     * Generates cancel code for this user.
     *
     * @return string
     * @throws \Cake\Error\FatalErrorException When code cannot be created
     */
    protected function _getCancelCode()
    {
        if (!$this->has('password') && !$this->has('id')) {
            throw new FatalErrorException(__d('user', 'Cannot generated cancel code for this user: unknown user ID.'));
        }

        if (!$this->has('password')) {
            $password = TableRegistry::get('User.Users')
                ->get($this->id, ['fields' => ['password']])
                ->get('password');
        } else {
            $password = $this->password;
        }

        return Security::hash($password, 'md5', true);
    }
}


1		<?php
2		/**
3		* Licensed under The GPL-3.0 License
4		* For full copyright and license information, please see the LICENSE.txt
5		* Redistributions of files must retain the above copyright notice.
6		*
7		* @since 2.0.0
8		* @author Christopher Castro <[email protected]>
9		* @link http://www.quickappscms.org
10		* @license http://opensource.org/licenses/gpl-3.0.html GPL-3.0 License
11		*/
12		namespace User\Model\Entity;
13
14		use Cake\Auth\DefaultPasswordHasher;
15		use Cake\Error\FatalErrorException;
16		use Cake\ORM\Entity;
17		use Cake\ORM\TableRegistry;
18		use Cake\Utility\Security;
19		use CMS\Core\StaticCacheTrait;
20
21		/**
22		* Represents single "user" in "users" database table.
23		*
24		*/
25		class User extends Entity
26		{
27
28		use StaticCacheTrait;
29
30		/**
31		* Updates this user's Token value.
32		*
33		* The new token is persisted in DB and in this entity property.
34		*
35		* @return $this
36		* @throws \Cake\Error\FatalErrorException When an invalid user entity was given
37		* @see \User\Model\Table\UsersTable::updateToken()
38		*/
39		public function updateToken()
40		{
41		return TableRegistry::get('User.Users')->updateToken($this);
42		}
43
44		/**
45		* Whether this use belongs to the administrator role.
46		*
47		* @return bool
48		*/
49		public function isAdmin()
50		{
51		$roles = $this->_getRoleIds();
52
53		return in_array(ROLE_ID_ADMINISTRATOR, $roles);
54		}
55
56		/**
57		* Verifies this user is allowed access the given ACO.
58		*
59		* ### Usage:
60		*
61		* ```php
62		* // Checks if current user is allowed to edit created contents:
63		* user()->isAllowed('Content/Admin/Manage/edit');
64		* ```
65		*
66		* @param string $aco An ACO path. e.g. `Plugin/Prefix/Controller/action`
67		* @return bool True if user can access ACO, false otherwise
68		*/
69		public function isAllowed($aco)
70		{
71		$cacheKey = 'isAllowed(' . $this->get('id') . ", {$aco})";
72		$cache = static::cache($cacheKey);
73		if ($cache === null) {
74		$cache = TableRegistry::get('User.Permissions')->check($this, $aco);
75		static::cache($cacheKey, $cache);
76		}
77
78		return $cache;
79		}
80
81		/**
82		* Gets user default-avatar image's URL.
83		*
84		* Powered by Gravatar, it uses user's email to get avatar image URL from
85		* Gravatar service.
86		*
87		* @return string URL to user's avatar
88		* @link http://www.gravatar.com
89		*/
90		protected function _getAvatar()
91		{
92		return $this->avatar();
93		}
94
95		/**
96		* Gets user's real name.
97		*
98		* @return string Name
99		*/
100		protected function _getName()
101		{
102		$name = isset($this->_properties['name']) ? $this->_properties['name'] : '';
103
104		return h($name);
105		}
106
107		/**
108		* Gets user avatar image's URL.
109		*
110		* Powered by Gravatar, it uses user's email to get avatar image URL from
111		* Gravatar service.
112		*
113		* Use this method instead of `avatar` property when you need to customize
114		* avatar's parameters such as `size`, etc.
115		*
116		* ```php
117		* $user->avatar(['s' => 150]); // instead of: $user->avatar;
118		* ```
119		*
120		* @param array $options Array of options for Gravatar API
121		* @return string URL to user's avatar
122		* @link http://www.gravatar.com
123		*/
124		public function avatar($options = [])
125		{
126		$options = (array)$options;
127		$options += [
128		's' => 80,
129		'd' => 'mm',
130		'r' => 'g'
131		];
132
133		$url = 'http://www.gravatar.com/avatar/';
134		$url .= md5(strtolower(trim($this->get('email'))));
135		$url .= "?s={$options['s']}&d={$options['d']}&r={$options['r']}";
136
137		return $url;
138		}
139
140		/**
141		* Hashes the password if not empty.
142		*
143		* @param string $password The RAW password
144		* @return string Encrypted password
145		*/
146		protected function _setPassword($password)
147		{
148		if (!empty($password)) {
149		return (new DefaultPasswordHasher)->hash($password);
150		}
151
152		return $password;
153		}
154
155		/**
156		* Gets an array list of role IDs this user belongs to.
157		*
158		* @return array
159		*/
160	View Code Duplication	protected function _getRoleIds()
161		{
162		$ids = [];
163		if (!$this->has('roles')) {
164		return $ids;
165		}
166		foreach ($this->roles as $k => $role) {
167		$ids[] = $role->id;
168		}
169
170		return $ids;
171		}
172
173		/**
174		* Gets an array list of role NAMES this user belongs to.
175		*
176		* @return array
177		*/
178	View Code Duplication	protected function _getRoleNames()
179		{
180		$names = [];
181		if (!$this->has('roles')) {
182		return $names;
183		}
184		foreach ($this->roles as $k => $role) {
185		$names[] = $role->name;
186		}
187
188		return $names;
189		}
190
191		/**
192		* Gets an array list of role NAMES this user belongs to.
193		*
194		* @return array
195		*/
196		protected function _getRoleSlugs()
197		{
198		$slugs = [];
199		if (!$this->has('roles')) {
200		return $slugs;
201		}
202		foreach ($this->roles as $role) {
203		$slugs[] = $role->slug;
204		}
205
206		return $slugs;
207		}
208
209		/**
210		* Generates cancel code for this user.
211		*
212		* @return string
213		* @throws \Cake\Error\FatalErrorException When code cannot be created
214		*/
215		protected function _getCancelCode()
216		{
217		if (!$this->has('password') && !$this->has('id')) {
218		throw new FatalErrorException(__d('user', 'Cannot generated cancel code for this user: unknown user ID.'));
219		}
220
221		if (!$this->has('password')) {
222		$password = TableRegistry::get('User.Users')
223		->get($this->id, ['fields' => ['password']])
224		->get('password');
225		} else {
226		$password = $this->password;
227		}
228
229		return Security::hash($password, 'md5', true);
230		}
231		}
232

quickapps / cms

Push — 2.0 ( 4f2e56...7d648f )

User::_getName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like