tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #3266 from tractorcow/pulls/3.1/debug-view

Browse Source 
API Debug::dump in CLI no longer generates HTML. Uses colours.
This commit is contained in:
Sean Harvey 2014-07-05 14:48:00 +12:00
commit 7e45980530
3 changed files with 69 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
dev/CliDebugView.php
View File

@ -41,7 +41,7 @@ class CliDebugView extends DebugView {
foreach($lines as $offset => $line) { foreach($lines as $offset => $line) {
echo ($offset == $errline) ? "* " : " "; echo ($offset == $errline) ? "* " : " ";
echo str_pad("$offset:",5); echo str_pad("$offset:",5);
echo wordwrap($line, 100, "\n "); echo wordwrap($line, self::config()->columns, "\n ");
} }
echo "\n"; echo "\n";
} }
@ -61,11 +61,25 @@ class CliDebugView extends DebugView {
* @param string $title * @param string $title
*/ */
public function writeInfo($title, $subtitle, $description=false) { public function writeInfo($title, $subtitle, $description=false) {
echo wordwrap(strtoupper($title),100) . "\n"; echo wordwrap(strtoupper($title),self::config()->columns) . "\n";
echo wordwrap($subtitle,100) . "\n"; echo wordwrap($subtitle,self::config()->columns) . "\n";
echo str_repeat('-',min(100,max(strlen($title),strlen($subtitle)))) . "\n"; echo str_repeat('-',min(self::config()->columns,max(strlen($title),strlen($subtitle)))) . "\n";
echo wordwrap($description,100) . "\n\n"; echo wordwrap($description,self::config()->columns) . "\n\n";
} }
public function writeVariable($val, $caller) {
echo PHP_EOL;
echo SS_Cli::text(str_repeat('=', self::config()->columns), 'green');
echo PHP_EOL;
echo SS_Cli::text($this->formatCaller($caller), 'blue', null, true);
echo PHP_EOL.PHP_EOL;
if (is_string($val)) {
print_r(wordwrap($val, self::config()->columns));
} else {
print_r($val);
}
echo PHP_EOL;
echo SS_Cli::text(str_repeat('=', self::config()->columns), 'green');
echo PHP_EOL;
}
} }

20
dev/Debug.php
View File

@ -71,6 +71,11 @@ class Debug {
} }
/**
* Returns the caller for a specific method
*
* @return array
*/
public static function caller() { public static function caller() {
$bt = debug_backtrace(); $bt = debug_backtrace();
$caller = $bt[2]; $caller = $bt[2];
@ -102,12 +107,7 @@ class Debug {
* @param mixed $val * @param mixed $val
*/ */
public static function dump($val) { public static function dump($val) {
echo '<pre style="background-color:#ccc;padding:5px;font-size:14px;line-height:18px;">'; self::create_debug_view()->writeVariable($val, self::caller());
$caller = Debug::caller();
echo "<span style=\"font-size: 12px;color:#666;\">" . basename($caller['file']) . ":$caller[line] - </span>\n";
if (is_string($val)) print_r(wordwrap($val, 100));
else print_r($val);
echo '</pre>';
} }
/** /**
@ -369,10 +369,14 @@ class Debug {
/** /**
* Create an instance of an appropriate DebugView object. * Create an instance of an appropriate DebugView object.
*
* @return DebugView
*/ */
public static function create_debug_view() { public static function create_debug_view() {
if(Director::is_cli() || Director::is_ajax()) return new CliDebugView(); $service = Director::is_cli() || Director::is_ajax()
else return new DebugView(); ? 'CliDebugView'
: 'DebugView';
return Injector::inst()->get($service);
} }
/** /**

37
dev/DebugView.php
View File

@ -13,6 +13,14 @@
*/ */
class DebugView extends Object { class DebugView extends Object {
/**
* Column size to wrap long strings to
*
* @var int
* @config
*/
private static $columns = 100;
protected static $error_types = array( protected static $error_types = array(
E_USER_ERROR => array( E_USER_ERROR => array(
'title' => 'User Error', 'title' => 'User Error',
@ -180,5 +188,32 @@ class DebugView extends Object {
public function writeParagraph($text) { public function writeParagraph($text) {
echo '<p class="info">' . $text . '</p>'; echo '<p class="info">' . $text . '</p>';
} }
}
/**
* Formats the caller of a method
*
* @param array $caller
* @return string
*/
protected function formatCaller($caller) {
$return = basename($caller['file']) . ":" . $caller['line'];
if(!empty($caller['class']) && !empty($caller['function'])) {
$return .= " - {$caller['class']}::{$caller['function']}()";
}
return $return;
}
/**
* Outputs a variable in a user presentable way
*
* @param object $val
* @param array $caller Caller information
*/
public function writeVariable($val, $caller) {
echo '<pre style="background-color:#ccc;padding:5px;font-size:14px;line-height:18px;">';
echo "<span style=\"font-size: 12px;color:#666;\">" . $this->formatCaller($caller). " - </span>\n";
if (is_string($val)) print_r(wordwrap($val, self::config()->columns));
else print_r($val);
echo '</pre>';
}
}