Added the debug toolkit plugin, found on the bakery website.

git-svn-id: file:///svn-source/pmgr/branches/ledger_transactions_20090605@92 97e9348a-65ac-dc4b-aefc-98561f571b83
This commit is contained in:
abijah
2009-06-10 21:12:59 +00:00
parent 18b928411b
commit 8ab8d087e6
41 changed files with 4502 additions and 0 deletions

View File

@@ -0,0 +1,133 @@
<?php
/* SVN FILE: $Id$ */
/**
* Debug View
*
* Custom Debug View class, helps with development.
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright 2006-2008, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2006-2008, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.cake.libs.
* @since CakePHP v 1.2.0.4487
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
App::import('Vendor', 'DebugKit.DebugKitDebugger');
App::import('Component', 'DebugKit.Toolbar');
/**
* DebugView used by DebugKit
*
* @package debug_kit.views
* @todo Remove workarounds.
*/
class DebugView extends DoppelGangerView {
/**
* The old extension of the current template.
*
* @var string
*/
var $_oldExtension = null;
/**
* Overload _render to capture filenames and time actual rendering of each view file
*
* @param string $___viewFn Filename of the view
* @param array $___dataForView Data to include in rendered view
* @return string Rendered output
* @access protected
*/
function _render($___viewFn, $___dataForView, $loadHelpers = true, $cached = false) {
if (isset($this->_oldExtension) && strstr($___viewFn, '.debug_view')) {
$___viewFn = substr($___viewFn, 0, -10) . $this->_oldExtension;
}
if (!isset($___dataForView['disableTimer'])) {
DebugKitDebugger::startTimer('render_' . basename($___viewFn), sprintf(__('Rendering %s', true), Debugger::trimPath($___viewFn)));
}
$out = parent::_render($___viewFn, $___dataForView, $loadHelpers, $cached);
if (!isset($___dataForView['disableTimer'])) {
DebugKitDebugger::stopTimer('render_' . basename($___viewFn));
}
return $out;
}
/**
* Renders view for given action and layout. If $file is given, that is used
* for a view filename (e.g. customFunkyView.ctp).
* Adds timers, for all subsequent rendering, and injects the debugKit toolbar.
*
* @param string $action Name of action to render for
* @param string $layout Layout to use
* @param string $file Custom filename for view
* @return string Rendered Element
*/
function render($action = null, $layout = null, $file = null) {
DebugKitDebugger::startTimer('viewRender', __('Rendering View', true));
$out = parent::render($action, $layout, $file);
DebugKitDebugger::stopTimer('viewRender');
DebugKitDebugger::stopTimer('controllerRender');
if (isset($this->loaded['toolbar'])) {
$this->loaded['toolbar']->postRender();
}
//Temporary work around to hide the SQL dump at page bottom
Configure::write('debug', 0);
return $this->output;
}
/**
* Workaround _render() limitation in core. Which forces View::_render() for .ctp and .thtml templates
* Creates temporary extension to trick View::render() & View::renderLayout()
*
* @param string $name Action name.
* @return string
**/
function _getViewFileName($name = null) {
$filename = parent::_getViewFileName($name);
return $this->_replaceExtension($filename);
}
/**
* Workaround _render() limitation in core. Which forces View::_render() for .ctp and .thtml templates
* Creates temporary extension to trick View::render() & View::renderLayout()
*
* @param string $name Layout Name
* @return string
**/
function _getLayoutFileName($name = null) {
$filename = parent::_getLayoutFileName($name);
return $this->_replaceExtension($filename);
}
/**
* replace the Extension on a filename and set the temporary workaround extension.
*
* @param string $filename Filename to replace extension for.
* @return string
**/
function _replaceExtension($filename) {
if (substr($filename, -3) == 'ctp') {
$this->_oldExtension = 'ctp';
$filename = substr($filename, 0, strlen($filename) -3) . 'debug_view';
} elseif (substr($filename, -5) == 'thtml') {
$this->_oldExtension = 'thtml';
$filename = substr($filename, 0, strlen($filename) -5) . 'debug_view';
}
return $filename;
}
}
?>

View File

@@ -0,0 +1,52 @@
<?php
/* SVN FILE: $Id$ */
/**
* Debug Toolbar Element
*
* Renders all of the other panel elements.
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright 2006-2008, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2006-2008, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.debug_kit.views.elements
* @since
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
?>
<div id="debug-kit-toolbar">
<?php if (empty($debugToolbarPanels)) :?>
<p class="warning"><?php __('There are no active panels. You must enable a panel to see its output.'); ?></p>
<?php else: ?>
<ul id="panel-tabs">
<li class="panel-tab icon">
<a href="#hide" id="hide-toolbar">
<?php echo $html->image('/debug_kit/img/cake.icon.png', array('alt' => 'cakePHP')); ?>
</a>
</li>
<?php foreach ($debugToolbarPanels as $panelName => $panelInfo): ?>
<li class="panel-tab">
<a href="#<?php echo Inflector::underscore($panelName); ?>">
<?php echo Inflector::humanize(Inflector::underscore($panelName)); ?>
</a>
<div class="panel-content" id="<?php echo Inflector::underscore($panelName); ?>-tab">
<?php echo $this->element($panelInfo['elementName'], $panelInfo); ?>
</div>
</li>
<?php endforeach ?>
</ul>
<?php endif; ?>
</div>

View File

@@ -0,0 +1,48 @@
<?php
/* SVN FILE: $Id$ */
/**
* Log Panel Element
*
*
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright 2006-2008, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2006-2008, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.debug_kit.views.elements
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
?>
<h2><?php __('Logs') ?></h2>
<div class="code-table">
<?php foreach ($content as $logName => $logs): ?>
<h3><?php echo $logName ?></h3>
<?php
$len = count($logs);
if ($len > 0):
$headers = array(__('Time', true), __('Message', true));
$rows = array();
for ($i = 0; $i < $len; $i += 2):
$rows[] = array(
$logs[$i], $logs[$i + 1]
);
endfor;
echo $toolbar->table($rows, $headers, array('title' => $logName));
else: ?>
<p class="info"><?php __('There were no log entries made this request'); ?></p>
<?php endif; ?>
<?php endforeach; ?>
</div>

View File

@@ -0,0 +1,43 @@
<?php
/* SVN FILE: $Id$ */
/**
* Session Panel Element
*
*
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright 2006-2008, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2006-2008, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.debug_kit.views.elements
* @since
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
?>
<h2><?php __('Memory'); ?></h2>
<div class="current-mem-use">
<?php echo $toolbar->message(
__('Current Memory Use',true),
$number->toReadableSize(DebugKitDebugger::getMemoryUse())
);?>
</div>
<div class="peak-mem-use">
<?php
echo $toolbar->message(
__('Peak Memory Use', true),
$number->toReadableSize(DebugKitDebugger::getPeakMemoryUse())
);
?></div>

View File

@@ -0,0 +1,45 @@
<?php
/* SVN FILE: $Id$ */
/**
* Request Panel Element
*
*
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright 2006-2008, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2006-2008, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.debug_kit.views.elements
* @since
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
?>
<h2> <?php __('Request'); ?></h2>
<h4>Cake Params</h4>
<?php echo $toolbar->makeNeatArray($content['params']); ?>
<h4>$_GET</h4>
<?php echo $toolbar->makeNeatArray($content['get']); ?>
<h4>Cookie</h4>
<?php if (isset($content['cookie'])): ?>
<?php echo $toolbar->makeNeatArray($content['cookie']); ?>
<?php else: ?>
<p class="warning">To view Cookies, add CookieComponent to Controller
<?php endif; ?>
<h4><?php __('Current Route') ?></h4>
<?php echo $toolbar->makeNeatArray($content['currentRoute']); ?>

View File

@@ -0,0 +1,31 @@
<?php
/* SVN FILE: $Id$ */
/**
* Session Panel Element
*
*
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright 2006-2008, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2006-2008, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.debug_kit.views.elements
* @since
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
?>
<h2><?php __('Session'); ?></h2>
<?php echo $toolbar->makeNeatArray($content); ?>

View File

@@ -0,0 +1,40 @@
<?php
/* SVN FILE: $Id$ */
/**
* Session Panel Element
*
*
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright 2006-2008, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2006-2008, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.debug_kit.views.elements
* @since
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
?>
<h2><?php __('Sql Logs')?></h2>
<?php if (!empty($content)) : ?>
<?php foreach ($content as $dbName => $queryLog) : ?>
<div class="sql-log-panel-query-log">
<h4><?php echo $dbName ?></h4>
<?php echo $queryLog; ?>
</div>
<?php endforeach; ?>
<?php else: ?>
<p class="warning"><?php __('No active database connections'); ?>
<?php endif; ?>

View File

@@ -0,0 +1,44 @@
<?php
/* SVN FILE: $Id$ */
/**
* Timer Panel Element
*
*
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright 2006-2008, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2006-2008, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.debug_kit.views.elements
* @since
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
$timers = DebugKitDebugger::getTimers();
?>
<h2><?php __('Timers'); ?></h2>
<p class="request-time">
<?php $totalTime = sprintf(__('%s (seconds)', true), $number->precision(DebugKitDebugger::requestTime(), 6)); ?>
<?php echo $toolbar->message(__('Total Request Time:', true), $totalTime)?>
</p>
<?php foreach ($timers as $timerName => $timeInfo):
$rows[] = array(
$timeInfo['message'],
$number->precision($timeInfo['time'], 6)
);
$headers = array(__('Message', true), __('time in seconds', true));
endforeach;
echo $toolbar->table($rows, $headers, array('title' => 'Timers')); ?>

View File

@@ -0,0 +1,35 @@
<?php
/* SVN FILE: $Id$ */
/**
* View Variables Panel Element
*
*
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright 2006-2008, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2006-2008, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.debug_kit.views.elements
* @since
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
?>
<h2> <?php __('View Variables'); ?></h2>
<?php
$vars = $this->viewVars;
unset($vars['debugToolbarPanels'], $vars['debugToolbarJavascript']);
?>
<?php echo $toolbar->makeNeatArray($vars); ?>

View File

@@ -0,0 +1,79 @@
<?php
/* SVN FILE: $Id$ */
/**
* FirePHP Toolbar Helper
*
* Injects the toolbar elements into non-HTML layouts via FireCake.
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright 2006-2008, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2006-2008, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package debug_kit
* @subpackage debug_kit.views.helpers
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
App::import('helper', 'DebugKit.Toolbar');
App::import('Vendor', 'DebugKit.FireCake');
class FirePhpToolbarHelper extends ToolbarHelper {
/**
* send method
*
* @return void
* @access protected
*/
function _send() {
$view =& ClassRegistry::getObject('view');
$view->element('debug_toolbar', array('plugin' => 'debug_kit', 'disableTimer' => true));
Configure::write('debug', 1);
}
/**
* makeNeatArray.
*
* wraps FireCake::dump() allowing panel elements to continue functioning
*
* @param string $values
* @return void
*/
function makeNeatArray($values) {
FireCake::info($values);
}
/**
* Create a simple message
*
* @param string $label Label of message
* @param string $message Message content
* @return void
*/
function message($label, $message) {
FireCake::log($message, $label);
}
/**
* Generate a table with FireCake
*
* @param array $rows Rows to print
* @param array $headers Headers for table
* @param array $options Additional options and params
* @return void
*/
function table($rows, $headers, $options = array()) {
$title = $headers[0];
if (isset($options['title'])) {
$title = $options['title'];
}
array_unshift($rows, $headers);
FireCake::table($title, $rows);
}
}
?>

View File

@@ -0,0 +1,150 @@
<?php
/* SVN FILE: $Id$ */
/**
* Html Toolbar Helper
*
* Injects the toolbar elements into HTML layouts.
* Contains helper methods for
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright 2006-2008, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2006-2008, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package debug_kit
* @subpackage debug_kit.views.helpers
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
App::import('helper', 'DebugKit.Toolbar');
class HtmlToolbarHelper extends ToolbarHelper {
/**
* helpers property
*
* @var array
* @access public
*/
var $helpers = array('Html', 'Javascript');
/**
* settings property
*
* @var array
* @access public
*/
var $settings = array('format' => 'html');
/**
* Recursively goes through an array and makes neat HTML out of it.
*
* @param mixed $values Array to make pretty.
* @param int $openDepth Depth to add open class
* @param int $currentDepth current depth.
* @return string
**/
function makeNeatArray($values, $openDepth = 0, $currentDepth = 0) {
$className ="neat-array depth-$currentDepth";
if ($openDepth > $currentDepth) {
$className .= ' expanded';
}
$nextDepth = $currentDepth + 1;
$out = "<ul class=\"$className\">";
if (!is_array($values)) {
if (is_bool($values)) {
$values = array($values);
}
if (is_null($values)) {
$values = array(null);
}
}
foreach ($values as $key => $value) {
$out .= '<li><strong>' . $key . '</strong>';
if ($value === null) {
$value = '(null)';
}
if ($value === false) {
$value = '(false)';
}
if ($value === true) {
$value = '(true)';
}
if (empty($value) && $value != 0) {
$value = '(empty)';
}
if (is_object($value)) {
$value = Set::reverse($value, true);
}
if (is_array($value) && !empty($value)) {
$out .= $this->makeNeatArray($value, $openDepth, $nextDepth);
} else {
$out .= $value;
}
$out .= '</li>';
}
$out .= '</ul>';
return $out;
}
/**
* Create an HTML message
*
* @param string $label label content
* @param string $message message content
* @return string
*/
function message($label, $message) {
return sprintf('<p><strong>%s</strong> %s</p>', $label, $message);
}
/**
* Create a table.
*
* @param array $rows Rows to make.
* @param array $headers Optional header row.
* @return string
*/
function table($rows, $headers = array()) {
$out = '<table class="debug-table">';
if (!empty($headers)) {
$out .= $this->Html->tableHeaders($headers);
}
$out .= $this->Html->tableCells($rows, array('class' => 'odd'), array('class' => 'even'));
$out .= '</table>';
return $out;
}
/**
* send method
*
* @return void
* @access protected
*/
function _send() {
if (Configure::read('debug') == 0) {
return;
}
$view =& ClassRegistry::getObject('view');
$head = $this->Html->css('/debug_kit/css/debug_toolbar');
if (isset($view->viewVars['debugToolbarJavascript'])) {
foreach ($view->viewVars['debugToolbarJavascript'] as $script) {
if ($script) {
$head .= $this->Javascript->link($script);
}
}
}
if (preg_match('#</head>#', $view->output)) {
$view->output = preg_replace('#</head>#', $head . "\n</head>", $view->output, 1);
}
$toolbar = $view->element('debug_toolbar', array('plugin' => 'debug_kit', 'disableTimer' => true));
if (preg_match('#</body>#', $view->output)) {
$view->output = preg_replace('#</body>#', $toolbar . "\n</body>", $view->output, 1);
}
}
}
?>

View File

@@ -0,0 +1,90 @@
<?php
/* SVN FILE: $Id$ */
/**
* Abstract Toolbar helper. Provides Base methods for content
* specific debug toolbar helpers. Acts as a facade for other toolbars helpers as well.
*
* helps with development.
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright 2006-2008, Cake Software Foundation, Inc.
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2006-2008, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package debug_kit
* @subpackage debug_kit.views.helpers
* @since v 1.0
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
App::import('Vendor', 'DebugKit.DebugKitDebugger');
class ToolbarHelper extends AppHelper {
/**
* settings property to be overloaded. Subclasses should specify a format
*
* @var array
* @access public
*/
var $settings = array();
/**
* Construct the helper and make the backend helper.
*
* @param string $options
* @access public
* @return void
*/
function __construct($options = array()) {
$this->_myName = strtolower(get_class($this));
if ($this->_myName !== 'toolbarhelper') {
return;
}
if (!isset($options['output'])) {
$options['output'] = 'DebugKit.HtmlToolbar';
}
App::import('Helper', $options['output']);
$className = $options['output'];
if (strpos($options['output'], '.') !== false) {
list($plugin, $className) = explode('.', $options['output']);
}
$this->_backEndClassName = $className;
$this->helpers = array($options['output']);
}
/**
* call__
*
* Allows method calls on backend helper
*
* @param string $method
* @param mixed $params
* @access public
* @return void
*/
function call__($method, $params) {
if (method_exists($this->{$this->_backEndClassName}, $method)) {
return $this->{$this->_backEndClassName}->dispatchMethod($method, $params);
}
}
/**
* postRender method
*
* Custom Callback defined in DebugView to allow helpers to modify
* View output after all rendering is complete.
*
* @return void
* @access public
*/
function postRender() {
$this->_send();
}
}