'.implode("\n", $output).''; } /** * Returns an HTML string of information about a single variable. * * Borrows heavily on concepts from the Debug class of [Nette](http://nettephp.com/). * * @param mixed $value variable to dump * @param integer $length maximum length of strings * @param integer $level_recursion recursion limit * @return string */ public static function dump($value, $length = 128, $level_recursion = 10) { return Debug::_dump($value, $length, $level_recursion); } /** * Helper for Debug::dump(), handles recursion in arrays and objects. * * @param mixed $var variable to dump * @param integer $length maximum length of strings * @param integer $limit recursion limit * @param integer $level current recursion level (internal usage only!) * @return string */ protected static function _dump( & $var, $length = 128, $limit = 10, $level = 0) { if ($var === NULL) { return 'NULL'; } elseif (is_bool($var)) { return 'bool '.($var ? 'TRUE' : 'FALSE'); } elseif (is_float($var)) { return 'float '.$var; } elseif (is_resource($var)) { if (($type = get_resource_type($var)) === 'stream' AND $meta = stream_get_meta_data($var)) { $meta = stream_get_meta_data($var); if (isset($meta['uri'])) { $file = $meta['uri']; if (function_exists('stream_is_local')) { // Only exists on PHP >= 5.2.4 if (stream_is_local($file)) { $file = Debug::path($file); } } return 'resource('.$type.') '.htmlspecialchars($file, ENT_NOQUOTES, Kohana::$charset); } } else { return 'resource('.$type.')'; } } elseif (is_string($var)) { // Clean invalid multibyte characters. iconv is only invoked // if there are non ASCII characters in the string, so this // isn't too much of a hit. $var = UTF8::clean($var, Kohana::$charset); if (UTF8::strlen($var) > $length) { // Encode the truncated string $str = htmlspecialchars(UTF8::substr($var, 0, $length), ENT_NOQUOTES, Kohana::$charset).' …'; } else { // Encode the string $str = htmlspecialchars($var, ENT_NOQUOTES, Kohana::$charset); } return 'string('.strlen($var).') "'.$str.'"'; } elseif (is_array($var)) { $output = array(); // Indentation for this variable $space = str_repeat($s = ' ', $level); static $marker; if ($marker === NULL) { // Make a unique marker $marker = uniqid("\x00"); } if (empty($var)) { // Do nothing } elseif (isset($var[$marker])) { $output[] = "(\n$space$s*RECURSION*\n$space)"; } elseif ($level < $limit) { $output[] = "("; $var[$marker] = TRUE; foreach ($var as $key => & $val) { if ($key === $marker) continue; if ( ! is_int($key)) { $key = '"'.htmlspecialchars($key, ENT_NOQUOTES, Kohana::$charset).'"'; } $output[] = "$space$s$key => ".Debug::_dump($val, $length, $limit, $level + 1); } unset($var[$marker]); $output[] = "$space)"; } else { // Depth too great $output[] = "(\n$space$s...\n$space)"; } return 'array('.count($var).') '.implode("\n", $output); } elseif (is_object($var)) { // Copy the object as an array $array = (array) $var; $output = array(); // Indentation for this variable $space = str_repeat($s = ' ', $level); $hash = spl_object_hash($var); // Objects that are being dumped static $objects = array(); if (empty($var)) { // Do nothing } elseif (isset($objects[$hash])) { $output[] = "{\n$space$s*RECURSION*\n$space}"; } elseif ($level < $limit) { $output[] = "{"; $objects[$hash] = TRUE; foreach ($array as $key => & $val) { if ($key[0] === "\x00") { // Determine if the access is protected or protected $access = ''.(($key[1] === '*') ? 'protected' : 'private').''; // Remove the access level from the variable name $key = substr($key, strrpos($key, "\x00") + 1); } else { $access = 'public'; } $output[] = "$space$s$access $key => ".Debug::_dump($val, $length, $limit, $level + 1); } unset($objects[$hash]); $output[] = "$space}"; } else { // Depth too great $output[] = "{\n$space$s...\n$space}"; } return 'object '.get_class($var).'('.count($array).') '.implode("\n", $output); } else { return ''.gettype($var).' '.htmlspecialchars(print_r($var, TRUE), ENT_NOQUOTES, Kohana::$charset); } } /** * Removes application, system, modpath, or docroot from a filename, * replacing them with the plain text equivalents. Useful for debugging * when you want to display a shorter path. * * // Displays SYSPATH/classes/kohana.php * echo Debug::path(Kohana::find_file('classes', 'kohana')); * * @param string $file path to debug * @return string */ public static function path($file) { if (strpos($file, APPPATH) === 0) { $file = 'APPPATH'.DIRECTORY_SEPARATOR.substr($file, strlen(APPPATH)); } elseif (strpos($file, MODPATH) === 0) { $file = 'MODPATH'.DIRECTORY_SEPARATOR.substr($file, strlen(MODPATH)); } elseif (strpos($file, SYSPATH) === 0) { $file = 'SYSPATH'.DIRECTORY_SEPARATOR.substr($file, strlen(SYSPATH)); } elseif (strpos($file, SMDPATH) === 0) { $file = 'SMDPATH'.DIRECTORY_SEPARATOR.substr($file, strlen(SMDPATH)); } elseif (strpos($file, DOCROOT) === 0) { $file = 'DOCROOT'.DIRECTORY_SEPARATOR.substr($file, strlen(DOCROOT)); } return $file; } /** * Returns an HTML string, highlighting a specific line of a file, with some * number of lines padded above and below. * * // Highlights the current line of the current file * echo Debug::source(__FILE__, __LINE__); * * @param string $file file to open * @param integer $line_number line number to highlight * @param integer $padding number of padding lines * @return string source of file * @return FALSE file is unreadable */ public static function source($file, $line_number, $padding = 5) { if ( ! $file OR ! is_readable($file)) { // Continuing will cause errors return FALSE; } // Open the file and set the line position $file = fopen($file, 'r'); $line = 0; // Set the reading range $range = array('start' => $line_number - $padding, 'end' => $line_number + $padding); // Set the zero-padding amount for line numbers $format = '% '.strlen($range['end']).'d'; $source = ''; while (($row = fgets($file)) !== FALSE) { // Increment the line number if (++$line > $range['end']) break; if ($line >= $range['start']) { // Make the row safe for output $row = htmlspecialchars($row, ENT_NOQUOTES, Kohana::$charset); // Trim whitespace and sanitize the row $row = ''.sprintf($format, $line).' '.$row; if ($line === $line_number) { // Apply highlighting to this row $row = ''.$row.''; } else { $row = ''.$row.''; } // Add to the captured source $source .= $row; } } // Close the file fclose($file); return '
'.$source.'
'; } /** * Returns an array of HTML strings that represent each step in the backtrace. * * // Displays the entire current backtrace * echo implode('
', Debug::trace()); * * @param array $trace * @return string */ public static function trace(array $trace = NULL) { if ($trace === NULL) { // Start a new trace $trace = debug_backtrace(); } // Non-standard function calls $statements = array('include', 'include_once', 'require', 'require_once'); $output = array(); foreach ($trace as $step) { if ( ! isset($step['function'])) { // Invalid trace step continue; } if (isset($step['file']) AND isset($step['line'])) { // Include the source of this step $source = Debug::source($step['file'], $step['line']); } if (isset($step['file'])) { $file = $step['file']; if (isset($step['line'])) { $line = $step['line']; } } // function() $function = $step['function']; if (in_array($step['function'], $statements)) { if (empty($step['args'])) { // No arguments $args = array(); } else { // Sanitize the file path $args = array($step['args'][0]); } } elseif (isset($step['args'])) { if ( ! function_exists($step['function']) OR strpos($step['function'], '{closure}') !== FALSE) { // Introspection on closures or language constructs in a stack trace is impossible $params = NULL; } else { if (isset($step['class'])) { if (method_exists($step['class'], $step['function'])) { $reflection = new ReflectionMethod($step['class'], $step['function']); } else { $reflection = new ReflectionMethod($step['class'], '__call'); } } else { $reflection = new ReflectionFunction($step['function']); } // Get the function parameters $params = $reflection->getParameters(); } $args = array(); foreach ($step['args'] as $i => $arg) { if (isset($params[$i])) { // Assign the argument by the parameter name $args[$params[$i]->name] = $arg; } else { // Assign the argument by number $args[$i] = $arg; } } } if (isset($step['class'])) { // Class->method() or Class::method() $function = $step['class'].$step['type'].$step['function']; } $output[] = array( 'function' => $function, 'args' => isset($args) ? $args : NULL, 'file' => isset($file) ? $file : NULL, 'line' => isset($line) ? $line : NULL, 'source' => isset($source) ? $source : NULL, ); unset($function, $args, $file, $line, $source); } return $output; } }