Particletree\Pqp\PhpQuickProfiler

Complexity

Total Complexity

23

Size/Duplication

Total Lines	187
Duplicated Lines	8.02 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	11
Bugs	3	Features	3

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
B	gatherFileData()	0	27	3
A	gatherMemoryData()	0	9	1
A	gatherQueryData()	0	20	3
A	attemptToExplainQuery()	0	12	3
A	gatherSpeedData()	0	9	1
B	getReadableFileSize()	0	15	6
A	getReadableTime()	15	15	3
A	display()	0	10	1

<?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  Particletree\Pqp\Console */
    protected $console;

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

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

It seems like $console of type object<Particletree\Pqp\Console> is incompatible with the declared type object<Particletree\Pqp\Particletree\Pqp\Console> of property $console.

        if (is_null($startTime)) {
            $startTime = microtime(true);
        }
        $this->startTime = $startTime;

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?

    }
 
  /*-------------------------------------------
      AGGREGATE DATA ON THE FILES INCLUDED
  -------------------------------------------*/
  
  public function gatherFileData() {
    $files = get_included_files();
    $fileList = array();
    $fileTotals = array(
      "count" => count($files),
      "size" => 0,
      "largest" => 0,
    );

    foreach($files as $file) {
      $size = filesize($file);
      $fileList[] = array(
          'name' => $file,
          'size' => $this->getReadableFileSize($size)
        );
      $fileTotals['size'] += $size;
      if($size > $fileTotals['largest']) $fileTotals['largest'] = $size;
    }
    
    $fileTotals['size'] = $this->getReadableFileSize($fileTotals['size']);
    $fileTotals['largest'] = $this->getReadableFileSize($fileTotals['largest']);

    return array(
      'files' => $fileList,
      'fileTotals' => $fileTotals
    );
  }

    /**
     * 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
        );
    }
  
  /*--------------------------------------------------------
       QUERY DATA -- DATABASE OBJECT WITH LOGGING REQUIRED
  ----------------------------------------------------------*/
  
  public function gatherQueryData() {
    $queryTotals = array();
    $queryTotals['count'] = 0;
    $queryTotals['time'] = 0;
    $queries = array();
    
    if($this->db != '') {
      $queryTotals['count'] += $this->db->queryCount;

The property db does not exist. Did you maybe forget to declare it?

      foreach($this->db->queries as $query) {
        $query = $this->attemptToExplainQuery($query);
        $queryTotals['time'] += $query['time'];
        $query['time'] = $this->getReadableTime($query['time']);
        $queries[] = $query;
      }
    }
    
    $queryTotals['time'] = $this->getReadableTime($queryTotals['time']);
    $this->output['queries'] = $queries;

The property output does not exist. Did you maybe forget to declare it?

    $this->output['queryTotals'] = $queryTotals;
  }
  
  /*--------------------------------------------------------
       CALL SQL EXPLAIN ON THE QUERY TO FIND MORE INFO
  ----------------------------------------------------------*/
  
  function attemptToExplainQuery($query) {

It is generally recommended to explicitly declare the visibility for methods.

    try {
      $sql = 'EXPLAIN '.$query['sql'];
      $rs = $this->db->query($sql);
    }
    catch(Exception $e) {}

Consider adding a comment why this CATCH block is empty.

The class Particletree\Pqp\Exception does not exist. Did you forget a USE statement, or did you not list all dependencies?

    if($rs) {
      $row = mysql_fetch_array($rs, MYSQL_ASSOC);

The variable $rs does not seem to be defined for all execution paths leading up to this point.

      $query['explain'] = $row;
    }
    return $query;
  }

    /**
     * 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
        );
    }
  
  /*-------------------------------------------
       HELPER FUNCTIONS TO FORMAT DATA
  -------------------------------------------*/
  
  public function getReadableFileSize($size, $retstring = null) {
          // adapted from code at http://aidanlister.com/repos/v/function.size_readable.php
         $sizes = array('bytes', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB');

         if ($retstring === null) { $retstring = '%01.2f %s'; }

    $lastsizestring = end($sizes);

    foreach ($sizes as $sizestring) {
          if ($size < 1024) { break; }
             if ($sizestring != $lastsizestring) { $size /= 1024; }
         }
         if ($sizestring == $sizes[0]) { $retstring = '%01d %s'; } // Bytes aren't normally fractional

The variable $sizestring seems to be defined by a foreach iteration on line 154. Are you sure the iterator is never empty, otherwise this variable is not defined?

         return sprintf($retstring, $size, $sizestring);
  }

    /**
     * Static formatter for human-readable time
     * Only handles time up to 60 minutes gracefully
     *
     * @param integer $time time in seconds
     * @return string
     */
    public static function getReadableTime($time)

This method seems to be duplicated in your project.

    {
        $unit = 's';

        if ($time < 1) {
            $time *= 1000;
            $unit = 'ms';
        } else if ($time > 60) {
            $time /= 60;
            $unit = 'm';
        }

        $time = number_format($time, 3);
        return "{$time} {$unit}";
    }
  

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

$this->gatherQueryData() is of type null, but the function expects a array.

        $display->setSpeedData($this->gatherSpeedData());

        $display();
    }
}