Jitamin\Model\UserModel

Complexity

Total Complexity

35

Size/Duplication

Total Lines	362
Duplicated Lines	1.66 %

Coupling/Cohesion

Components	0
Dependencies	4

Importance

Changes

0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	exists()	0	4	1
A	isActive()	0	4	1
A	getQuery()	0	4	1
A	isAdmin()	0	9	2
A	getById()	0	4	1
A	getByExternalId()	0	8	2
A	getByUsername()	0	4	1
A	getIdByUsername()	0	4	1
A	getByEmail()	0	8	2
A	getByToken()	0	8	2
A	getAll()	0	4	1
A	count()	0	4	1
A	getActiveUsersList()	0	11	2
A	prepareList()	0	12	2
A	prepare()	0	15	3
A	create()	0	6	1
A	update()	0	8	1
A	disable()	0	4	1
A	enable()	0	4	1
B	remove()	6	38	6
A	enablePublicAccess()	0	7	1
A	disablePublicAccess()	0	7	1

<?php

/*
 * This file is part of Jitamin.
 *
 * Copyright (C) Jitamin Team
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Jitamin\Model;

use Jitamin\Foundation\Database\Model;
use Jitamin\Foundation\Security\Role;
use Jitamin\Foundation\Security\Token;
use PicoDb\Database;

/**
 * User model.
 */
class UserModel extends Model
{
    /**
     * SQL table name.
     *
     * @var string
     */
    const TABLE = 'users';

    /**
     * Id used for everybody (filtering).
     *
     * @var int
     */
    const EVERYBODY_ID = -1;

    /**
     * Return true if the user exists.
     *
     * @param int $user_id User id
     *
     * @return bool
     */
    public function exists($user_id)
    {
        return $this->db->table(self::TABLE)->eq('id', $user_id)->exists();

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Return true if the user is active.
     *
     * @param int $user_id User id
     *
     * @return bool
     */
    public function isActive($user_id)
    {
        return $this->db->table(self::TABLE)->eq('id', $user_id)->eq('is_active', 1)->exists();

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Get query to fetch all users.
     *
     * @return \PicoDb\Table
     */
    public function getQuery()
    {
        return $this->db->table(self::TABLE);

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Return true is the given user id is administrator.
     *
     * @param int $user_id User id
     *
     * @return bool
     */
    public function isAdmin($user_id)
    {
        return $this->userSession->isAdmin() ||  // Avoid SQL query if connected

The property userSession does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

               $this->db

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

                    ->table(self::TABLE)
                    ->eq('id', $user_id)
                    ->eq('role', Role::APP_ADMIN)
                    ->exists();
    }

    /**
     * Get a specific user by id.
     *
     * @param int $user_id User id
     *
     * @return array
     */
    public function getById($user_id)
    {
        return $this->db->table(self::TABLE)->eq('id', $user_id)->findOne();

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Get a specific user by the Google id.
     *
     * @param string $column
     * @param string $id
     *
     * @return array|bool
     */
    public function getByExternalId($column, $id)
    {
        if (empty($id)) {
            return false;
        }

        return $this->db->table(self::TABLE)->eq($column, $id)->findOne();

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Get a specific user by the username.
     *
     * @param string $username Username
     *
     * @return array
     */
    public function getByUsername($username)
    {
        return $this->db->table(self::TABLE)->eq('username', $username)->findOne();

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Get user_id by username.
     *
     * @param string $username Username
     *
     * @return int
     */
    public function getIdByUsername($username)
    {
        return $this->db->table(self::TABLE)->eq('username', $username)->findOneColumn('id');

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Get a specific user by the email address.
     *
     * @param string $email Email
     *
     * @return array|bool
     */
    public function getByEmail($email)
    {
        if (empty($email)) {
            return false;
        }

        return $this->db->table(self::TABLE)->eq('email', $email)->findOne();

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Fetch user by using the token.
     *
     * @param string $token Token
     *
     * @return array|bool
     */
    public function getByToken($token)
    {
        if (empty($token)) {
            return false;
        }

        return $this->db->table(self::TABLE)->eq('token', $token)->findOne();

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Get all users.
     *
     * @return array
     */
    public function getAll()
    {
        return $this->getQuery()->asc('username')->findAll();
    }

    /**
     * Get the number of users.
     *
     * @return int
     */
    public function count()
    {
        return $this->db->table(self::TABLE)->count();

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * List all users (key-value pairs with id/username).
     *
     * @param bool $prepend Prepend "All users"
     *
     * @return array
     */
    public function getActiveUsersList($prepend = false)
    {
        $users = $this->db->table(self::TABLE)->eq('is_active', 1)->columns('id', 'username', 'name')->findAll();

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

        $listing = $this->prepareList($users);

        if ($prepend) {
            return [self::EVERYBODY_ID => t('Everybody')] + $listing;
        }

        return $listing;
    }

    /**
     * Common method to prepare a user list.
     *
     * @param array $users Users list (from database)
     *
     * @return array Formated list
     */
    public function prepareList(array $users)
    {
        $result = [];

        foreach ($users as $user) {
            $result[$user['id']] = $this->helper->user->getFullname($user);

The property helper does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

        }

        asort($result);

        return $result;
    }

    /**
     * Prepare values before an update or a create.
     *
     * @param array $values Form values
     */
    public function prepare(array &$values)
    {
        if (isset($values['password'])) {
            if (!empty($values['password'])) {
                $values['password'] = bcrypt($values['password']);
            } else {
                unset($values['password']);
            }
        }

        $this->helper->model->removeFields($values, ['confirmation', 'current_password']);

The property helper does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

        $this->helper->model->resetFields($values, ['is_ldap_user', 'disable_login_form']);

The property helper does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

        $this->helper->model->convertNullFields($values, ['gitlab_id']);

The property helper does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

        $this->helper->model->convertIntegerFields($values, ['gitlab_id']);

The property helper does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Add a new user in the database.
     *
     * @param array $values Form values
     *
     * @return bool|int
     */
    public function create(array $values)
    {
        $this->prepare($values);

        return $this->db->table(self::TABLE)->persist($values);

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Modify a new user.
     *
     * @param array $values Form values
     *
     * @return bool
     */
    public function update(array $values)
    {
        $this->prepare($values);
        $result = $this->db->table(self::TABLE)->eq('id', $values['id'])->update($values);

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

        $this->userSession->refresh($values['id']);

The property userSession does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

        return $result;
    }

    /**
     * Disable a specific user.
     *
     * @param int $user_id
     *
     * @return bool
     */
    public function disable($user_id)
    {
        return $this->db->table(self::TABLE)->eq('id', $user_id)->update(['is_active' => 0]);

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Enable a specific user.
     *
     * @param int $user_id
     *
     * @return bool
     */
    public function enable($user_id)
    {
        return $this->db->table(self::TABLE)->eq('id', $user_id)->update(['is_active' => 1]);

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Remove a specific user.
     *
     * @param int $user_id User id
     *
     * @return bool
     */
    public function remove($user_id)
    {
        $this->avatarModel->remove($user_id);

The property avatarModel does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

        return $this->db->transaction(function (Database $db) use ($user_id) {

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

            // All assigned tasks are now unassigned (no foreign key)
            if (!$db->table(TaskModel::TABLE)->eq('owner_id', $user_id)->update(['owner_id' => 0])) {
                return false;
            }

            // All assigned subtasks are now unassigned (no foreign key)
            if (!$db->table(SubtaskModel::TABLE)->eq('user_id', $user_id)->update(['user_id' => 0])) {

This code seems to be duplicated across your project.

                return false;
            }

            // All comments are not assigned anymore (no foreign key)
            if (!$db->table(CommentModel::TABLE)->eq('user_id', $user_id)->update(['user_id' => 0])) {

This code seems to be duplicated across your project.

                return false;
            }

            // All private projects are removed
            $project_ids = $db->table(ProjectModel::TABLE)
                ->eq('is_private', 1)
                ->eq(ProjectUserRoleModel::TABLE.'.user_id', $user_id)
                ->join(ProjectUserRoleModel::TABLE, 'project_id', 'id')
                ->findAllByColumn(ProjectModel::TABLE.'.id');

            if (!empty($project_ids)) {
                $db->table(ProjectModel::TABLE)->in('id', $project_ids)->remove();
            }

            // Finally remove the user
            if (!$db->table(UserModel::TABLE)->eq('id', $user_id)->remove()) {
                return false;
            }
        });
    }

    /**
     * Enable public access for a user.
     *
     * @param int $user_id User id
     *
     * @return bool
     */
    public function enablePublicAccess($user_id)
    {
        return $this->db

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

                    ->table(self::TABLE)
                    ->eq('id', $user_id)
                    ->save(['token' => Token::getToken()]);
    }

    /**
     * Disable public access for a user.
     *
     * @param int $user_id User id
     *
     * @return bool
     */
    public function disablePublicAccess($user_id)
    {
        return $this->db

The property db does not exist on object<Jitamin\Model\UserModel>. Since you implemented __get, maybe consider adding a @property annotation.

                    ->table(self::TABLE)
                    ->eq('id', $user_id)
                    ->save(['token' => '']);
    }
}