Buddy::db_buddy_check_relation() - Code Metrics - Inspection of "CODE-misc-41a50.69: Testing different uses of DI C..." - supernova-ws/SuperNova - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — work-fleets ( b19a67...de8005 )

by SuperNova.WS

created 2016-07-26 18:27 UTC

Buddy::db_buddy_check_relation() A

↳ Parent: Buddy

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	5

Duplication

Lines	9
Ratio	100 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	5
nc	1
nop	2
dl	9
loc	9
rs	9.6666
c	1
b	0
f	0

<?php

namespace Buddy;

use classSupernova;
use db_mysql;
use DbEmptyIterator;
use DbMysqliResultIterator;
use DBStaticMessages;
use DBStaticUser;
use Entity;

class Buddy extends Entity {

  public static $tableName = 'buddy';
  public static $idField = 'BUDDY_ID';

  /**
   * Who makes buddy request
   *
   * @var int|float|string $playerSenderId
   */
  public $playerSenderId = 0;
  /**
   * To whom this buddy request made
   *
   * @var int|float|string $playerOwnerId
   */
  public $playerOwnerId = 0;
  /**
   * Current buddy request status
   *
   * @var int $buddyStatusId
   */
  public $buddyStatusId = BUDDY_REQUEST_NOT_SET;
  /**
   * Request text
   *
   * @var string $requestText
   */
  public $requestText = '';

  // TODO - remove public static function db_buddy_update_status($buddy_id, $status) {

  public function db_buddy_update_status($status) {
    $buddy_id = idval($this->row['BUDDY_ID']);

    doquery("UPDATE `{{buddy}}` SET `BUDDY_STATUS` = {$status} WHERE `BUDDY_ID` = '{$buddy_id}' LIMIT 1;");

    return classSupernova::$db->db_affected_rows();
  }

  public function db_buddy_check_relation($user, $new_friend_row) {

    return static::$dbStatic->doQueryFetch(
      "SELECT `BUDDY_ID` FROM `{{buddy}}` WHERE
      (`BUDDY_SENDER_ID` = {$user['id']} AND `BUDDY_OWNER_ID` = {$new_friend_row['id']})
      OR
      (`BUDDY_SENDER_ID` = {$new_friend_row['id']} AND `BUDDY_OWNER_ID` = {$user['id']})
      LIMIT 1 FOR UPDATE;"
    );
  }

  /**
   * @param db_mysql $db
   * @param mixed    $user_id
   *
   * @return DbEmptyIterator|DbMysqliResultIterator
   */
  public static function db_buddy_list_by_user($db, $user_id) {

    return ($user_id = idval($user_id)) ? $db->doQueryIterator(
      "SELECT
      b.*,
      IF(b.BUDDY_OWNER_ID = {$user_id}, b.BUDDY_SENDER_ID, b.BUDDY_OWNER_ID) AS BUDDY_USER_ID,
      u.username AS BUDDY_USER_NAME,
      p.name AS BUDDY_PLANET_NAME,
      p.galaxy AS BUDDY_PLANET_GALAXY,
      p.system AS BUDDY_PLANET_SYSTEM,
      p.planet AS BUDDY_PLANET_PLANET,
      a.id AS BUDDY_ALLY_ID,
      a.ally_name AS BUDDY_ALLY_NAME,
      u.onlinetime
    FROM {{buddy}} AS b
      LEFT JOIN {{users}} AS u ON u.id = IF(b.BUDDY_OWNER_ID = {$user_id}, b.BUDDY_SENDER_ID, b.BUDDY_OWNER_ID)
      LEFT JOIN {{planets}} AS p ON p.id_owner = u.id AND p.id = id_planet
      LEFT JOIN {{alliance}} AS a ON a.id = u.ally_id
    WHERE (`BUDDY_OWNER_ID` = {$user_id}) OR `BUDDY_SENDER_ID` = {$user_id}
    ORDER BY BUDDY_STATUS, BUDDY_ID"
    ) : new DbEmptyIterator();
  }

  /**
   * @param array $user
   *
   * @throws BuddyException
   */
  public function accept($user) {
    $buddy_row = $this->row;

    if ($buddy_row['BUDDY_SENDER_ID'] == $user['id']) {
      throw new BuddyException('buddy_err_accept_own', ERR_ERROR);
    }

    if ($buddy_row['BUDDY_OWNER_ID'] != $user['id']) {
      throw new BuddyException('buddy_err_accept_alien', ERR_ERROR);
    }

    if ($buddy_row['BUDDY_STATUS'] == BUDDY_REQUEST_ACTIVE) {
      throw new BuddyException('buddy_err_accept_already', ERR_WARNING);
    }

    if ($buddy_row['BUDDY_STATUS'] == BUDDY_REQUEST_DENIED) {
      throw new BuddyException('buddy_err_accept_denied', ERR_ERROR);
    }

    if ($buddy_row['BUDDY_STATUS'] != BUDDY_REQUEST_WAITING) {
      throw new BuddyException('buddy_err_unknown_status', ERR_ERROR);
    }

    $result = $this->db_buddy_update_status(BUDDY_REQUEST_ACTIVE);
    if ($result) {

      DBStaticMessages::msgSendFromPlayerBuddy($buddy_row['BUDDY_SENDER_ID'], $user, 'buddy_msg_accept_title', 'buddy_msg_accept_text');
      throw new BuddyException('buddy_err_accept_none', ERR_NONE);
    } else {
      throw new BuddyException('buddy_err_accept_internal', ERR_ERROR);
    }
  }

  /**
   * @param array $user
   *
   * @throws BuddyException
   */
  public function decline($user) {
    $buddy_row = $this->row;

    if ($buddy_row['BUDDY_SENDER_ID'] != $user['id'] && $buddy_row['BUDDY_OWNER_ID'] != $user['id']) {
      throw new BuddyException('buddy_err_delete_alien', ERR_ERROR);
    }

    if ($buddy_row['BUDDY_STATUS'] == BUDDY_REQUEST_ACTIVE) {
      // Existing friendship
      $ex_friend_id = $buddy_row['BUDDY_SENDER_ID'] == $user['id'] ? $buddy_row['BUDDY_OWNER_ID'] : $buddy_row['BUDDY_SENDER_ID'];

      DBStaticMessages::msgSendFromPlayerBuddy($ex_friend_id, $user, 'buddy_msg_unfriend_title', 'buddy_msg_unfriend_text');

      $this->delete();
      throw new BuddyException('buddy_err_unfriend_none', ERR_NONE);
    } elseif ($buddy_row['BUDDY_SENDER_ID'] == $user['id']) {
      // Player's outcoming request - either denied or waiting
      $this->delete();
      throw new BuddyException('buddy_err_delete_own', ERR_NONE);
    } elseif ($buddy_row['BUDDY_STATUS'] == BUDDY_REQUEST_WAITING) {
      // Deny incoming request
      DBStaticMessages::msgSendFromPlayerBuddy($buddy_row['BUDDY_SENDER_ID'], $user, 'buddy_msg_deny_title', 'buddy_msg_deny_text');

      $this->db_buddy_update_status(BUDDY_REQUEST_DENIED);
      throw new BuddyException('buddy_err_deny_none', ERR_NONE);
    }
  }

  /**
   * @param array  $user
   * @param mixed  $new_friend_id
   * @param string $new_friend_name_unsafe
   * @param string $new_request_text_safe
   *
   * @throws BuddyException
   */
  public function beFriend($user, $new_friend_id, $new_friend_name_unsafe, $new_request_text_safe) {
    $new_friend_row = array();
    if ($new_friend_id) {
      $new_friend_row = DBStaticUser::db_user_by_id($new_friend_id, true, '`id`, `username`');
    } elseif ($new_friend_name_unsafe) {
      $new_friend_row = DBStaticUser::db_user_by_username($new_friend_name_unsafe, true, '`id`, `username`');
    }

    if (empty($new_friend_row) || empty($new_friend_row['id'])) {
      return;
    }

    if ($new_friend_row['id'] == $user['id']) {

      unset($new_friend_row);
      throw new BuddyException('buddy_err_adding_self', ERR_ERROR);
    }

    // Checking for user name & request text - in case if it was request to adding new request
    if ($new_request_text_safe) {
      $check_relation = $this->db_buddy_check_relation($user, $new_friend_row);
      if (isset($check_relation['BUDDY_ID'])) {
        throw new BuddyException('buddy_err_adding_exists', ERR_WARNING);
      }

      DBStaticMessages::msgSendFromPlayerBuddy($new_friend_row['id'], $user, 'buddy_msg_adding_title', 'buddy_msg_adding_text');

      $this->row['BUDDY_SENDER_ID'] = idval($user['id']);
      $this->row['BUDDY_OWNER_ID'] = idval($new_friend_row['id']);
      $this->row['BUDDY_STATUS'] = BUDDY_REQUEST_WAITING;
      $this->row['BUDDY_REQUEST'] = $new_request_text_safe;

      $this->insert();
      throw new BuddyException('buddy_err_adding_none', ERR_NONE);
    }
  }

  public function isEmpty() {
    return $this->row['BUDDY_STATUS'] == BUDDY_REQUEST_NOT_SET || empty($this->row['BUDDY_SENDER_ID']) || empty($this->row['BUDDY_OWNER_ID']);
  }

}


1		<?php
2
3		namespace Buddy;
4
5		use classSupernova;
6		use db_mysql;
7		use DbEmptyIterator;
8		use DbMysqliResultIterator;
9		use DBStaticMessages;
10		use DBStaticUser;
11		use Entity;
12
13		class Buddy extends Entity {
14
15		public static $tableName = 'buddy';
16		public static $idField = 'BUDDY_ID';
17
18		/**
19		* Who makes buddy request
20		*
21		* @var int\|float\|string $playerSenderId
22		*/
23		public $playerSenderId = 0;
24		/**
25		* To whom this buddy request made
26		*
27		* @var int\|float\|string $playerOwnerId
28		*/
29		public $playerOwnerId = 0;
30		/**
31		* Current buddy request status
32		*
33		* @var int $buddyStatusId
34		*/
35		public $buddyStatusId = BUDDY_REQUEST_NOT_SET;
36		/**
37		* Request text
38		*
39		* @var string $requestText
40		*/
41		public $requestText = '';
42
43		// TODO - remove public static function db_buddy_update_status($buddy_id, $status) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-07-26 16:51 UTC by Report Bug Copy Issue Report `41%` 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...
44		public function db_buddy_update_status($status) {
45		$buddy_id = idval($this->row['BUDDY_ID']);
46
47		doquery("UPDATE `{{buddy}}` SET `BUDDY_STATUS` = {$status} WHERE `BUDDY_ID` = '{$buddy_id}' LIMIT 1;");
48
49		return classSupernova::$db->db_affected_rows();
50		}
51
52	View Code Duplication	public function db_buddy_check_relation($user, $new_friend_row) {
		0 ignored issues – show Duplication introduced 2016-07-26 16:51 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
53		return static::$dbStatic->doQueryFetch(
54		"SELECT `BUDDY_ID` FROM `{{buddy}}` WHERE
55		(`BUDDY_SENDER_ID` = {$user['id']} AND `BUDDY_OWNER_ID` = {$new_friend_row['id']})
56		OR
57		(`BUDDY_SENDER_ID` = {$new_friend_row['id']} AND `BUDDY_OWNER_ID` = {$user['id']})
58		LIMIT 1 FOR UPDATE;"
59		);
60		}
61
62		/**
63		* @param db_mysql $db
64		* @param mixed $user_id
65		*
66		* @return DbEmptyIterator\|DbMysqliResultIterator
67		*/
68	View Code Duplication	public static function db_buddy_list_by_user($db, $user_id) {
		0 ignored issues – show Duplication introduced 2016-07-26 16:51 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
69		return ($user_id = idval($user_id)) ? $db->doQueryIterator(
70		"SELECT
71		b.*,
72		IF(b.BUDDY_OWNER_ID = {$user_id}, b.BUDDY_SENDER_ID, b.BUDDY_OWNER_ID) AS BUDDY_USER_ID,
73		u.username AS BUDDY_USER_NAME,
74		p.name AS BUDDY_PLANET_NAME,
75		p.galaxy AS BUDDY_PLANET_GALAXY,
76		p.system AS BUDDY_PLANET_SYSTEM,
77		p.planet AS BUDDY_PLANET_PLANET,
78		a.id AS BUDDY_ALLY_ID,
79		a.ally_name AS BUDDY_ALLY_NAME,
80		u.onlinetime
81		FROM {{buddy}} AS b
82		LEFT JOIN {{users}} AS u ON u.id = IF(b.BUDDY_OWNER_ID = {$user_id}, b.BUDDY_SENDER_ID, b.BUDDY_OWNER_ID)
83		LEFT JOIN {{planets}} AS p ON p.id_owner = u.id AND p.id = id_planet
84		LEFT JOIN {{alliance}} AS a ON a.id = u.ally_id
85		WHERE (`BUDDY_OWNER_ID` = {$user_id}) OR `BUDDY_SENDER_ID` = {$user_id}
86		ORDER BY BUDDY_STATUS, BUDDY_ID"
87		) : new DbEmptyIterator();
88		}
89
90		/**
91		* @param array $user
92		*
93		* @throws BuddyException
94		*/
95		public function accept($user) {
96		$buddy_row = $this->row;
97
98		if ($buddy_row['BUDDY_SENDER_ID'] == $user['id']) {
99		throw new BuddyException('buddy_err_accept_own', ERR_ERROR);
100		}
101
102		if ($buddy_row['BUDDY_OWNER_ID'] != $user['id']) {
103		throw new BuddyException('buddy_err_accept_alien', ERR_ERROR);
104		}
105
106		if ($buddy_row['BUDDY_STATUS'] == BUDDY_REQUEST_ACTIVE) {
107		throw new BuddyException('buddy_err_accept_already', ERR_WARNING);
108		}
109
110		if ($buddy_row['BUDDY_STATUS'] == BUDDY_REQUEST_DENIED) {
111		throw new BuddyException('buddy_err_accept_denied', ERR_ERROR);
112		}
113
114		if ($buddy_row['BUDDY_STATUS'] != BUDDY_REQUEST_WAITING) {
115		throw new BuddyException('buddy_err_unknown_status', ERR_ERROR);
116		}
117
118		$result = $this->db_buddy_update_status(BUDDY_REQUEST_ACTIVE);
119	View Code Duplication	if ($result) {
		0 ignored issues – show Duplication introduced 2016-07-26 16:51 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
120		DBStaticMessages::msgSendFromPlayerBuddy($buddy_row['BUDDY_SENDER_ID'], $user, 'buddy_msg_accept_title', 'buddy_msg_accept_text');
121		throw new BuddyException('buddy_err_accept_none', ERR_NONE);
122		} else {
123		throw new BuddyException('buddy_err_accept_internal', ERR_ERROR);
124		}
125		}
126
127		/**
128		* @param array $user
129		*
130		* @throws BuddyException
131		*/
132		public function decline($user) {
133		$buddy_row = $this->row;
134
135		if ($buddy_row['BUDDY_SENDER_ID'] != $user['id'] && $buddy_row['BUDDY_OWNER_ID'] != $user['id']) {
136		throw new BuddyException('buddy_err_delete_alien', ERR_ERROR);
137		}
138
139		if ($buddy_row['BUDDY_STATUS'] == BUDDY_REQUEST_ACTIVE) {
140		// Existing friendship
141		$ex_friend_id = $buddy_row['BUDDY_SENDER_ID'] == $user['id'] ? $buddy_row['BUDDY_OWNER_ID'] : $buddy_row['BUDDY_SENDER_ID'];
142
143		DBStaticMessages::msgSendFromPlayerBuddy($ex_friend_id, $user, 'buddy_msg_unfriend_title', 'buddy_msg_unfriend_text');
144
145		$this->delete();
146		throw new BuddyException('buddy_err_unfriend_none', ERR_NONE);
147		} elseif ($buddy_row['BUDDY_SENDER_ID'] == $user['id']) {
148		// Player's outcoming request - either denied or waiting
149		$this->delete();
150		throw new BuddyException('buddy_err_delete_own', ERR_NONE);
151		} elseif ($buddy_row['BUDDY_STATUS'] == BUDDY_REQUEST_WAITING) {
152		// Deny incoming request
153		DBStaticMessages::msgSendFromPlayerBuddy($buddy_row['BUDDY_SENDER_ID'], $user, 'buddy_msg_deny_title', 'buddy_msg_deny_text');
154
155		$this->db_buddy_update_status(BUDDY_REQUEST_DENIED);
156		throw new BuddyException('buddy_err_deny_none', ERR_NONE);
157		}
158		}
159
160		/**
161		* @param array $user
162		* @param mixed $new_friend_id
163		* @param string $new_friend_name_unsafe
164		* @param string $new_request_text_safe
165		*
166		* @throws BuddyException
167		*/
168		public function beFriend($user, $new_friend_id, $new_friend_name_unsafe, $new_request_text_safe) {
169		$new_friend_row = array();
170		if ($new_friend_id) {
171		$new_friend_row = DBStaticUser::db_user_by_id($new_friend_id, true, '`id`, `username`');
172		} elseif ($new_friend_name_unsafe) {
173		$new_friend_row = DBStaticUser::db_user_by_username($new_friend_name_unsafe, true, '`id`, `username`');
174		}
175
176		if (empty($new_friend_row) \|\| empty($new_friend_row['id'])) {
177		return;
178		}
179
180	View Code Duplication	if ($new_friend_row['id'] == $user['id']) {
		0 ignored issues – show Duplication introduced 2016-07-26 16:51 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
181		unset($new_friend_row);
182		throw new BuddyException('buddy_err_adding_self', ERR_ERROR);
183		}
184
185		// Checking for user name & request text - in case if it was request to adding new request
186		if ($new_request_text_safe) {
187		$check_relation = $this->db_buddy_check_relation($user, $new_friend_row);
188		if (isset($check_relation['BUDDY_ID'])) {
189		throw new BuddyException('buddy_err_adding_exists', ERR_WARNING);
190		}
191
192		DBStaticMessages::msgSendFromPlayerBuddy($new_friend_row['id'], $user, 'buddy_msg_adding_title', 'buddy_msg_adding_text');
193
194		$this->row['BUDDY_SENDER_ID'] = idval($user['id']);
195		$this->row['BUDDY_OWNER_ID'] = idval($new_friend_row['id']);
196		$this->row['BUDDY_STATUS'] = BUDDY_REQUEST_WAITING;
197		$this->row['BUDDY_REQUEST'] = $new_request_text_safe;
198
199		$this->insert();
200		throw new BuddyException('buddy_err_adding_none', ERR_NONE);
201		}
202		}
203
204		public function isEmpty() {
205		return $this->row['BUDDY_STATUS'] == BUDDY_REQUEST_NOT_SET \|\| empty($this->row['BUDDY_SENDER_ID']) \|\| empty($this->row['BUDDY_OWNER_ID']);
206		}
207
208		}
209

supernova-ws / SuperNova

Push — work-fleets ( b19a67...de8005 )

Buddy::db_buddy_check_relation() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like