PhpQuickProfiler::explainQuery() - Code Metrics - Inspection of "Splits database logic into profile/display, change..." - jacobemerick/pqp - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3f8872...112c81 )

by Jacob

created 2015-12-07 13:43 UTC

PhpQuickProfiler::explainQuery() A

↳ Parent: PhpQuickProfiler

Complexity

Conditions	2
Paths	4

Size

Total Lines	12
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	12
rs	9.4286
cc	2
eloc	9
nc	4
nop	2

<?php

/*****************************************
 * Title : PHP Quick Profiler Class
 * Author : Created by Ryan Campbell
 * URL : http://particletree.com/features/php-quick-profiler/
 * Description : This class processes the logs and organizes the data
 *  for output to the browser. Initialize this class with a start time
 *  at the beginning of your code, and then call the display method when
 *  your code is terminating.
*****************************************/

namespace Particletree\Pqp;

class PhpQuickProfiler
{

    /** @var  Console */
    protected $console;

    /** @var  integer */
    protected $startTime;

    /** @var  object */
    protected $pdo;

    /**
     * @param Console $console
     * @param object  $pdo
     * @param integer $startTime
     */
    public function __construct(Console $console, $pdo = null, $startTime = null)
    {
        $this->console = $console;
        $this->pdo = $pdo;

        if (is_null($startTime)) {
            $startTime = microtime(true);
        }
        $this->startTime = $startTime;
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * Get data about files loaded for the application to current point
     *
     * @returns array
     */
    public function gatherFileData()
    {
        $files = get_included_files();
        $data = array();
        foreach ($files as $file) {
            array_push($data, array(
                'name' => $file,
                'size' => filesize($file)
            ));
        }
        return $data;
    }

    /**
     * Get data about memory usage of the application
     *
     * @returns array
     */
    public function gatherMemoryData()
    {
        $usedMemory = memory_get_peak_usage();
        $allowedMemory = ini_get('memory_limit');
        return array(
            'used'    => $usedMemory,
            'allowed' => $allowedMemory
        );
    }

    /**
     * Get data about sql usage of the application
     *
     * @param array $profiledQueries
     * @returns array
     */
    public function gatherQueryData(array $profiledQueries)
    {
        $data = array();
        foreach ($profiledQueries as $query) {
            if ($query['function'] !== 'perform') {
                continue;
            }

            array_push($data, array(
                'sql'     => $query['statement'],
                'explain' => $this->explainQuery($query['statement'], $query['bind_values']),
                'time'    => $query['duration']
            ));
        }
        return $data;
    }

    /**
     * Attempts to explain a query
     *
     * @param string $query
     * @param array  $parameters
     * @return array
     */
    protected function explainQuery($query, $parameters)
    {
        $query = "EXPLAIN {$query}";
        try {
            $statement = $this->pdo->prepare($query);
            $statement->execute($parameters);
            return $statement->fetch(\PDO::FETCH_ASSOC);
        } catch (\Exception $e) {
            echo $e->getMessage();
        }
        return '';
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());
}
    }

    /**
     * Get data about speed of the application
     *
     * @returns array
     */
    public function gatherSpeedData()
    {
        $elapsedTime = microtime(true) - $this->startTime;
        $allowedTime = ini_get('max_execution_time');
        return array(
            'elapsed' => $elapsedTime,
            'allowed' => $allowedTime
        );
    }

    /**
     * Triggers end display of the profiling data
     *
     * @param Display $display
     * @param array   $profiledQueries
     */
    public function display(Display $display, array $profiledQueries = array())
    {
        $display->setConsole($this->console);
        $display->setFileData($this->gatherFileData());
        $display->setMemoryData($this->gatherMemoryData());
        $display->setQueryData($this->gatherQueryData($profiledQueries));
        $display->setSpeedData($this->gatherSpeedData());

        $display();
    }
}


1			<?php
2
3			/*****************************************
4			* Title : PHP Quick Profiler Class
5			* Author : Created by Ryan Campbell
6			* URL : http://particletree.com/features/php-quick-profiler/
7			* Description : This class processes the logs and organizes the data
8			* for output to the browser. Initialize this class with a start time
9			* at the beginning of your code, and then call the display method when
10			* your code is terminating.
11			*****************************************/
12
13			namespace Particletree\Pqp;
14
15			class PhpQuickProfiler
16			{
17
18			/** @var Console */
19			protected $console;
20
21			/** @var integer */
22			protected $startTime;
23
24			/** @var object */
25			protected $pdo;
26
27			/**
28			* @param Console $console
29			* @param object $pdo
30			* @param integer $startTime
31			*/
32			public function __construct(Console $console, $pdo = null, $startTime = null)
33			{
34			$this->console = $console;
35			$this->pdo = $pdo;
36
37			if (is_null($startTime)) {
38			$startTime = microtime(true);
39			}
40			$this->startTime = $startTime;
			0 ignored issues – show Documentation Bug introduced 2015-12-06 03:03 UTC by Report Bug Copy Issue Report It seems like `$startTime` can also be of type `double`. However, the property `$startTime` is declared as type `integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
41			}
42
43			/**
44			* Get data about files loaded for the application to current point
45			*
46			* @returns array
47			*/
48			public function gatherFileData()
49			{
50			$files = get_included_files();
51			$data = array();
52			foreach ($files as $file) {
53			array_push($data, array(
54			'name' => $file,
55			'size' => filesize($file)
56			));
57			}
58			return $data;
59			}
60
61			/**
62			* Get data about memory usage of the application
63			*
64			* @returns array
65			*/
66			public function gatherMemoryData()
67			{
68			$usedMemory = memory_get_peak_usage();
69			$allowedMemory = ini_get('memory_limit');
70			return array(
71			'used' => $usedMemory,
72			'allowed' => $allowedMemory
73			);
74			}
75
76			/**
77			* Get data about sql usage of the application
78			*
79			* @param array $profiledQueries
80			* @returns array
81			*/
82			public function gatherQueryData(array $profiledQueries)
83			{
84			$data = array();
85			foreach ($profiledQueries as $query) {
86			if ($query['function'] !== 'perform') {
87			continue;
88			}
89
90			array_push($data, array(
91			'sql' => $query['statement'],
92			'explain' => $this->explainQuery($query['statement'], $query['bind_values']),
93			'time' => $query['duration']
94			));
95			}
96			return $data;
97			}
98
99			/**
100			* Attempts to explain a query
101			*
102			* @param string $query
103			* @param array $parameters
104			* @return array
105			*/
106			protected function explainQuery($query, $parameters)
107			{
108			$query = "EXPLAIN {$query}";
109			try {
110			$statement = $this->pdo->prepare($query);
111			$statement->execute($parameters);
112			return $statement->fetch(\PDO::FETCH_ASSOC);
113			} catch (\Exception $e) {
114			echo $e->getMessage();
115			}
116			return '';
			0 ignored issues – show Bug Best Practice introduced 2015-12-07 13:45 UTC by Report Bug Copy Issue Report The return type of `return '';` (`string`) is incompatible with the return type documented by `Particletree\Pqp\PhpQuickProfiler::explainQuery` of type `array`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: 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()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
117			}
118
119			/**
120			* Get data about speed of the application
121			*
122			* @returns array
123			*/
124			public function gatherSpeedData()
125			{
126			$elapsedTime = microtime(true) - $this->startTime;
127			$allowedTime = ini_get('max_execution_time');
128			return array(
129			'elapsed' => $elapsedTime,
130			'allowed' => $allowedTime
131			);
132			}
133
134			/**
135			* Triggers end display of the profiling data
136			*
137			* @param Display $display
138			* @param array $profiledQueries
139			*/
140			public function display(Display $display, array $profiledQueries = array())
141			{
142			$display->setConsole($this->console);
143			$display->setFileData($this->gatherFileData());
144			$display->setMemoryData($this->gatherMemoryData());
145			$display->setQueryData($this->gatherQueryData($profiledQueries));
146			$display->setSpeedData($this->gatherSpeedData());
147
148			$display();
149			}
150			}
151

jacobemerick / pqp

Push — master ( 3f8872...112c81 )

PhpQuickProfiler::explainQuery() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like