DBStaticUser::db_user_by_id() - Code Metrics - Inspection of "GIT-fix-41a7.5: Fixed merge conflict" - supernova-ws/SuperNova - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — work-fleets ( f3b03d...13a233 )

by SuperNova.WS

created 2016-05-13 10:54 UTC

DBStaticUser::db_user_by_id() A

↳ Parent: DBStaticUser

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
cc	1
eloc	2
nc	1
nop	4
dl	0
loc	3
rs	10
c	1
b	1
f	0

<?php

class DBStaticUser extends DBStaticRecord {

  public static $_table = 'users';
  public static $_idField = 'id';


  /**
   * @param int $user_id
   *
   * @return string[]
   */
  public static function getOnlineTime($user_id) {
    $user_record = static::getRecordById($user_id, array('username', 'onlinetime'));

    return !empty($user_record) ? $user_record : array();
  }

  // TODO - это вообще-то надо хранить в конфигурации
  public static function getLastRegisteredUserName() {
    $user = doquery('SELECT `username` FROM {{users}} WHERE `user_as_ally` IS NULL ORDER BY `id` DESC LIMIT 1', true);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

    return isset($user['username']) ? $user['username'] : '';
  }

  public static function db_player_list_blitz_delete_players() {
    doquery("DELETE FROM `{{users}}` WHERE username LIKE 'Игрок%';");
  }

  public static function db_player_list_blitz_set_50k_dm() {
    doquery('UPDATE `{{users}}` SET dark_matter = 50000, dark_matter_total = 50000;');
  }

  public static function db_player_list_export_blitz_info() {
    return doquery("SELECT id, username, total_rank, total_points, onlinetime FROM `{{users}}` ORDER BY `id`;");
  }

  public static function db_user_by_username($username_unsafe, $for_update = false, $fields = '*', $player = null, $like = false) {
    return classSupernova::db_get_user_by_username($username_unsafe, $for_update, $fields, $player, $like);
  }

  public static function db_user_list($user_filter = '', $for_update = false, $fields = '*') {

    return classSupernova::db_get_record_list(LOC_USER, $user_filter);
  }

  public static function db_user_set_by_id($user_id, $set) {
    return classSupernova::db_upd_record_by_id(LOC_USER, $user_id, $set);
  }

  public static function db_user_lock_all() {
    doquery("SELECT 1 FROM {{users}} FOR UPDATE;");
  }

  /**
   * @return array|bool|mysqli_result|null
   */
  public static function db_user_list_non_bots() {
    $query = doquery("SELECT `id` FROM {{users}} WHERE `user_as_ally` IS NULL AND `user_bot` = " . USER_BOT_PLAYER . " FOR UPDATE;");

    return $query;
  }

  public static function db_user_lock_with_target_owner_and_acs($user, $planet = array()) {
    doquery("SELECT 1 FROM {{users}} WHERE `id` = " . idval($user['id']) .
      (isset($planet['id_owner']) ? ' OR `id` = ' . idval($planet['id_owner']) : '') .
      " FOR UPDATE;"
    );
  }

  /**
   * Выбирает записи игроков по списку их ID
   *
   * @param $user_id_list
   *
   * @return array
   */
  public static function db_user_list_by_id($user_id_list) {
    !is_array($user_id_list) ? $user_id_list = array($user_id_list) : false;

    $user_list = array();
    foreach($user_id_list as $user_id_unsafe) {
      $user = DBStaticUser::db_user_by_id($user_id_unsafe);
      !empty($user) ? $user_list[$user_id_unsafe] = $user : false;
    }

    return $user_list;
  }




  public static function db_user_by_id($user_id_unsafe, $for_update = false, $fields = '*', $player = null) {
    return classSupernova::db_get_user_by_id($user_id_unsafe, $for_update, $fields, $player);
  }

  public static function db_user_list_set_mass_mail(&$owners_list, $set) {
    return classSupernova::db_upd_record_list(LOC_USER, !empty($owners_list) ? '`id` IN (' . implode(',', $owners_list) . ');' : '', $set);
  }

  public static function db_user_list_set_by_ally_and_rank($ally_id, $ally_rank_id, $set) {
    return classSupernova::db_upd_record_list(LOC_USER, "`ally_id`={$ally_id} AND `ally_rank_id` >= {$ally_rank_id}", $set);
  }

  public static function db_user_list_set_ally_deprecated_convert_ranks($ally_id, $i, $rank_id) {
    return classSupernova::db_upd_record_list(LOC_USER, "`ally_id` = {$ally_id} AND `ally_rank_id`={$rank_id}", "`ally_rank_id` = {$i}");
  }


//  public static function db_user_change_active_planet_to_capital($user_id, $captured_planet) {

//    return doquery("UPDATE {{users}} SET `current_planet` = `id_planet` WHERE `id` = {$user_id} AND `current_planet` = {$captured_planet};");
//  }


  public static function db_user_count($online = false) {
    $result = doquery('SELECT COUNT(id) AS user_count FROM `{{users}}` WHERE user_as_ally IS NULL' . ($online ? ' AND onlinetime > ' . (SN_TIME_NOW - classSupernova::$config->game_users_online_timeout) : ''), true);
<?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 isset($result['user_count']) ? $result['user_count'] : 0;
  }









  public static function db_user_list_to_celebrate($config_user_birthday_range) {
    return doquery(
      "SELECT
      `id`, `username`, `user_birthday`, `user_birthday_celebrated`
      , CONCAT(YEAR(CURRENT_DATE), DATE_FORMAT(`user_birthday`, '-%m-%d')) AS `current_birthday`
      , DATEDIFF(CURRENT_DATE, CONCAT(YEAR(CURRENT_DATE), DATE_FORMAT(`user_birthday`, '-%m-%d'))) AS `days_after_birthday`
    FROM
      `{{users}}`
    WHERE
      `user_birthday` IS NOT NULL
      AND (`user_birthday_celebrated` IS NULL OR DATE_ADD(`user_birthday_celebrated`, INTERVAL 1 YEAR) < CURRENT_DATE)
      AND `user_as_ally` IS NULL
    HAVING
      `days_after_birthday` >= 0 AND `days_after_birthday` < {$config_user_birthday_range} FOR UPDATE;");
  }

//  public static function db_user_list_online_sorted($TypeSort) {

//    return doquery(
//      "SELECT `id` AS `ID`, `username` AS `NAME`, `ally_name` AS `ALLY`, `total_points` AS `STAT_POINTS`,
//      `onlinetime` AS `ACTIVITY`
//    FROM `{{users}}`
//    WHERE `onlinetime` >= " . (SN_TIME_NOW - classSupernova::$config->game_users_online_timeout) . " ORDER BY user_as_ally, `" . $TypeSort . "` ASC;");
//  }


  public static function db_user_list_admin_multiaccounts() {
    return doquery("SELECT COUNT(*) AS ip_count, user_lastip FROM `{{users}}` WHERE user_as_ally IS NULL GROUP BY user_lastip HAVING COUNT(*) > 1;");
  }


  public static function db_user_list_admin_sorted($sort, $online = false) {
    return doquery("SELECT u.*, COUNT(r.id) AS referral_count, SUM(r.dark_matter) AS referral_dm FROM {{users}} as u
    LEFT JOIN {{referrals}} as r on r.id_partner = u.id
    WHERE" .
      ($online ? " `onlinetime` >= " . (SN_TIME_NOW - classSupernova::$config->game_users_online_timeout) : ' user_as_ally IS NULL') .
<?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.");
        }
    }

}
      " GROUP BY u.id
    ORDER BY user_as_ally, {$sort} ASC");
  }

}


1			<?php
2
3			class DBStaticUser extends DBStaticRecord {
4
5			public static $_table = 'users';
6			public static $_idField = 'id';
7
8
9			/**
10			* @param int $user_id
11			*
12			* @return string[]
13			*/
14			public static function getOnlineTime($user_id) {
15			$user_record = static::getRecordById($user_id, array('username', 'onlinetime'));
16
17			return !empty($user_record) ? $user_record : array();
18			}
19
20			// TODO - это вообще-то надо хранить в конфигурации
21			public static function getLastRegisteredUserName() {
22			$user = doquery('SELECT `username` FROM {{users}} WHERE `user_as_ally` IS NULL ORDER BY `id` DESC LIMIT 1', true);
			0 ignored issues – show Documentation introduced 2016-05-13 11:00 UTC by Report Bug Copy Issue Report `true` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
23
24			return isset($user['username']) ? $user['username'] : '';
25			}
26
27			public static function db_player_list_blitz_delete_players() {
28			doquery("DELETE FROM `{{users}}` WHERE username LIKE 'Игрок%';");
29			}
30
31			public static function db_player_list_blitz_set_50k_dm() {
32			doquery('UPDATE `{{users}}` SET dark_matter = 50000, dark_matter_total = 50000;');
33			}
34
35			public static function db_player_list_export_blitz_info() {
36			return doquery("SELECT id, username, total_rank, total_points, onlinetime FROM `{{users}}` ORDER BY `id`;");
37			}
38
39			public static function db_user_by_username($username_unsafe, $for_update = false, $fields = '*', $player = null, $like = false) {
40			return classSupernova::db_get_user_by_username($username_unsafe, $for_update, $fields, $player, $like);
41			}
42
43			public static function db_user_list($user_filter = '', $for_update = false, $fields = '*') {
			0 ignored issues – show Unused Code introduced 2016-03-23 16:50 UTC by Report Bug Copy Issue Report The parameter `$for_update` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2016-03-23 16:50 UTC by Report Bug Copy Issue Report The parameter `$fields` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
44			return classSupernova::db_get_record_list(LOC_USER, $user_filter);
45			}
46
47			public static function db_user_set_by_id($user_id, $set) {
48			return classSupernova::db_upd_record_by_id(LOC_USER, $user_id, $set);
49			}
50
51			public static function db_user_lock_all() {
52			doquery("SELECT 1 FROM {{users}} FOR UPDATE;");
53			}
54
55			/**
56			* @return array\|bool\|mysqli_result\|null
57			*/
58			public static function db_user_list_non_bots() {
59			$query = doquery("SELECT `id` FROM {{users}} WHERE `user_as_ally` IS NULL AND `user_bot` = " . USER_BOT_PLAYER . " FOR UPDATE;");
60
61			return $query;
62			}
63
64			public static function db_user_lock_with_target_owner_and_acs($user, $planet = array()) {
65			doquery("SELECT 1 FROM {{users}} WHERE `id` = " . idval($user['id']) .
66			(isset($planet['id_owner']) ? ' OR `id` = ' . idval($planet['id_owner']) : '') .
67			" FOR UPDATE;"
68			);
69			}
70
71			/**
72			* Выбирает записи игроков по списку их ID
73			*
74			* @param $user_id_list
75			*
76			* @return array
77			*/
78			public static function db_user_list_by_id($user_id_list) {
79			!is_array($user_id_list) ? $user_id_list = array($user_id_list) : false;
80
81			$user_list = array();
82			foreach($user_id_list as $user_id_unsafe) {
83			$user = DBStaticUser::db_user_by_id($user_id_unsafe);
84			!empty($user) ? $user_list[$user_id_unsafe] = $user : false;
85			}
86
87			return $user_list;
88			}
89
90
91
92
93			public static function db_user_by_id($user_id_unsafe, $for_update = false, $fields = '*', $player = null) {
94			return classSupernova::db_get_user_by_id($user_id_unsafe, $for_update, $fields, $player);
95			}
96
97			public static function db_user_list_set_mass_mail(&$owners_list, $set) {
98			return classSupernova::db_upd_record_list(LOC_USER, !empty($owners_list) ? '`id` IN (' . implode(',', $owners_list) . ');' : '', $set);
99			}
100
101			public static function db_user_list_set_by_ally_and_rank($ally_id, $ally_rank_id, $set) {
102			return classSupernova::db_upd_record_list(LOC_USER, "`ally_id`={$ally_id} AND `ally_rank_id` >= {$ally_rank_id}", $set);
103			}
104
105			public static function db_user_list_set_ally_deprecated_convert_ranks($ally_id, $i, $rank_id) {
106			return classSupernova::db_upd_record_list(LOC_USER, "`ally_id` = {$ally_id} AND `ally_rank_id`={$rank_id}", "`ally_rank_id` = {$i}");
107			}
108
109
110			// public static function db_user_change_active_planet_to_capital($user_id, $captured_planet) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-05-13 11:00 UTC by Report Bug Copy Issue Report `54%` 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...
111			// return doquery("UPDATE {{users}} SET `current_planet` = `id_planet` WHERE `id` = {$user_id} AND `current_planet` = {$captured_planet};");
112			// }
113
114
115			public static function db_user_count($online = false) {
116			$result = doquery('SELECT COUNT(id) AS user_count FROM `{{users}}` WHERE user_as_ally IS NULL' . ($online ? ' AND onlinetime > ' . (SN_TIME_NOW - classSupernova::$config->game_users_online_timeout) : ''), true);
			0 ignored issues – show Documentation introduced 2016-03-26 21:36 UTC by Report Bug Copy Issue Report The property `game_users_online_timeout` does not exist on `object<classConfig>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?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 the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2016-03-23 16:50 UTC by Report Bug Copy Issue Report `true` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
117
118			return isset($result['user_count']) ? $result['user_count'] : 0;
119			}
120
121
122
123
124
125
126
127
128
129			public static function db_user_list_to_celebrate($config_user_birthday_range) {
130			return doquery(
131			"SELECT
132			`id`, `username`, `user_birthday`, `user_birthday_celebrated`
133			, CONCAT(YEAR(CURRENT_DATE), DATE_FORMAT(`user_birthday`, '-%m-%d')) AS `current_birthday`
134			, DATEDIFF(CURRENT_DATE, CONCAT(YEAR(CURRENT_DATE), DATE_FORMAT(`user_birthday`, '-%m-%d'))) AS `days_after_birthday`
135			FROM
136			`{{users}}`
137			WHERE
138			`user_birthday` IS NOT NULL
139			AND (`user_birthday_celebrated` IS NULL OR DATE_ADD(`user_birthday_celebrated`, INTERVAL 1 YEAR) < CURRENT_DATE)
140			AND `user_as_ally` IS NULL
141			HAVING
142			`days_after_birthday` >= 0 AND `days_after_birthday` < {$config_user_birthday_range} FOR UPDATE;");
143			}
144
145			// public static function db_user_list_online_sorted($TypeSort) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-05-13 11:00 UTC by Report Bug Copy Issue Report `43%` 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...
146			// return doquery(
147			// "SELECT `id` AS `ID`, `username` AS `NAME`, `ally_name` AS `ALLY`, `total_points` AS `STAT_POINTS`,
148			// `onlinetime` AS `ACTIVITY`
149			// FROM `{{users}}`
150			// WHERE `onlinetime` >= " . (SN_TIME_NOW - classSupernova::$config->game_users_online_timeout) . " ORDER BY user_as_ally, `" . $TypeSort . "` ASC;");
151			// }
152
153
154			public static function db_user_list_admin_multiaccounts() {
155			return doquery("SELECT COUNT() AS ip_count, user_lastip FROM `{{users}}` WHERE user_as_ally IS NULL GROUP BY user_lastip HAVING COUNT() > 1;");
156			}
157
158
159			public static function db_user_list_admin_sorted($sort, $online = false) {
160			return doquery("SELECT u.*, COUNT(r.id) AS referral_count, SUM(r.dark_matter) AS referral_dm FROM {{users}} as u
161			LEFT JOIN {{referrals}} as r on r.id_partner = u.id
162			WHERE" .
163			($online ? " `onlinetime` >= " . (SN_TIME_NOW - classSupernova::$config->game_users_online_timeout) : ' user_as_ally IS NULL') .
			0 ignored issues – show Documentation introduced 2016-03-26 21:36 UTC by Report Bug Copy Issue Report The property `game_users_online_timeout` does not exist on `object<classConfig>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?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 the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
164			" GROUP BY u.id
165			ORDER BY user_as_ally, {$sort} ASC");
166			}
167
168			}
169

supernova-ws / SuperNova

Push — work-fleets ( f3b03d...13a233 )

DBStaticUser::db_user_by_id() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like