Application\Users\Row

Complexity

Total Complexity

12

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	11

Test Coverage

Coverage

28.57%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
B	beforeSave()	0	34	1
A	beforeInsert()	0	4	1
A	beforeUpdate()	0	4	1
B	tryLogin()	0	20	5
A	getRoles()	0	4	1
A	getPrivileges()	0	7	2
A	hasRole()	0	6	1

<?php
/**
 * @copyright Bluz PHP Team
 * @link      https://github.com/bluzphp/skeleton
 */

/**
 * @namespace
 */

namespace Application\Users;

use Application\Exception;
use Application\Privileges;
use Application\Roles;
use Bluz\Auth\AbstractRowEntity;
use Bluz\Auth\AuthException;
use Bluz\Proxy\Auth;
use Bluz\Proxy\Session;
use Bluz\Validator\Traits\Validator;
use Bluz\Validator\Validator as v;

/**
 * User
 *
 * @package  Application\Users
 *
 * @property integer $id
 * @property string  $login
 * @property string  $email
 * @property string  $created
 * @property string  $updated
 * @property string  $status
 *
 * @SWG\Definition(definition="users", title="user", required={"id", "login", "status"})
 * @SWG\Property(property="id", type="integer", description="User UID", example=2)
 * @SWG\Property(property="login", type="string", description="Login", example="admin")
 * @SWG\Property(property="email", type="string", description="Email", example="admin@domain.com")
 * @SWG\Property(property="created", type="string", format="date-time", example="2017-01-01 20:17:01")
 * @SWG\Property(property="updated", type="string", format="date-time", example="2017-01-01 20:17:01")
 * @SWG\Property(property="status", type="string", enum={"pending", "active", "disabled", "deleted"})
 */
class Row extends AbstractRowEntity
{
    use Validator;

    /**
     * Small cache of user privileges
     *
     * @var array
     */
    protected $privileges;

    /**
     * @return void
     */
    public function beforeSave()
    {
        $this->email = strtolower($this->email);

        $this->addValidator(
            'login',
            v::required()->latin()->length(3, 255),
            v::callback(
                function ($login) {
                    $user = $this->getTable()
                        ->select()
                        ->where('login = ?', $login)
                        ->andWhere('id != ?', $this->id)
                        ->execute();
                    return !$user;
                }
            )->setError('User with login "{{input}}" already exists')
        );

        $this->addValidator(
            'email',
            v::required()->email(true),
            v::callback(
                function ($email) {
                    $user = $this->getTable()
                        ->select()
                        ->where('email = ?', $email)
                        ->andWhere('id != ?', $this->id)
                        ->execute();
                    return !$user;
                }
            )->setError('User with email "{{input}}" already exists')
        );
    }

    /**
     * @return void
     */
    public function beforeInsert()
    {
        $this->created = gmdate('Y-m-d H:i:s');
    }

    /**
     * @return void
     */
    public function beforeUpdate()
    {
        $this->updated = gmdate('Y-m-d H:i:s');
    }

    /**
     * Can entity login
     *
     * @throws Exception
     * @throws AuthException
     * @return void
     */
    public function tryLogin()
    {
        switch ($this->status) {
            case (Table::STATUS_PENDING):
                throw new AuthException('Your account is pending activation', 403);
            case (Table::STATUS_DISABLED):
                throw new AuthException('Your account is disabled by administrator', 403);
            case (Table::STATUS_ACTIVE):
                // all ok
                // regenerate session
                if (PHP_SAPI !== 'cli') {
                    Session::regenerateId();
                }
                // save user to new session
                Auth::setIdentity($this);
                break;
            default:
                throw new Exception('User status is undefined in system');
        }
    }

    /**
     * Get user roles
     */
    public function getRoles()
    {
        return Roles\Table::getInstance()->getUserRoles($this->id);
    }

    /**
     * {@inheritdoc}
     */
    public function getPrivileges(): array
    {
        if (!$this->privileges) {

The expression $this->privileges of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            $this->privileges = Privileges\Table::getInstance()->getUserPrivileges($this->id);
        }
        return $this->privileges;
    }

    /**
     * Check user role
     *
     * @param integer $roleId
     *
     * @return boolean
     */
    public function hasRole($roleId)
    {
        $roles = Roles\Table::getInstance()->getUserRolesIdentity($this->id);

        return in_array($roleId, $roles);
    }
}