User\Model\Entity\User

Complexity

Total Complexity

23

Size/Duplication

Total Lines	207
Duplicated Lines	10.63 %

Coupling/Cohesion

Components	3
Dependencies	7

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	updateToken()	0	4	1
A	_getAvatar()	0	4	1
A	isAdmin()	0	6	1
A	isAllowed()	0	11	2
A	_getName()	0	6	2
A	avatar()	0	15	1
A	_setPassword()	0	8	2
A	_getRoleIds()	11	12	3
A	_getRoleNames()	11	12	3
A	_getRoleSlugs()	0	12	3
A	_getCancelCode()	0	16	4

<?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 <chris@quickapps.es>
 * @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);
    }
}