MessageSearch - Code Metrics - Inspection of "Move player sorting to SQL instead of PHP" - allejo/bzion - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/player-list ( be1f72...9f06dd )

by Vladimir

created 2017-07-21 02:51 UTC

MessageSearch A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

85.71%

Importance

Changes

Metric	Value
wmc	3
lcom	1
cbo	2
dl	0
loc	57
ccs	12
cts	14
cp	0.8571
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	mysqlSearch()	7	1
A	search()	10	1

<?php
/**
 * This file contains a class that performs message searches
 *
 * @license    https://github.com/allejo/bzion/blob/master/LICENSE.md GNU General Public License Version 3
 */

namespace BZIon\Search;

use BZIon\Debug\Debug;

/**
 * Performs a search on messages
 */
class MessageSearch
{
    /**
     * The MySQL query builder for messages
     * @var \MessageQueryBuilder
     */
    private $queryBuilder;

    /**
     * The user to whom the returned messages will be visible
     * @var \Player|null
     */
    private $player;

    /**
     * Create a new message search
     *
     * @param \MessageQueryBuilder $queryBuilder The MySQL query builder for messages
     * @param \Player|null         $player       The player to make the search for
     */
    public function __construct(\MessageQueryBuilder $queryBuilder, \Player $player = null)
    {
        $this->queryBuilder = $queryBuilder;
        $this->player = $player;
    }

    /**
     * Perform a search on messages and get the results
     *
     * @param  string     $query The query string
     * @return \Message[] The results of the search
     */
    public function search($query)
    {
        Debug::startStopwatch('search.messages');

        $results = $this->mysqlSearch($query);

        Debug::finishStopwatch('search.messages');

        return $results;
    }

    /**
     * Perform a search on messages using the data stored in the MySQL database
     *
     * @param  string     $query The query string
     * @return \Message[] The results of the search
     */
    private function mysqlSearch($query)
    {
        return $this->queryBuilder
            ->search($query)
            ->forPlayer($this->player)
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            ->getModels();
    }
}


1		<?php
2		/**
3		* This file contains a class that performs message searches
4		*
5		* @license https://github.com/allejo/bzion/blob/master/LICENSE.md GNU General Public License Version 3
6		*/
7
8		namespace BZIon\Search;
9
10		use BZIon\Debug\Debug;
11
12		/**
13		* Performs a search on messages
14		*/
15		class MessageSearch
16		{
17		/**
18		* The MySQL query builder for messages
19		* @var \MessageQueryBuilder
20		*/
21		private $queryBuilder;
22
23		/**
24		* The user to whom the returned messages will be visible
25		* @var \Player\|null
26		*/
27		private $player;
28
29		/**
30		* Create a new message search
31		*
32		* @param \MessageQueryBuilder $queryBuilder The MySQL query builder for messages
33		* @param \Player\|null $player The player to make the search for
34		*/
35	1	public function __construct(\MessageQueryBuilder $queryBuilder, \Player $player = null)
36		{
37	1	$this->queryBuilder = $queryBuilder;
38	1	$this->player = $player;
39	1	}
40
41		/**
42		* Perform a search on messages and get the results
43		*
44		* @param string $query The query string
45		* @return \Message[] The results of the search
46		*/
47	1	public function search($query)
48		{
49	1	Debug::startStopwatch('search.messages');
50
51	1	$results = $this->mysqlSearch($query);
52
53		Debug::finishStopwatch('search.messages');
54
55		return $results;
56		}
57
58		/**
59		* Perform a search on messages using the data stored in the MySQL database
60		*
61		* @param string $query The query string
62		* @return \Message[] The results of the search
63		*/
64	1	private function mysqlSearch($query)
65		{
66	1	return $this->queryBuilder
67	1	->search($query)
68	1	->forPlayer($this->player)
		0 ignored issues – show Bug introduced 2015-12-02 06:58 UTC by Report Bug Copy Issue Report It seems like `$this->player` can be `null`; however, `forPlayer()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
69	1	->getModels();
70		}
71		}
72

allejo / bzion

Push — feature/player-list ( be1f72...9f06dd )

MessageSearch A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Duplication Side-by-Side

Filter issues like