411 lines
12 KiB
PHP
411 lines
12 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Profiler
|
|
*
|
|
* PHP version 5
|
|
*
|
|
* Licensed under The MIT License
|
|
* Redistribution of these files must retain the above copyright notice.
|
|
*
|
|
* @author Josh Sherman <josh@gravityblvd.com>
|
|
* @copyright Copyright 2007-2010, Gravity Boulevard, LLC
|
|
* @license http://www.opensource.org/licenses/mit-license.html
|
|
* @package PICKLES
|
|
* @link http://p.ickl.es
|
|
*/
|
|
|
|
/**
|
|
* Profiler Class
|
|
*
|
|
* The Profiler class is statically interfaced with and allows for in depth
|
|
* profiling of a site. By default profiling is off, but can be enabled in the
|
|
* config.ini for a site. Out of the box the profiler will report on every
|
|
* class object in the system that extends the code Object class.
|
|
*
|
|
* Note: I really wanted to use PHP Quick Profiler by Ryan Campbell of
|
|
* Particletree but it kept barking out errors when I tried to use it with
|
|
* E_STRICT turned on. Here's a link anyway since it looks awesome:
|
|
* http://particletree.com/features/php-quick-profiler/
|
|
*
|
|
* @usage <code>Profiler::log('some action you want to track');</code>
|
|
* @usage <code>Profiler::log($object, 'methodName');</code>
|
|
*/
|
|
class Profiler
|
|
{
|
|
/**
|
|
* Config
|
|
*
|
|
* Profiler configuration
|
|
*
|
|
* @static
|
|
* @access private
|
|
* @var array
|
|
*/
|
|
private static $config;
|
|
|
|
/**
|
|
* Profile
|
|
*
|
|
* Array of logged events
|
|
*
|
|
* @static
|
|
* @access private
|
|
* @var array
|
|
*/
|
|
private static $profile = array();
|
|
|
|
/**
|
|
* Queries
|
|
*
|
|
* Number of queries that have been logged
|
|
*
|
|
* @static
|
|
* @access private
|
|
* @var integer
|
|
*/
|
|
private static $queries = 0;
|
|
|
|
/**
|
|
* Timers
|
|
*
|
|
* Array of active timers
|
|
*
|
|
* @static
|
|
* @access private
|
|
* @var array
|
|
*/
|
|
private static $timers = array();
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* Private constructor since this class is interfaced wtih statically.
|
|
*
|
|
* @access private
|
|
*/
|
|
private function __construct()
|
|
{
|
|
|
|
}
|
|
|
|
/**
|
|
* Enabled
|
|
*
|
|
* Checks if the profiler is set to boolean true or if the passed type is
|
|
* specified in the profiler configuration value.
|
|
*
|
|
* @param array $type type(s) to check
|
|
* @return boolean whether or not the type is enabled
|
|
*/
|
|
public static function enabled(/* polymorphic */)
|
|
{
|
|
// Grabs the config object if we don't have one yet
|
|
if (self::$config == null)
|
|
{
|
|
$config = Config::getInstance();
|
|
self::$config = $config->pickles['profiler'];
|
|
}
|
|
|
|
// Checks if we're set to boolean true
|
|
if (self::$config === true)
|
|
{
|
|
return true;
|
|
}
|
|
else
|
|
{
|
|
$types = func_get_args();
|
|
|
|
foreach ($types as $type)
|
|
{
|
|
if (stripos(self::$config, $type) !== false)
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Log
|
|
*
|
|
* Logs the event to be displayed later on. Due to the nature of how much
|
|
* of a pain it is to determine which class method called this method I
|
|
* opted to make the method a passable argument for ease of use. Perhaps
|
|
* I'll revisit in the future. Handles all elapsed time calculations and
|
|
* memory usage.
|
|
*
|
|
* @static
|
|
* @param mixed $data data to log
|
|
* @param string $method name of the class method being logged
|
|
*/
|
|
public static function log($data, $method = false, $type = false)
|
|
{
|
|
$time = microtime(true);
|
|
$data_type = ($data == 'timer' ? $data : gettype($data));
|
|
|
|
// Tidys the data by type
|
|
switch ($data_type)
|
|
{
|
|
case 'array':
|
|
$log = '<pre>' . print_r($data, true) . '</pre>';
|
|
break;
|
|
|
|
case 'object':
|
|
$log = '<span style="color:#666">[</span><span style="color:#777">' . get_parent_class($data) . '</span><span style="color:#666">]</span> '
|
|
. '<span style="color:#69c">' . get_class($data) . '</span>'
|
|
. ($method != '' ? '<span style="color:#666">-></span><span style="color:#4eed9e">' . $method . '</span><span style="color:#666">()</span>' : '');
|
|
|
|
$data_type = '<span style="color:Peru">' . $data_type . '</span>';
|
|
break;
|
|
|
|
case 'timer':
|
|
$log = $method;
|
|
|
|
$data_type = '<span style="color:#6c0">' . $data_type . '</span>';
|
|
break;
|
|
|
|
case 'string':
|
|
default:
|
|
if ($type != false)
|
|
{
|
|
$data_type = $type;
|
|
}
|
|
|
|
$log = $data;
|
|
break;
|
|
}
|
|
|
|
self::$profile[] = array(
|
|
'log' => $log,
|
|
'type' => $data_type,
|
|
'time' => $time,
|
|
'elapsed' => $time - PICKLES_START_TIME,
|
|
'memory' => memory_get_usage(),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Log Query
|
|
*
|
|
* Serves as a wrapper to get query data to the log function
|
|
*
|
|
* @static
|
|
* @param string $query the query being executed
|
|
* @param array $input_parameters optional prepared statement data
|
|
* @param array $explain EXPLAIN data for the query
|
|
* @param float $duration the speed of the query
|
|
*/
|
|
public static function logQuery($query, $input_parameters = false, $explain = false, $duration = false)
|
|
{
|
|
self::$queries++;
|
|
|
|
$log = '';
|
|
|
|
if ($input_parameters != 'false' && is_array($input_parameters))
|
|
{
|
|
$log .= '<br />';
|
|
|
|
foreach ($input_parameters as $key => $value)
|
|
{
|
|
$log .= '<br /><span style="color:#a82222">' . $key . '</span> <span style="color:#666">=></span> <span style="color:#ffff7f">' . $value . '</span>';
|
|
|
|
$query = str_replace($key, '<span style="color:#a82222">' . $key . '</span>', $query);
|
|
}
|
|
}
|
|
|
|
$log = '<span style="color:#009600">' . $query . '</span>' . $log;
|
|
|
|
if (is_array($explain))
|
|
{
|
|
$log .= '<br />';
|
|
|
|
foreach ($explain as $table)
|
|
{
|
|
$log .= '<br /><span style="color:RoyalBlue">Possible Keys</span> <span style="color:#666">=></span> <span style="color:DarkGoldenRod">' . ($table['possible_keys'] == '' ? '<em style="color:red">NONE</em>' : $table['possible_keys']) . '</span>'
|
|
. '<br /><span style="color:RoyalBlue">Key</span> <span style="color:#666">=></span> <span style="color:DarkGoldenRod">' . ($table['key'] == '' ? '<em style="color:red">NONE</em>' : $table['key']) . '</span>'
|
|
. '<br /><span style="color:RoyalBlue">Type</span> <span style="color:#666">=></span> <span style="color:DarkGoldenRod">' . $table['type'] . '</span>'
|
|
. '<br /><span style="color:RoyalBlue">Rows</span> <span style="color:#666">=></span> <span style="color:DarkGoldenRod">' . $table['rows'] . '</span>'
|
|
. ($table['Extra'] != '' ? '<br /><span style="color:RoyalBlue">Extra</span> <span style="color:#666">=></span> <span style="color:DarkGoldenRod">' . $table['Extra'] . '</span>' : '');
|
|
}
|
|
}
|
|
|
|
$log .= '<br /><br /><span style="color:DarkKhaki">Speed:</span> ' . number_format($duration * 100, 3) . ' ms';
|
|
|
|
self::log($log, false, '<span style="color:DarkCyan">database</span>');
|
|
}
|
|
|
|
/**
|
|
* Timer
|
|
*
|
|
* Logs the start and end of a timer.
|
|
*
|
|
* @param string $timer name of the timer
|
|
* @return boolean whether or not timer profiling is enabled
|
|
*/
|
|
public static function timer($timer)
|
|
{
|
|
if (self::enabled('timers'))
|
|
{
|
|
// Starts the timer
|
|
if (!isset(self::$timers[$timer]))
|
|
{
|
|
self::$timers[$timer] = microtime(true);
|
|
self::Log('timer', '<span style="color:Orchid">Started timer</span> <span style="color:Yellow">' . $timer . '</span>');
|
|
}
|
|
// Ends the timer
|
|
else
|
|
{
|
|
self::Log('timer', '<span style="color:Orchid">Stopped timer</span> <span style="color:Yellow">' . $timer . '</span> <span style="color:#666">=></span> <span style="color:DarkKhaki">Time Elapsed:</span> ' . number_format((microtime(true) - self::$timers[$timer]) * 100, 3) . ' ms');
|
|
|
|
unset(self::$timers[$timer]);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Report
|
|
*
|
|
* Generates the Profiler report that is displayed by the Controller.
|
|
* Contains all the HTML needed to display the data properly inline on the
|
|
* page. Will generally be displayed after the closing HTML tag.
|
|
*/
|
|
public static function report()
|
|
{
|
|
?>
|
|
<style>
|
|
#pickles-profiler
|
|
{
|
|
background: #212121;
|
|
width: 800px;
|
|
margin: 0 auto;
|
|
margin-top: 20px;
|
|
margin-bottom: 20px;
|
|
-moz-border-radius: 20px;
|
|
-webkit-border-radius: 20px;
|
|
border-radius: 20px;
|
|
-moz-box-shadow: 0 3px 4px rgba(0,0,0,0.5);
|
|
-webkit-box-shadow: 0 3px 4px rgba(0,0,0,0.5);
|
|
box-shadow: 0 3px 4px rgba(0,0,0,0.5);
|
|
border: 6px solid #666;
|
|
padding: 10px 20px 20px;
|
|
font-family: monospace;
|
|
font-size: 12px;
|
|
text-align: left;
|
|
}
|
|
#pickles-profiler table
|
|
{
|
|
width: 100%;
|
|
}
|
|
#pickles-profiler table tr th, #pickles-profiler table tr td
|
|
{
|
|
padding: 10px;
|
|
}
|
|
#pickles-profiler .even
|
|
{
|
|
background-color: #323232;
|
|
}
|
|
#pickles-profiler, #pickles-profiler table tr td, #pickles-profiler table tr th
|
|
{
|
|
color: #efefe8;
|
|
}
|
|
</style>
|
|
<div id="pickles-profiler">
|
|
<strong style="font-size:1.5em">PICKLES Profiler</strong><br /><br />
|
|
<?php
|
|
if (count(self::$profile) == 0)
|
|
{
|
|
echo '<em style="line-height:18px">There is nothing to profile. This often happens when the profiler configuration is set to either "queries" or "explains" and there are no database queries on the page (common on pages that only have a template). You may want to set the profiler to boolean true to ensure you get a profile of the page.</em>';
|
|
}
|
|
else
|
|
{
|
|
$start_time = PICKLES_START_TIME;
|
|
$peak_usage = self::formatSize(memory_get_peak_usage());
|
|
$end_time = self::$profile[count(self::$profile) - 1]['time']; // TODO
|
|
$duration = ($end_time - $start_time);
|
|
|
|
$logs = count(self::$profile);
|
|
$logs .= ' Log' . ($logs == 1 ? '' : 's');
|
|
|
|
$files = count(get_included_files());
|
|
$files .= ' File' . ($files == 1 ? '' : 's');
|
|
|
|
$queries = self::$queries . ' Quer'. (self::$queries == 1 ? 'y' : 'ies');
|
|
?>
|
|
<table style="border-collapse:separate;border-spacing:1px;border-radius:10px;text-shadow:1px 1px 1px #000">
|
|
<tr>
|
|
<td style="text-align:center;background:#480000">
|
|
<span style="font-weight:bold;">Console</span>
|
|
<div style="color:#ff7f7f;font-size:1.2em;padding-top:10px"><?php echo $logs; ?></div>
|
|
</td>
|
|
<td style="text-align:center;background:#552200">
|
|
<span style="font-weight:bold;">Load Time</span>
|
|
<div style="color:#ffa366;font-size:1.2em;padding-top:10px"><?php echo number_format($duration * 100, 3) . ' ms / ' . ini_get('max_execution_time'); ?></div>
|
|
</td>
|
|
<td style="text-align:center;background:#545500">
|
|
<span style="font-weight:bold;">Memory Usage</span>
|
|
<div style="color:#ffff6d;font-size:1.2em;padding-top:10px"><?php echo $peak_usage . ' / ' . ini_get('memory_limit'); ?></div>
|
|
</td>
|
|
<td style="text-align:center;background:#004200">
|
|
<span style="font-weight:bold;">Database</span>
|
|
<div style="color:#7dff7d;font-size:1.2em;padding-top:10px"><?php echo $queries; ?></div>
|
|
</td>
|
|
<td style="text-align:center;background:#000048">
|
|
<span style="font-weight:bold;">Includes</span>
|
|
<div style="color:#c4c4ff;font-size:1.2em;padding-top:10px"><?php echo $files; ?></div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table>
|
|
<tr>
|
|
<th style="text-align:left" colspan="2">Console</th>
|
|
<th style="text-align:right">Memory</th>
|
|
<th style="text-align:right">Time</th>
|
|
</tr>
|
|
<?php
|
|
foreach (self::$profile as $key => $entry)
|
|
{
|
|
?>
|
|
<tr>
|
|
<td style="font-weight:bold;color:#999"><?php echo $entry['type']; ?></td>
|
|
<td><?php echo $entry['log']; ?></td>
|
|
<td style="text-align:right" nowrap="nowrap"><?php echo self::formatSize($entry['memory']); ?></td>
|
|
<td style="text-align:right" nowrap="nowrap"><?php echo number_format($entry['elapsed'] * 100, 3); ?> ms</td>
|
|
</tr>
|
|
<?php
|
|
}
|
|
?>
|
|
</table>
|
|
<?php
|
|
}
|
|
?>
|
|
</div>
|
|
<br /><br />
|
|
<?php
|
|
}
|
|
|
|
/**
|
|
* Format Size
|
|
*
|
|
* Formats the passed size into a human readable string
|
|
*
|
|
* @static
|
|
* @access private
|
|
* @param float $filesize size of the file
|
|
* @return string formatted number string
|
|
*/
|
|
private static function formatSize($filesize)
|
|
{
|
|
$units = array('bytes', 'kB', 'MB', 'GB');
|
|
|
|
return number_format(round($filesize / pow(1024, ($i = floor(log($filesize, 1024)))), 2), 2) . ' ' . $units[$i];
|
|
}
|
|
}
|
|
|
|
?>
|