Projects / Debug Kit

diff --git a/controllers/components/toolbar.php b/controllers/components/toolbar.php index f833292..6e1dbc6 100644 --- a/controllers/components/toolbar.php +++ b/controllers/components/toolbar.php @@ -19,21 +19,18 @@ **/ class ToolbarComponent extends Object { var $settings = array(); - /** * Controller instance reference * * @var object */ var $controller; - /** * Components used by DebugToolbar * * @var array */ var $components = array('RequestHandler'); - /** * The default panels the toolbar uses. * which panels are used can be configured when attaching the component @@ -41,14 +38,12 @@ class ToolbarComponent extends Object { * @var array */ var $_defaultPanels = array('history', 'session', 'request', 'sqlLog', 'timer', 'log', 'variables'); - /** * Loaded panel objects. * * @var array */ var $panels = array(); - /** * javascript files component will be using * @@ -57,21 +52,18 @@ class ToolbarComponent extends Object { var $javascript = array( 'behavior' => '/debug_kit/js/js_debug_toolbar' ); - /** * CacheKey used for the cache file. * * @var string **/ var $cacheKey = 'toolbar_cache'; - /** * Duration of the debug kit history cache * * @var string **/ var $cacheDuration = '+4 hours'; - /** * initialize * @@ -107,7 +99,6 @@ class ToolbarComponent extends Object { $this->controller =& $controller; return false; } - /** * Go through user panels and remove default panels as indicated. * @@ -129,7 +120,6 @@ class ToolbarComponent extends Object { } return $panels; } - /** * Component Startup * @@ -162,7 +152,6 @@ class ToolbarComponent extends Object { DebugKitDebugger::stopTimer('componentInit'); DebugKitDebugger::startTimer('controllerAction', __d('debug_kit', 'Controller Action', true)); } - /** * beforeRedirect callback * @@ -176,7 +165,6 @@ class ToolbarComponent extends Object { $vars = $this->_gatherVars($controller); $this->_saveState($controller, $vars); } - /** * beforeRender callback * @@ -192,7 +180,6 @@ class ToolbarComponent extends Object { $controller->set(array('debugToolbarPanels' => $vars, 'debugToolbarJavascript' => $this->javascript)); DebugKitDebugger::startTimer('controllerRender', __d('debug_kit', 'Render Controller Action', true)); } - /** * Load a toolbar state from cache * @@ -206,7 +193,6 @@ class ToolbarComponent extends Object { } return array(); } - /** * Create the cache config for the history * @@ -218,7 +204,6 @@ class ToolbarComponent extends Object { Cache::config('debug_kit', array('duration' => $this->cacheDuration, 'engine' => 'File')); } } - /** * collects the panel contents * @@ -244,7 +229,6 @@ class ToolbarComponent extends Object { } return $vars; } - /** * Load Panels used in the debug toolbar * @@ -267,7 +251,6 @@ class ToolbarComponent extends Object { } } } - /** * Makes the DoppleGangerView class if it doesn't already exist. * This allows DebugView to be compatible with all view classes. @@ -289,7 +272,6 @@ class ToolbarComponent extends Object { $this->_eval($class); } } - /** * Method wrapper for eval() for testing uses. * @@ -298,7 +280,6 @@ class ToolbarComponent extends Object { function _eval($code) { eval($code); } - /** * Save the current state of the toolbar varibles to the cache file. * @@ -333,21 +314,18 @@ class ToolbarComponent extends Object { * @package cake.debug_kit */ class DebugPanel extends Object { - /** * Defines which plugin this panel is from so the element can be located. * * @var string */ var $plugin = null; - /** * Defines the title for displaying on the toolbar. * * @var string */ var $title = null; - /** * startup the panel * @@ -357,7 +335,6 @@ class DebugPanel extends Object { * @return void **/ function startup(&$controller) { } - /** * Prepare output vars before Controller Rendering. * @@ -376,14 +353,12 @@ class DebugPanel extends Object { **/ class HistoryPanel extends DebugPanel { var $plugin = 'debug_kit'; - /** * Number of history elements to keep * * @var string **/ var $history = 5; - /** * Constructor * @@ -395,7 +370,6 @@ class HistoryPanel extends DebugPanel { $this->history = $settings['history']; } } - /** * beforeRender callback function * @@ -440,7 +414,6 @@ class HistoryPanel extends DebugPanel { **/ class VariablesPanel extends DebugPanel { var $plugin = 'debug_kit'; - /** * beforeRender callback * @@ -460,7 +433,6 @@ class VariablesPanel extends DebugPanel { **/ class SessionPanel extends DebugPanel { var $plugin = 'debug_kit'; - /** * beforeRender callback * @@ -483,7 +455,6 @@ class SessionPanel extends DebugPanel { **/ class RequestPanel extends DebugPanel { var $plugin = 'debug_kit'; - /** * beforeRender callback - grabs request params * @@ -510,7 +481,6 @@ class RequestPanel extends DebugPanel { **/ class TimerPanel extends DebugPanel { var $plugin = 'debug_kit'; - /** * startup - add in necessary helpers * @@ -535,7 +505,6 @@ class TimerPanel extends DebugPanel { **/ class SqlLogPanel extends DebugPanel { var $plugin = 'debug_kit'; - /** * Minimum number of Rows Per Millisecond that must be returned by a query before an explain * is done. @@ -543,7 +512,6 @@ class SqlLogPanel extends DebugPanel { * @var int **/ var $slowRate = 20; - /** * Get Sql Logs for each DB config * @@ -596,7 +564,6 @@ class SqlLogPanel extends DebugPanel { } return $queryLogs; } - /** * get cell values from xml * @@ -614,7 +581,6 @@ class SqlLogPanel extends DebugPanel { } return $tds; } - /** * Run an explain query for a slow query. * @@ -655,14 +621,12 @@ class SqlLogPanel extends DebugPanel { */ class LogPanel extends DebugPanel { var $plugin = 'debug_kit'; - /** * Log files to scan * * @var array */ var $logFiles = array('error.log', 'debug.log'); - /** * startup * @@ -673,7 +637,6 @@ class LogPanel extends DebugPanel { App::import('Core', 'Log'); } } - /** * beforeRender Callback * @@ -692,7 +655,6 @@ class LogPanel extends DebugPanel { } return $out; } - /** * parse a log file and find the relevant entries * diff --git a/controllers/toolbar_access_controller.php b/controllers/toolbar_access_controller.php index b0e988f..2b11d59 100644 --- a/controllers/toolbar_access_controller.php +++ b/controllers/toolbar_access_controller.php @@ -20,21 +20,18 @@ * @license MIT License (http://www.opensource.org/licenses/mit-license.php) **/ class ToolbarAccessController extends DebugKitAppController { - /** * name * * @var string */ var $name = 'ToolbarAccess'; - /** * uses array * * @var array **/ var $uses = array(); - /** * Helpers * @@ -44,14 +41,12 @@ class ToolbarAccessController extends DebugKitAppController { 'DebugKit.Toolbar' => array('output' => 'DebugKit.HtmlToolbar'), 'Javascript', 'Number', 'DebugKit.SimpleGraph' ); - /** * components * * @var array **/ - var $components = array('RequestHandler'); - + var $components = array('RequestHandler', 'DebugKit.Toolbar'); /** * beforeFilter callback * @@ -65,7 +60,6 @@ class ToolbarAccessController extends DebugKitAppController { $this->helpers['DebugKit.Toolbar']['cacheKey'] = $this->Toolbar->cacheKey; $this->helpers['DebugKit.Toolbar']['cacheConfig'] = 'debug_kit'; } - /** * Get a stored history state from the toolbar cache. * diff --git a/tests/cases/controllers/components/toolbar.test.php b/tests/cases/controllers/components/toolbar.test.php index 314e058..94dbc09 100644 --- a/tests/cases/controllers/components/toolbar.test.php +++ b/tests/cases/controllers/components/toolbar.test.php @@ -82,7 +82,6 @@ class DebugToolbarTestCase extends CakeTestCase { $this->_paths['controller'] = Configure::read('controllerPaths'); Configure::write('Cache.disable', false); } - /** * endTest * @@ -101,7 +100,6 @@ class DebugToolbarTestCase extends CakeTestCase { DebugKitDebugger::clearTimers(); } } - /** * find the debug_kit path * @@ -131,7 +129,6 @@ class DebugToolbarTestCase extends CakeTestCase { $this->expectError(); $this->Controller->Toolbar->loadPanels(array('randomNonExisting', 'request')); } - /** * test Loading of panel classes from a plugin * @@ -141,7 +138,6 @@ class DebugToolbarTestCase extends CakeTestCase { $this->Controller->Toolbar->loadPanels(array('plugin.test')); $this->assertTrue(is_a($this->Controller->Toolbar->panels['plugin.test'], 'TestPanel')); } - /** * test generating a DoppelGangerView with a pluginView. * @@ -154,7 +150,6 @@ class DebugToolbarTestCase extends CakeTestCase { $this->Controller->Toolbar->startup($this->Controller); $this->assertPattern('/class DoppelGangerView extends OtherView/', $this->Controller->Toolbar->evalCode); } - /** * test loading of vendor panels from test_app folder * @@ -180,7 +175,6 @@ class DebugToolbarTestCase extends CakeTestCase { $this->assertTrue(isset($this->Controller->Toolbar->panels['test'])); $this->assertTrue(is_a($this->Controller->Toolbar->panels['test'], 'TestPanel')); } - /** * test initialize * @@ -197,7 +191,6 @@ class DebugToolbarTestCase extends CakeTestCase { $timers = DebugKitDebugger::getTimers(); $this->assertTrue(isset($timers['componentInit'])); } - /** * test initialize w/ custom panels and defaults * @@ -214,7 +207,6 @@ class DebugToolbarTestCase extends CakeTestCase { $expected = array('history', 'session', 'request', 'sqlLog', 'timer', 'log', 'variables', 'test'); $this->assertEqual($expected, array_keys($this->Controller->Toolbar->panels)); } - /** * test syntax for removing panels * @@ -230,7 +222,6 @@ class DebugToolbarTestCase extends CakeTestCase { $expected = array('request', 'sqlLog', 'timer', 'log', 'variables', 'test'); $this->assertEqual($expected, array_keys($this->Controller->Toolbar->panels)); } - /** * ensure that enabled = false when debug == 0 on initialize * @@ -246,7 +237,6 @@ class DebugToolbarTestCase extends CakeTestCase { Configure::write('debug', $_debug); } - /** * test that passing in forceEnable will enable the toolbar even if debug = 0 * @@ -288,7 +278,6 @@ class DebugToolbarTestCase extends CakeTestCase { $timers = DebugKitDebugger::getTimers(); $this->assertTrue(isset($timers['controllerAction'])); } - /** * Test that cache config generation works. * @@ -303,7 +292,6 @@ class DebugToolbarTestCase extends CakeTestCase { $results = Cache::config('debug_kit'); $this->assertTrue(is_array($results)); } - /** * test state saving of toolbar * @@ -324,7 +312,6 @@ class DebugToolbarTestCase extends CakeTestCase { $this->assertEqual($result[0]['variables']['content']['test'], 'testing'); Cache::delete('toolbar_history', $configName); } - /** * Test Before Render callback * @@ -353,7 +340,6 @@ class DebugToolbarTestCase extends CakeTestCase { ); $this->assertEqual($expected, $vars['session']); } - /** * test that vars are gathered and state is saved on beforeRedirect * @@ -383,7 +369,6 @@ class DebugToolbarTestCase extends CakeTestCase { $timers = DebugKitDebugger::getTimers(); $this->assertTrue(isset($timers['controllerAction'])); } - /** * test that loading state (accessing cache) works. * @@ -397,7 +382,6 @@ class DebugToolbarTestCase extends CakeTestCase { $result = $this->Controller->Toolbar->loadState(0); $this->assertEqual($result, $data[0]); } - /** * test the Log panel log reading. * @@ -428,7 +412,6 @@ class DebugToolbarTestCase extends CakeTestCase { $this->assertEqual(trim($result['content']['debug.log'][1]), 'Debug: This time in the debug log!'); $this->assertEqual(trim($result['content']['error.log'][1]), 'Error: This is a log I made this request'); } - /** * Test that history state urls set prefix = null and admin = null so generated urls do not * adopt these params. @@ -459,7 +442,6 @@ class DebugToolbarTestCase extends CakeTestCase { $this->assertEqual($result[0]['url'], $expected); Cache::delete('url_test', $configName); } - /** * Test that the FireCake toolbar is used on AJAX requests * @@ -473,7 +455,6 @@ class DebugToolbarTestCase extends CakeTestCase { $this->Controller->Component->startup($this->Controller); $this->assertEqual($this->Controller->helpers['DebugKit.Toolbar']['output'], 'DebugKit.FirePhpToolbar'); } - /** * Test that the toolbar does not interfere with requestAction * @@ -502,7 +483,6 @@ class DebugToolbarTestCase extends CakeTestCase { $result = $this->Controller->requestAction('/debug_kit_test/request_action_render', array('return')); $this->assertEqual($result, 'I have been rendered.'); } - /** * test the sqlLog panel parsing of db->showLog * diff --git a/tests/cases/vendors/debug_kit_debugger.test.php b/tests/cases/vendors/debug_kit_debugger.test.php index 939c0b0..427e3ef 100644 --- a/tests/cases/vendors/debug_kit_debugger.test.php +++ b/tests/cases/vendors/debug_kit_debugger.test.php @@ -90,7 +90,6 @@ class DebugKitDebuggerTest extends CakeTestCase { $this->assertTrue($timer['time'] > 0.0020); $this->assertEqual($timers[$expected]['message'], $expected); } - /** * Assert that nested anonymous timers don't get mixed up. * @@ -117,7 +116,6 @@ class DebugKitDebuggerTest extends CakeTestCase { $secondTimer = $timers[$file . ' line ' . $secondTimerLine]; $this->assertTrue($firstTimer['time'] > $secondTimer['time']); } - /** * test that calling startTimer with the same name does not overwrite previous timers * and instead adds new ones. @@ -143,7 +141,6 @@ class DebugKitDebuggerTest extends CakeTestCase { $this->assertEqual($timers['my timer']['message'], 'This is the first call'); $this->assertEqual($timers['my timer #2']['message'], 'This is the second call #2'); } - /** * testRequestTime * @@ -156,7 +153,6 @@ class DebugKitDebuggerTest extends CakeTestCase { $result2 = DebugKitDebugger::requestTime(); $this->assertTrue($result1 < $result2); } - /** * test getting all the set timers. * @@ -175,7 +171,6 @@ class DebugKitDebuggerTest extends CakeTestCase { $this->assertTrue(isset($timers['test1']['message'])); $this->assertTrue(isset($timers['test2']['message'])); } - /** * test memory usage * @@ -207,7 +202,6 @@ class DebugKitDebuggerTest extends CakeTestCase { Debugger::invoke(Debugger::getInstance('Debugger')); Debugger::output(); } - /** * tearDown method * diff --git a/tests/cases/views/debug.test.php b/tests/cases/views/debug.test.php index 613fbea..17e53cd 100644 --- a/tests/cases/views/debug.test.php +++ b/tests/cases/views/debug.test.php @@ -63,7 +63,6 @@ class DebugViewTestCase extends CakeTestCase { DebugKitDebugger::clearTimers(); Configure::write('debug', $this->_debug); } - /** * start Case - switch view paths * @@ -73,11 +72,10 @@ class DebugViewTestCase extends CakeTestCase { $this->_viewPaths = Configure::read('viewPaths'); Configure::write('viewPaths', array( TEST_CAKE_CORE_INCLUDE_PATH . 'tests' . DS . 'test_app' . DS . 'views'. DS, - APP . 'plugins' . DS . 'debug_kit' . DS . 'views'. DS, + APP . 'plugins' . DS . 'debug_kit' . DS . 'views'. DS, ROOT . DS . LIBS . 'view' . DS )); } - /** * test that element timers are working * @@ -90,7 +88,6 @@ class DebugViewTestCase extends CakeTestCase { $result = DebugKitDebugger::getTimers(); $this->assertTrue(isset($result['render_test_element.ctp'])); } - /** * test rendering and ensure that timers are being set. * @@ -111,14 +108,13 @@ class DebugViewTestCase extends CakeTestCase { $this->Controller->layout = 'default'; $View =& new DebugView($this->Controller, false); $View->render('index'); - + $result = DebugKitDebugger::getTimers(); $this->assertEqual(count($result), 4); $this->assertTrue(isset($result['viewRender'])); $this->assertTrue(isset($result['render_default.ctp'])); $this->assertTrue(isset($result['render_index.ctp'])); } - /** * Test for correct loading of helpers into custom view * @@ -143,7 +139,7 @@ class DebugViewTestCase extends CakeTestCase { $testapp = $plugins[1] . 'debug_kit' . DS . 'tests' . DS . 'test_app' . DS . 'views' . DS; array_unshift($views, $testapp); Configure::write('viewPaths', $views); - + $this->View->set('test', 'I have been rendered.'); $this->View->viewPath = 'debug_kit_test'; $this->View->layout = false; diff --git a/tests/cases/views/helpers/fire_php_toolbar.test.php b/tests/cases/views/helpers/fire_php_toolbar.test.php index 05147c0..dee6874 100644 --- a/tests/cases/views/helpers/fire_php_toolbar.test.php +++ b/tests/cases/views/helpers/fire_php_toolbar.test.php @@ -131,7 +131,6 @@ class FirePhpToolbarHelperTestCase extends CakeTestCase { function endCase() { Configure::write('viewPaths', $this->_viewPaths); } - /** * tearDown * diff --git a/tests/cases/views/helpers/toolbar.test.php b/tests/cases/views/helpers/toolbar.test.php index 1e2f925..dac7237 100644 --- a/tests/cases/views/helpers/toolbar.test.php +++ b/tests/cases/views/helpers/toolbar.test.php @@ -45,7 +45,6 @@ class ToolbarHelperTestCase extends CakeTestCase { Configure::write('debug', $this->_debug); } } - /** * start Case - switch view paths * @@ -60,7 +59,6 @@ class ToolbarHelperTestCase extends CakeTestCase { )); $this->_debug = Configure::read('debug'); } - /** * test cache writing for views. * @@ -70,7 +68,6 @@ class ToolbarHelperTestCase extends CakeTestCase { $result = $this->Toolbar->writeCache('test', array('stuff', 'to', 'cache')); $this->assertTrue($result); } - /** * Ensure that the cache writing only affects the * top most level of the history stack. As this is where the current request is stored. @@ -91,7 +88,6 @@ class ToolbarHelperTestCase extends CakeTestCase { $result = $this->Toolbar->readCache('test', 1); $this->assertEqual($result, array('second', 'values')); } - /** * test cache reading for views * @@ -110,7 +106,6 @@ class ToolbarHelperTestCase extends CakeTestCase { $result = $this->Toolbar->readCache('test'); $this->assertEqual($result, array('new', 'stuff'), 'Cache value is wrong %s'); } - /** * Test that reading/writing doesn't work with no cache config. * @@ -125,7 +120,6 @@ class ToolbarHelperTestCase extends CakeTestCase { $result = $this->Toolbar->readCache('test'); $this->assertFalse($result, 'Reading cache succeeded with no cache config %s'); } - /** * reset the view paths * @@ -134,8 +128,7 @@ class ToolbarHelperTestCase extends CakeTestCase { function endCase() { Configure::write('viewPaths', $this->_viewPaths); Cache::delete('debug_kit_toolbar_test_case', 'default'); - } - + }<p></p> /** * endTest * diff --git a/vendors/debug_kit_debugger.php b/vendors/debug_kit_debugger.php index 46f2b50..b2f7f1d 100644 --- a/vendors/debug_kit_debugger.php +++ b/vendors/debug_kit_debugger.php @@ -74,7 +74,6 @@ class DebugKitDebugger extends Debugger { } echo '</tbody></table>'; } - /** * Start an benchmarking timer. * @@ -117,7 +116,6 @@ class DebugKitDebugger extends Debugger { ); return true; } - /** * Stop a benchmarking timer. * @@ -158,7 +156,6 @@ class DebugKitDebugger extends Debugger { $_this->__benchmarks[$name]['end'] = $end; return true; } - /** * Get all timers that have been started and stopped. * Calculates elapsed time for each timer. If clear is true, will delete existing timers @@ -201,7 +198,6 @@ class DebugKitDebugger extends Debugger { } return $times; } - /** * Clear all existing timers * @@ -212,7 +208,6 @@ class DebugKitDebugger extends Debugger { $_this->__benchmarks = array(); return true; } - /** * Get the difference in time between the timer start and timer end. * @@ -228,7 +223,6 @@ class DebugKitDebugger extends Debugger { } return round($_this->__benchmarks[$name]['end'] - $_this->__benchmarks[$name]['start'], $precision); } - /** * Get the total execution time until this point * @@ -241,7 +235,6 @@ class DebugKitDebugger extends Debugger { $now = getMicroTime(); return ($now - $start); } - /** * get the time the current request started. * @@ -259,7 +252,6 @@ class DebugKitDebugger extends Debugger { } return $startTime; } - /** * get current memory usage * @@ -272,7 +264,6 @@ class DebugKitDebugger extends Debugger { } return memory_get_usage(); } - /** * Get peak memory use * @@ -285,7 +276,6 @@ class DebugKitDebugger extends Debugger { } return memory_get_peak_usage(); } - /** * Handles object conversion to debug string. * @@ -307,7 +297,6 @@ class DebugKitDebugger extends Debugger { echo parent::_output($level, $error, $code, $helpCode, $description, $file, $line, $kontext); } } - /** * Create a FirePHP error message * diff --git a/vendors/fire_cake.php b/vendors/fire_cake.php index 1f05e95..fd97324 100644 --- a/vendors/fire_cake.php +++ b/vendors/fire_cake.php @@ -31,7 +31,6 @@ if (!function_exists('firecake')) { } class FireCake extends Object { - /** * Options for FireCake. * @@ -39,7 +38,6 @@ class FireCake extends Object { * @var string */ var $options = array(); - /** * Default Options used in CakeFirePhp * @@ -52,7 +50,6 @@ class FireCake extends Object { 'useNativeJsonEncode' => true, 'includeLineNumbers' => true, ); - /** * Message Levels for messages sent via FirePHP * @@ -72,7 +69,6 @@ class FireCake extends Object { ); var $_version = '0.2.1'; - /** * internal messageIndex counter * @@ -80,28 +76,24 @@ class FireCake extends Object { * @access protected */ var $_messageIndex = 1; - /** * stack of objects encoded by stringEncode() * * @var array **/ var $_encodedObjects = array(); - /** * methodIndex to include in tracebacks when using includeLineNumbers * * @var array **/ var $_methodIndex = array('info', 'log', 'warn', 'error', 'table', 'trace'); - /** * FireCake output status * * @var bool **/ var $_enabled = true; - /** * get Instance of the singleton * @@ -124,7 +116,6 @@ class FireCake extends Object { } return $instance[0]; } - /** * setOptions * @@ -141,7 +132,6 @@ class FireCake extends Object { $_this->options = array_merge($_this->options, $options); } } - /** * Return boolean based on presence of FirePHP extension * @@ -155,7 +145,6 @@ class FireCake extends Object { } return true; } - /** * Get the Current UserAgent * @@ -166,7 +155,6 @@ class FireCake extends Object { function getUserAgent() { return env('HTTP_USER_AGENT'); } - /** * Disable FireCake output * All subsequent output calls will not be run. @@ -177,7 +165,6 @@ class FireCake extends Object { $_this =& FireCake::getInstance(); $_this->_enabled = false; } - /** * Enable FireCake output * @@ -187,7 +174,6 @@ class FireCake extends Object { $_this =& FireCake::getInstance(); $_this->_enabled = true; } - /** * Convenience wrapper for LOG messages * @@ -200,7 +186,6 @@ class FireCake extends Object { function log($message, $label = null) { FireCake::fb($message, $label, 'log'); } - /** * Convenience wrapper for WARN messages * @@ -213,7 +198,6 @@ class FireCake extends Object { function warn($message, $label = null) { FireCake::fb($message, $label, 'warn'); } - /** * Convenience wrapper for INFO messages * @@ -226,7 +210,6 @@ class FireCake extends Object { function info($message, $label = null) { FireCake::fb($message, $label, 'info'); } - /** * Convenience wrapper for ERROR messages * @@ -239,7 +222,6 @@ class FireCake extends Object { function error($message, $label = null) { FireCake::fb($message, $label, 'error'); } - /** * Convenience wrapper for TABLE messages * @@ -252,7 +234,6 @@ class FireCake extends Object { function table($label, $message) { FireCake::fb($message, $label, 'table'); } - /** * Convenience wrapper for DUMP messages * @@ -265,7 +246,6 @@ class FireCake extends Object { function dump($label, $message) { FireCake::fb($message, $label, 'dump'); } - /** * Convenience wrapper for TRACE messages * @@ -276,7 +256,6 @@ class FireCake extends Object { function trace($label) { FireCake::fb($label, 'trace'); } - /** * Convenience wrapper for GROUP messages * Messages following the group call will be nested in a group block @@ -288,7 +267,6 @@ class FireCake extends Object { function group($label) { FireCake::fb(null, $label, 'groupStart'); } - /** * Convenience wrapper for GROUPEND messages * Closes a group block @@ -300,7 +278,6 @@ class FireCake extends Object { function groupEnd() { FireCake::fb(null, null, 'groupEnd'); } - /** * fb - Send messages with FireCake to FirePHP * @@ -421,7 +398,6 @@ class FireCake extends Object { $_this->_sendHeader('X-Wf-1-Index', $_this->_messageIndex - 1); return true; } - /** * Parse a debug backtrace * @@ -450,7 +426,6 @@ class FireCake extends Object { } return $message; } - /** * Fix a trace for use in output * @@ -470,7 +445,6 @@ class FireCake extends Object { } return $trace; } - /** * Encode non string objects to string. * Filter out recursion, so no errors are raised by json_encode or $javascript->object() @@ -518,7 +492,6 @@ class FireCake extends Object { } return $return; } - /** * Encode an object into JSON * @@ -540,7 +513,6 @@ class FireCake extends Object { return FireCake::_jsonEncode($object); } } - /** * jsonEncode Helper method for PHP4 compatibility * @@ -560,7 +532,6 @@ class FireCake extends Object { } return $javascript->object($object); } - /** * Send Headers - write headers. * diff --git a/vendors/shells/benchmark.php b/vendors/shells/benchmark.php index e34a152..aa64231 100644 --- a/vendors/shells/benchmark.php +++ b/vendors/shells/benchmark.php @@ -31,13 +31,12 @@ * @todo Make calculated results round to leading significant digit position of std dev. */ class BenchmarkShell extends Shell { - - /** - * Main execution of shell - * - * @return void - * @access public - */ +/** + * Main execution of shell + * + * @return void + * @access public + */ function main() { if (empty($this->args) || count($this->args) > 1) { return $this->help(); @@ -61,18 +60,15 @@ class BenchmarkShell extends Shell { $times[] = $stop - $start; } - $this->_results($times); } - - - /** - * Prints calculated results - * - * @param array $times Array of time values - * @return void - * @access protected - */ +/** + * Prints calculated results + * + * @param array $times Array of time values + * @return void + * @access protected + */ function _results($times) { $duration = array_sum($times); $requests = count($times); @@ -102,21 +98,19 @@ class BenchmarkShell extends Shell { $this->out(""); } - - - /** - * One-pass, numerically stable calculation of population variance. - * - * Donald E. Knuth (1998). - * The Art of Computer Programming, volume 2: Seminumerical Algorithms, 3rd edn., - * p. 232. Boston: Addison-Wesley. - * - * @param array $times Array of values - * @param boolean $sample If true, calculates an unbiased estimate of the population - * variance from a finite sample. - * @return float Variance - * @access protected - */ +/** + * One-pass, numerically stable calculation of population variance. + * + * Donald E. Knuth (1998). + * The Art of Computer Programming, volume 2: Seminumerical Algorithms, 3rd edn., + * p. 232. Boston: Addison-Wesley. + * + * @param array $times Array of values + * @param boolean $sample If true, calculates an unbiased estimate of the population + * variance from a finite sample. + * @return float Variance + * @access protected + */ function _variance($times, $sample = true) { $n = $mean = $M2 = 0; @@ -131,24 +125,22 @@ class BenchmarkShell extends Shell { return $M2/$n; } - - /** - * Calculate the standard deviation. - * - * @param array $times Array of values - * @return float Standard deviation - * @access protected - */ +/** + * Calculate the standard deviation. + * + * @param array $times Array of values + * @return float Standard deviation + * @access protected + */ function _deviation($times, $sample = true) { return sqrt($this->_variance($times, $sample)); } - - /** - * Help for Benchmark shell - * - * @return void - * @access public - */ +/** + * Help for Benchmark shell + * + * @return void + * @access public + */ function help() { $this->out(__d('debug_kit', "DebugKit Benchmark Shell", true)); $this->out(""); diff --git a/views/debug.php b/views/debug.php index 7451109..3285b37 100644 --- a/views/debug.php +++ b/views/debug.php @@ -29,14 +29,12 @@ App::import('Component', 'DebugKit.Toolbar'); * @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 * @@ -60,7 +58,6 @@ class DebugView extends DoppelGangerView { } return $out; } - /** * Renders view for given action and layout. If $file is given, that is used * for a view filename (e.g. customFunkyView.ctp). @@ -88,7 +85,6 @@ class DebugView extends DoppelGangerView { 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() @@ -100,7 +96,6 @@ class DebugView extends DoppelGangerView { $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() @@ -112,7 +107,6 @@ class DebugView extends DoppelGangerView { $filename = parent::_getLayoutFileName($name); return $this->_replaceExtension($filename); } - /** * replace the Extension on a filename and set the temporary workaround extension. * diff --git a/views/helpers/simple_graph.php b/views/helpers/simple_graph.php index 3cec1e2..1655f48 100644 --- a/views/helpers/simple_graph.php +++ b/views/helpers/simple_graph.php @@ -22,14 +22,12 @@ App::import('Helper', 'Html'); class SimpleGraphHelper extends AppHelper { - /** * Helpers * * @var array */ var $helpers = array('Html'); - /** * Default settings to be applied to each Simple Graph * @@ -46,7 +44,6 @@ class SimpleGraphHelper extends AppHelper { 'width' => 250, 'valueType' => 'value', ); - /** * bar method * diff --git a/views/helpers/toolbar.php b/views/helpers/toolbar.php index 71be0d4..6c8e3e2 100644 --- a/views/helpers/toolbar.php +++ b/views/helpers/toolbar.php @@ -67,7 +67,6 @@ class ToolbarHelper extends AppHelper { $this->_cacheEnabled = true; } } - /** * Get the name of the backend Helper * used to conditionally trigger toolbar output @@ -92,7 +91,6 @@ class ToolbarHelper extends AppHelper { return $this->{$this->_backEndClassName}->dispatchMethod($method, $params); } } - /** * Allows for writing to panel cache from view. * Some panels generate all variables in the view by