Skip to content

Commit

Permalink
New Debugger::exportVar() formatting.
Browse files Browse the repository at this point in the history 
Better resembles var_dump().
Includes types, and is less noisy to read than before.
  • Loading branch information
@markstory
markstory committed Oct 20, 2011
1 parent 183ffb2 commit 49f687b
Show file tree
Hide file tree
Showing 2 changed files with 124 additions and 100 deletions.
97 changes: 53 additions & 44 deletions lib/Cake/Test/Case/Utility/DebuggerTest.php
View file
Expand Up @@ -295,33 +295,43 @@ public function testExportVar() {
$Controller = new Controller();
$Controller->helpers = array('Html', 'Form');
$View = new View($Controller);
$View->int = 2;
$View->float = 1.333;

$result = Debugger::exportVar($View);
$expected = 'View
View::$Helpers = HelperCollection object
View::$plugin = NULL
View::$name = ""
View::$passedArgs = array
View::$helpers = array
View::$viewPath = ""
View::$viewVars = array
View::$view = NULL
View::$layout = "default"
View::$layoutPath = NULL
View::$autoLayout = true
View::$ext = ".ctp"
View::$subDir = NULL
View::$theme = NULL
View::$cacheAction = false
View::$validationErrors = array
View::$hasRendered = false
View::$uuids = array
View::$output = false
View::$request = NULL
View::$elementCache = "default"';

$result = str_replace(array("\t", "\r\n", "\n"), "", $result);
$expected = str_replace(array("\t", "\r\n", "\n"), "", $expected);
$this->assertEqual($expected, $result);
$expected = <<<TEXT
object(View) {
Helpers => object(HelperCollection) {}
plugin => null
name => ''
passedArgs => array()
helpers => array(
(int) 0 => 'Html',
(int) 1 => 'Form'
)
viewPath => ''
viewVars => array()
view => null
layout => 'default'
layoutPath => null
autoLayout => true
ext => '.ctp'
subDir => null
theme => null
cacheAction => false
validationErrors => array()
hasRendered => false
uuids => array()
output => false
request => null
elementCache => 'default'
int => (int) 2
float => (float) 1.333
}
TEXT;
$result = str_replace(array("\r\n", "\n"), "", $result);
$expected = str_replace(array("\r\n", "\n"), "", $expected);
$this->assertEquals($expected, $result);
}

/**
Expand Down Expand Up @@ -357,23 +367,22 @@ public function testLog() {
*/
public function testDump() {
$var = array('People' => array(
array(
'name' => 'joeseph',
'coat' => 'technicolor',
'hair_color' => 'brown'
),
array(
'name' => 'Shaft',
'coat' => 'black',
'hair' => 'black'
)
)
);
array(
'name' => 'joeseph',
'coat' => 'technicolor',
'hair_color' => 'brown'
),
array(
'name' => 'Shaft',
'coat' => 'black',
'hair' => 'black'
)
));
ob_start();
Debugger::dump($var);
$result = ob_get_clean();
$expected = "<pre>array(\n\t\"People\" => array()\n)</pre>";
$this->assertEqual($expected, $result);
$expected = "<pre>array(\n\t'People' => array()\n)</pre>";
$this->assertEquals($expected, $result);
}

/**
Expand All @@ -383,16 +392,16 @@ public function testDump() {
*/
public function testGetInstance() {
$result = Debugger::getInstance();
$this->assertIsA($result, 'Debugger');
$this->assertInstanceOf('Debugger', $result);

$result = Debugger::getInstance('DebuggerTestCaseDebugger');
$this->assertIsA($result, 'DebuggerTestCaseDebugger');
$this->assertInstanceOf('DebuggerTestCaseDebugger', $result);

$result = Debugger::getInstance();
$this->assertIsA($result, 'DebuggerTestCaseDebugger');
$this->assertInstanceOf('DebuggerTestCaseDebugger', $result);

$result = Debugger::getInstance('Debugger');
$this->assertIsA($result, 'Debugger');
$this->assertInstanceOf('Debugger', $result);
}

/**
Expand Down
127 changes: 71 additions & 56 deletions lib/Cake/Utility/Debugger.php
View file
Expand Up @@ -419,8 +419,8 @@ public static function excerpt($file, $line, $context = 2) {
/**
* Converts a variable to a string for debug output.
*
* *Note:* The following keys will have their contents replaced with
* `*****`:
* *Note:* The following keys will have their contents
* replaced with `*****`:
*
* - password
* - login
Expand All @@ -434,93 +434,108 @@ public static function excerpt($file, $line, $context = 2) {
* shown in an error message if CakePHP is deployed in development mode.
*
* @param string $var Variable to convert
* @param integer $recursion
* @param integer $depth The depth to output to. Defaults to 2.
* @return string Variable as a formatted string
* @link http://book.cakephp.org/2.0/en/development/debugging.html#Debugger::exportVar
*/
public static function exportVar($var, $recursion = 0) {
switch (strtolower(gettype($var))) {
public static function exportVar($var, $depth = 3) {
return self::_export($var, $depth, 0);
}

protected static function _export($var, $depth, $indent) {
switch (self::getType($var)) {
case 'boolean':
return ($var) ? 'true' : 'false';
break;
case 'integer':
case 'double':
return $var;
return '(int) ' . $var;
case 'float':
return '(float) ' . $var;
break;
case 'string':
if (trim($var) == "") {
return '""';
if (trim($var) == '') {
return "''";
}
return '"' . h($var) . '"';
return "'" . h($var) . "'";
break;
case 'object':
return get_class($var) . "\n" . self::_object($var);
case 'array':
$var = array_merge($var, array_intersect_key(array(
'password' => '*****',
'login' => '*****',
'host' => '*****',
'database' => '*****',
'port' => '*****',
'prefix' => '*****',
'schema' => '*****'
), $var));

$out = "array(";
$vars = array();
foreach ($var as $key => $val) {
if ($recursion >= 0) {
if (is_numeric($key)) {
$vars[] = "\n\t" . self::exportVar($val, $recursion - 1);
} else {
$vars[] = "\n\t" . self::exportVar($key, $recursion - 1)
. ' => ' . self::exportVar($val, $recursion - 1);
}
}
}
$n = null;
if (!empty($vars)) {
$n = "\n";
}
return $out . implode(",", $vars) . "{$n})";
return self::_array($var, $depth - 1, $indent + 1);
break;
case 'resource':
return strtolower(gettype($var));
break;
case 'null':
return 'null';
default:
return self::_object($var, $depth - 1, $indent + 1);
break;
}
}

/**
* Export an array type object. Filters out keys used in datasource configuration.
*
* @param array $var The array to export.
* @param integer $depth The current depth, used for recursion tracking.
* @return string Exported array.
*/
protected static function _array(array $var, $depth, $indent) {
$var = array_merge($var, array_intersect_key(array(
'password' => '*****',
'login' => '*****',
'host' => '*****',
'database' => '*****',
'port' => '*****',
'prefix' => '*****',
'schema' => '*****'
), $var));

$out = "array(";
$n = $break = $end = null;
if (!empty($var)) {
$n = "\n";
$break = "\n" . str_repeat("\t", $indent);
$end = "\n" . str_repeat("\t", $indent - 1);
}
$vars = array();

if ($depth >= 0) {
foreach ($var as $key => $val) {
$vars[] = $break . self::exportVar($key) .
' => ' .
self::_export($val, $depth - 1, $indent);
}
}
return $out . implode(',', $vars) . $end . ')';
}

/**
* Handles object to string conversion.
*
* @param string $var Object to convert
* @param integer $depth The current depth, used for tracking recursion.
* @return string
* @see Debugger::exportVar()
*/
protected static function _object($var) {
$out = array();

if (is_object($var)) {
$className = get_class($var);
protected static function _object($var, $depth, $indent) {
$out = '';
$props = array();

$className = get_class($var);
$out .= 'object(' . $className . ') {';

if ($depth > 0) {
$end = "\n" . str_repeat("\t", $indent - 1);
$break = "\n" . str_repeat("\t", $indent);
$objectVars = get_object_vars($var);

foreach ($objectVars as $key => $value) {
if (is_object($value)) {
$value = get_class($value) . ' object';
} elseif (is_array($value)) {
$value = 'array';
} elseif ($value === null) {
$value = 'NULL';
} elseif (in_array(gettype($value), array('boolean', 'integer', 'double', 'string', 'array', 'resource'))) {
$value = Debugger::exportVar($value);
}
$out[] = "$className::$$key = " . $value;
$value = self::_export($value, $depth - 1, $indent);
$props[] = "$key => " . $value;
}
$out .= $break . implode($break, $props) . $end;
}
return implode("\n", $out);
$out .= '}';
return $out;
}

/**
Expand Down

0 comments on commit 49f687b

Please sign in to comment.