jacobemerick/pqp

<?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;

use Exception;

class PhpQuickProfiler
{

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

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

    /** @var  Display */
    protected $display;

    /** @var  array */
    protected $profiledQueries = array();

    /**
     * @param double $startTime
     */
    public function __construct($startTime = null)
    {
        if (is_null($startTime)) {
            $startTime = microtime(true);
        }
        $this->startTime = $startTime;
    }

    /**
     * @param Console $console
     */
    public function setConsole(Console $console)
    {
        $this->console = $console;
    }

    /**
     * @param Display $display
     */
    public function setDisplay(Display $display)
    {
        $this->display = $display;
    }

    /**
     * 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
        );
    }

    /**
     * @param array $profiledQueries
     */
    public function setProfiledQueries(array $profiledQueries)
    {
        $this->profiledQueries = $profiledQueries;
    }

    /**
     * Get data about sql usage of the application
     *
     * @param object $dbConnection
     * @returns array
     */
    public function gatherQueryData($dbConnection = null)
    {
        if (is_null($dbConnection)) {
            return array();
        }

        if (empty($this->profiledQueries) && property_exists($dbConnection, 'queries')) {
            $this->setProfiledQueries($dbConnection->queries);
        }

        $data = array();
        foreach ($this->profiledQueries as $query) {
            array_push($data, array(
                'sql'     => $query['sql'],
                'explain' => $this->explainQuery($dbConnection, $query['sql'], $query['parameters']),
                'time'    => $query['time']
            ));
        }
        return $data;
    }

    /**
     * Attempts to explain a query
     *
     * @param object $dbConnection
     * @param string $query
     * @param array  $parameters
     * @throws Exception
     * @return array
     */
    protected function explainQuery($dbConnection, $query, $parameters = array())
    {
        $driver = $dbConnection->getAttribute(\PDO::ATTR_DRIVER_NAME);
        $query = $this->getExplainQuery($query, $driver);
        $statement = $dbConnection->prepare($query);
        if ($statement === false) {
            throw new Exception('Invalid query passed to explainQuery method');
        }
        $statement->execute($parameters);
        $result = $statement->fetch(\PDO::FETCH_ASSOC);
        if ($result === false) {
            throw new Exception('Query could not be explained with given parameters');
        }
        return $result;
    }

    /**
     * Attempts to figure out what kind of explain query format the db wants
     *
     * @param string $query
     * @param string $driver
     * @throws Exception
     * @return string
     */
    protected function getExplainQuery($query, $driver)
    {
        if ($driver == 'mysql') {
            return "EXPLAIN {$query}";
        } elseif ($driver == 'sqlite') {
            return "EXPLAIN QUERY PLAN {$query}";
        }
        throw new Exception('Could not process db driver');
    }

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

    /**
     * Triggers end display of the profiling data
     *
     * @param object $dbConnection
     * @throws Exception
     */
    public function display($dbConnection = null)
    {
        if (!isset($this->display)) {
            throw new Exception('Display object has not been injected into Profiler');
        }
        if (!isset($this->console)) {
            throw new Exception('Console object has not been injected into Profiler');
        }

        $this->display->setStartTime($this->startTime);
        $this->display->setConsole($this->console);
        $this->display->setFileData($this->gatherFileData());
        $this->display->setMemoryData($this->gatherMemoryData());
        $this->display->setQueryData($this->gatherQueryData($dbConnection));
        $this->display->setSpeedData($this->gatherSpeedData());

        $this->display->__invoke();
    }
}