User::checkLoggedIn() - Code Metrics - Asymptix/Framework - Measure and Improve Code Quality continuously with Scrutinizer

User::checkLoggedIn() A
last analyzed 2018-07-31 14:35 UTC

↳ Parent: User

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	8
rs	10
c	0
b	0
f	0

<?php

namespace db\access;

use Asymptix\core\Tools;
use Asymptix\db\DBCore;

/**
 * Simple User bean class.
 * (You can modify this class according to your database structure)
 *
 * @category Asymptix PHP Framework
 * @author Dmytro Zarezenko <[email protected]>
 * @copyright (c) 2009 - 2017, Dmytro Zarezenko
 * @license http://opensource.org/licenses/MIT
 */
class User extends \Asymptix\db\DBTimedObject {
    const STATUS_ACTIVATED = 1;
    const STATUS_DEACTIVATED = 0;

    const LOGIN_NOT_ACTIVATED = 0;
    const LOGIN_INVALID_USERNAME = -1;
    const LOGIN_INVALID_PASSWORD = -2;

    const GENDER_NONE = 'none';
    const GENDER_MALE = 'male';
    const GENDER_FEMALE = 'female';

    const TABLE_NAME = "users";
    const ID_FIELD_NAME = "user_id";
    protected $fieldsList = array(
        'user_id' => 0, // int(10) unsigned NOT NULL AUTO_INCREMENT
        'username' => "", // varchar(255) NOT NULL

        'email' => "", // varchar(255) NOT NULL

        'password' => "", // varchar(255) NOT NULL

        'auth_key' => "", // varchar(32) NOT NULL

        'role' => 0, // int(1) unsigned not null


        'full_name' => "", // VARCHAR(255) NOT NULL

        'gender' => self::GENDER_NONE, // ENUM( 'male', 'female', 'none', '' ) NOT NULL DEFAULT 'none'

        'language' => "en", // VARCHAR(2) NOT NULL DEFAULT 'en'


        'last_login_time' => "0000-00-00 00:00:00", // datetime DEFAULT NULL
        'create_time' => "0000-00-00 00:00:00", // datetime DEFAULT NULL
        'create_user_id' => 0, // int(11) DEFAULT NULL

        'update_time' => "0000-00-00 00:00:00", // datetime DEFAULT NULL
        'update_user_id' => 0, // int(11) DEFAULT NULL


        'activation' => 0, // tinyint(1) NOT NULL DEFAULT '0'


        'signature' => "", // TEXT NOT NULL
        'avatar' => "", // varchar(100) not null


        // additional fields according to your database structure
    );

    public function __construct() {
        parent::__construct();
    }

    /**
     * For user accounts we must verify if login field ID is unique.
     */
    public function save($debug = false) {
        try {
            return parent::save($debug);
        } catch (DBException $ex) {

            print($ex->getMessage());
            return false; //TODO: maybe verify if duplicate or other error
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
    }

    /**
     * Password encoding method.
     *
     * @param string $password Password
     * @return string Encoded password string.
     */
    public static function passwordEncode($password) {
        return md5($password);
    }

    /**
     * Login functionality.
     *
     * @param string $login Username from login form.
     * @param string $password Password from login form.
     *
     * @return mixed User object on success or integer result code if some problems occurred.
     */
    public static function login($login, $password) {
        $user = self::_select(['email' => $login])->limit(1)->go();
        if ($user) {
            if ($user->isActivated()) {
                if ($user->password == self::passwordEncode($password)) {
                    $user->updateLoginTime();

                    return $user;
                }

                return self::LOGIN_INVALID_PASSWORD;
            }

            return self::LOGIN_NOT_ACTIVATED;
        }

        return self::LOGIN_INVALID_USERNAME;
    }

    /**
     * Updates login time.
     */
    public function updateLoginTime() {
        $query = "UPDATE " . self::TABLE_NAME . "
                     SET last_login_time = NOW()
                   WHERE " . self::ID_FIELD_NAME . " = ?";
        DBCore::doUpdateQuery($query, "i", array($this->id));
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Checks if user is logged in.
     *
     * @global User $_USER Current user object.
     *
     * @return boolean
     */
    public static function checkLoggedIn() {
        global $_USER;
function myFunction($a, $b) {
    // Do something
}

        if (Tools::isInstanceOf($_USER, new self)) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            return true;
        }
        return false;
    }

    /**
     * Checks if account of the current user is equal to the needed account page.
     *
     * @global User $_USER Current user object.
     * @param array $roles Needed roles.
     *
     * @return boolean
     */
    public static function checkAccountAccess($roles = array()) {
        global $_USER;
function myFunction($a, $b) {
    // Do something
}

        if (self::checkLoggedIn()) {
            if (empty($roles)) {
                return true;
            }

            if (!is_array($roles)) {
                $roles = array($roles);
            }
            foreach ($roles as $role) {
                if ($_USER->role == $role) {
                    return true;
                }
            }
            return false;
        }
        return false;
    }

    /**
     * Logout functionality.
     */
    public static function logout() {
        global $_USER;
function myFunction($a, $b) {
    // Do something
}

        $_USER = null;
        session_unset();
    }

    /**
     * Returns current users avatar image file path.
     *
     * @param boolean $icon Return only default icon flag.
     *
     * @return string Image path.
     */
    public function getAvatarPath($icon = false) {
        $currentAvatarFileName = $this->avatar;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        if (!empty($currentAvatarFileName) && file_exists(Config::DIR_AVATARS . $currentAvatarFileName)) {

            return Config::DIR_AVATARS . $currentAvatarFileName;
        }
        if ($icon) {
            return "img/user_avatar.png";
        }
        return "img/placehold/100x100.png";
    }

    /**
     * Updates users avatar image file path in the DB.
     *
     * @param string $newAvatarFileName New filename.
     *
     * @return boolean Success flag.
     */
    public function updateAvatar($newAvatarFileName) {
        $currentAvatarFileName = $this->avatar;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        if (!empty($currentAvatarFileName) && file_exists(Config::DIR_AVATARS . $currentAvatarFileName)) {

            unlink(Config::DIR_AVATARS . $currentAvatarFileName);
        }

        if (file_exists(Config::DIR_AVATARS . $newAvatarFileName)) {
            $query = "UPDATE " . self::TABLE_NAME
                    . " SET avatar = ?"
                    . " WHERE " . self::ID_FIELD_NAME . " = ?";
            if (DBCore::doUpdateQuery($query, "si", array(
                $newAvatarFileName,
                $this->id
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ))) {
                $this->avatar = $newAvatarFileName;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                return true;
            } else {
                return false;
            }
        } else {
            return false;
        }
    }

}


User::checkLoggedIn() A
last analyzed 2018-07-31 14:35 UTC

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1			<?php
2
3			namespace db\access;
4
5			use Asymptix\core\Tools;
6			use Asymptix\db\DBCore;
7
8			/**
9			* Simple User bean class.
10			* (You can modify this class according to your database structure)
11			*
12			* @category Asymptix PHP Framework
13			* @author Dmytro Zarezenko <[email protected]>
14			* @copyright (c) 2009 - 2017, Dmytro Zarezenko
15			* @license http://opensource.org/licenses/MIT
16			*/
17			class User extends \Asymptix\db\DBTimedObject {
18			const STATUS_ACTIVATED = 1;
19			const STATUS_DEACTIVATED = 0;
20
21			const LOGIN_NOT_ACTIVATED = 0;
22			const LOGIN_INVALID_USERNAME = -1;
23			const LOGIN_INVALID_PASSWORD = -2;
24
25			const GENDER_NONE = 'none';
26			const GENDER_MALE = 'male';
27			const GENDER_FEMALE = 'female';
28
29			const TABLE_NAME = "users";
30			const ID_FIELD_NAME = "user_id";
31			protected $fieldsList = array(
32			'user_id' => 0, // int(10) unsigned NOT NULL AUTO_INCREMENT
33			'username' => "", // varchar(255) NOT NULL
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report `45%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
34			'email' => "", // varchar(255) NOT NULL
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report `45%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
35			'password' => "", // varchar(255) NOT NULL
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report `45%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
36			'auth_key' => "", // varchar(32) NOT NULL
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report `45%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...

Asymptix / Framework

User::checkLoggedIn() A last analyzed 2018-07-31 14:35 UTC

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like

User::checkLoggedIn() A
last analyzed 2018-07-31 14:35 UTC