Skip to content

Refactor #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Refactor #45

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3d1bd4d
Add a setting for base-path so that only the relevant parts of the fi…
okonomiyaki3000 Apr 1, 2014
60224bb
_log returns the class instance for method chaining
okonomiyaki3000 Apr 1, 2014
85f83f6
Hmm. No reason to get the instance again when we already have it, eh?
okonomiyaki3000 Apr 1, 2014
628eaee
use magic methods
okonomiyaki3000 Apr 1, 2014
0b3af50
Update the docblock return value, always return , use empty instead o…
okonomiyaki3000 Apr 1, 2014
706921f
change constant names everywhere
okonomiyaki3000 Apr 1, 2014
397dadf
use PHP_VERSION and version_compare() where appropriate
okonomiyaki3000 Apr 1, 2014
bcf1fd7
Merge branch 'version_compare' into refactor
okonomiyaki3000 Apr 2, 2014
dbaae94
fix merge issue
okonomiyaki3000 Apr 2, 2014
5016504
fix merge issue
okonomiyaki3000 Apr 2, 2014
0b29b2c
more refactoring
okonomiyaki3000 Apr 2, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
198 changes: 82 additions & 116 deletions ChromePhp.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,52 +41,47 @@ class ChromePhp
/**
* @var string
*/
const LOG = 'log';
const BASE_PATH = 'base_path';

/**
* @var string
*/
const WARN = 'warn';
const LOG_TYPE_LOG = 'log';

/**
* @var string
*/
const ERROR = 'error';
const LOG_TYPE_WARN = 'warn';

/**
* @var string
*/
const GROUP = 'group';
const LOG_TYPE_ERROR = 'error';

/**
* @var string
*/
const INFO = 'info';
const LOG_TYPE_GROUP = 'group';

/**
* @var string
*/
const GROUP_END = 'groupEnd';
const LOG_TYPE_INFO = 'info';

/**
* @var string
*/
const GROUP_COLLAPSED = 'groupCollapsed';
const LOG_TYPE_GROUP_END = 'groupEnd';

/**
* @var string
*/
const TABLE = 'table';
const LOG_TYPE_GROUP_COLLAPSED = 'groupCollapsed';

/**
* @var string
*/
protected $_php_version;

/**
* @var int
*/
protected $_timestamp;
const LOG_TYPE_TABLE = 'table';

/**
* @var array
Expand All @@ -111,7 +106,18 @@ class ChromePhp
* @var array
*/
protected $_settings = array(
self::BACKTRACE_LEVEL => 1
self::BACKTRACE_LEVEL => 1,
self::BASE_PATH => ''
);

/**
* Never print a backtrace for these log types
* @var array
*/
protected $_no_backtrace = array(
self::LOG_TYPE_GROUP,
self::LOG_TYPE_GROUP_END,
self::LOG_TYPE_GROUP_COLLAPSED
);

/**
Expand All @@ -131,8 +137,6 @@ class ChromePhp
*/
private function __construct()
{
$this->_php_version = phpversion();
$this->_timestamp = $this->_php_version >= 5.1 ? $_SERVER['REQUEST_TIME'] : time();
$this->_json['request_uri'] = $_SERVER['REQUEST_URI'];
}

Expand All @@ -150,128 +154,83 @@ public static function getInstance()
}

/**
* logs a variable to the console
*
* @param mixed $data,... unlimited OPTIONAL number of additional logs [...]
* @return void
*/
public static function log()
{
$args = func_get_args();
return self::_log('', $args);
}

/**
* logs a warning to the console
*
* @param mixed $data,... unlimited OPTIONAL number of additional logs [...]
* @return void
*/
public static function warn()
{
$args = func_get_args();
return self::_log(self::WARN, $args);
}

/**
* logs an error to the console
*
* @param mixed $data,... unlimited OPTIONAL number of additional logs [...]
* @return void
*/
public static function error()
{
$args = func_get_args();
return self::_log(self::ERROR, $args);
}

/**
* sends a group log
*
* @param string value
*/
public static function group()
{
$args = func_get_args();
return self::_log(self::GROUP, $args);
}

/**
* sends an info log
* Invoked when calling a static method that does not exist.
*
* @param mixed $data,... unlimited OPTIONAL number of additional logs [...]
* @return void
* @param string $name The name of the called method.
* @param array $args The aguments passed.
* @return ChromePhp The instance of ChromePhp (for method chaining)
*/
public static function info()
public static function __callStatic($name, $args)
{
$args = func_get_args();
return self::_log(self::INFO, $args);
}
$const = 'self::LOG_TYPE_' . self::_fromCamelCase($name);

/**
* sends a collapsed group log
*
* @param string value
*/
public static function groupCollapsed()
{
$args = func_get_args();
return self::_log(self::GROUP_COLLAPSED, $args);
if (defined($const))
{
return self::_log(constant($const), $args);
}
else
{
return self::getInstance();
}
}

/**
* ends a group log
* Invoked when calling a method that does not exist.
*
* @param string value
* @param string $name The name of the called method.
* @param array $args The aguments passed.
* @return ChromePhp The instance of ChromePhp (for method chaining)
*/
public static function groupEnd()
public function __call($name, $args)
{
$args = func_get_args();
return self::_log(self::GROUP_END, $args);
}
$const = 'self::LOG_TYPE_' . self::_fromCamelCase($name);

/**
* sends a table log
*
* @param string value
*/
public static function table()
{
$args = func_get_args();
return self::_log(self::TABLE, $args);
if (defined($const))
{
return self::_log(constant($const), $args);
}
else
{
return self::getInstance();
}
}

/**
* internal logging call
*
* @param string $type
* @return void
* @return ChromePhp
*/
protected static function _log($type, array $args)
{
$logger = self::getInstance();

// nothing passed in, don't do anything
if (count($args) == 0 && $type != self::GROUP_END) {
return;
if (empty($args) && $type != self::LOG_TYPE_GROUP_END) {
return $logger;
}

$logger = self::getInstance();

$logger->_processed = array();

$logs = array();
foreach ($args as $arg) {
$logs[] = $logger->_convert($arg);
}
$logs = array_map(array($logger, '_convert'), $args);

$backtrace = debug_backtrace(false);
$level = $logger->getSetting(self::BACKTRACE_LEVEL);
$basepath = $logger->getSetting(self::BASE_PATH);

$backtrace_message = 'unknown';
if (isset($backtrace[$level]['file']) && isset($backtrace[$level]['line'])) {
$backtrace_message = $backtrace[$level]['file'] . ' : ' . $backtrace[$level]['line'];
if (isset($backtrace[$level]['file'], $backtrace[$level]['line'])) {
$file = $backtrace[$level]['file'];

if ($basepath && strpos($file, $basepath) === 0) {
$file = substr($file, strlen($basepath));
}

$backtrace_message = $file . ' : ' . $backtrace[$level]['line'];
}

$logger->_addRow($logs, $backtrace_message, $type);

return $logger;
}

/**
Expand Down Expand Up @@ -318,7 +277,7 @@ protected function _convert($object)
}
$type = $this->_getPropertyKey($property);

if ($this->_php_version >= 5.3) {
if (version_compare(PHP_VERSION, '5.3') >= 0) {
$property->setAccessible(true);
}

Expand Down Expand Up @@ -375,17 +334,15 @@ protected function _addRow(array $logs, $backtrace, $type)

// for group, groupEnd, and groupCollapsed
// take out the backtrace since it is not useful
if ($type == self::GROUP || $type == self::GROUP_END || $type == self::GROUP_COLLAPSED) {
if (in_array($type, $this->_no_backtrace)) {
$backtrace = null;
}

if ($backtrace !== null) {
$this->_backtraces[] = $backtrace;
}

$row = array($logs, $backtrace, $type);

$this->_json['rows'][] = $row;
$this->_json['rows'][] = array($logs, $backtrace, $type);
$this->_writeHeader($this->_json);
}

Expand All @@ -405,6 +362,18 @@ protected function _encode($data)
return base64_encode(utf8_encode(json_encode($data)));
}

/**
* Converts a string from CamelCase to uppercase underscore
* Based on: http://stackoverflow.com/questions/1993721/how-to-convert-camelcase-to-camel-case#1993772
*
* @param string $input A string in CamelCase
* @return string
*/
function _fromCamelCase($input) {
preg_match_all('!([A-Z][A-Z0-9]*(?=$|[A-Z][a-z0-9])|[A-Za-z][a-z0-9]+)!', $input, $matches);
return implode('_', array_map('strtoupper', $matches[0]));
}

/**
* adds a setting
*
Expand Down Expand Up @@ -438,9 +407,6 @@ public function addSettings(array $settings)
*/
public function getSetting($key)
{
if (!isset($this->_settings[$key])) {
return null;
}
return $this->_settings[$key];
return isset($this->_settings[$key]) ? $this->_settings[$key] : null;
}
}