PHPDebugConsole + Error Handler v2.3 No more var_dump()

Overview & Usage

PHPDebugConsole is a browser/javascript like console class for PHP (logging, debugging, value inspecting, etc).

Quick Start

{
    "require": {
        "bdk/debug": "^2.3"
    }
}

require 'path-to/src/Debug/Autoloader.php';
$autoloader = new \bdk\Debug\Autoloader();
$autoloader->register();
// you can now instantiate Debug
$debug = new \bdk\Debug();

Usage

<?php
require __DIR__ . '/vendor/autoload.php';	// if installed via composer
// require 'path/to/Debug.php';   			// if not using composer

$debug = new \bdk\Debug(array(
	'collect' => true,
	'output' => true,
));

$debug->log('hello world');

Quality / Badges

require '/path/to/Debug.php'; // or via autoloader
$debug = new \bdk\Debug(array(
	'collect' => true,	// turn logging on
	'output' => true,	// if left false (default), the output() method will return null
));

/**
 * Example Class
 * Demonstrates PHP reflection and PHPDocBlock
 */
class Example
{
	private $offLimits = 'I\'m a private property';

	public function __toString()
	{
		return 'It\'s Magic';
	}

	/**
	 * Foo is a private method that does stuff
	 *
	 * @param string $bar the string you want to foo
	 *
	 * @return string the fooed string
	 */
	private function foo($bar)
	{
	}
}

$debug->alert('As told via example', 'success');
$debug->info('PHPDebugConsole is great!');
$debug->warn('No browser plugin necessary');
$debug->log('features/options', array(
	'PHP port of the javascript web console API',
	'outputOpts' => array(
		'HTML (as seen here)',
		'ChromeLogger',
		'FirePHP',
		'Plain-text / file / stream',
		'ServerLog',
		'<script>',
		'"plugin" (send log realtime via websockets, etc)',
	),
	'password protected',
	'errors (even fatal) are captured / logged / displayed',
	'send error notices via email, Discord, Slack, or Teams (throttled as to not to send out a flood of emails)',
	'send debug log via email',
));
$debug->log('%cStyling:%c as of v%.1f: %csupports <a target="_blank" href="%s">%s</a>',
	'border:1px outset rgba(0,0,0,.15); border-radius:.33em; background:linear-gradient(to bottom, #fefcea 0%, #f1da36 100%); color:#330; text-shadow: 1px 1px 1px rgba(255,255,255,0.4); font-size:1.3em; font-weight:bold; padding:2px .6em;',
	'', // empty css... essentially clearing previous styling
	2.0,
	'border:#000 solid 1px; box-shadow:2px 1px 0px 0px #999; background-color:rgba(0,0,0,.15); padding:2px .33em; display:inline-block; margin-bottom: .25em;',
	'https://console.spec.whatwg.org/#formatter',
	'styling and substitution',
	$debug->meta('sanitizeFirst', false)
);
$example = new Example();
$debug->log('example object', $example);
$debug->group('types are styled');
$debug->log(array(
	'string' => "<em>Strings</em><br />\r\n\tget visual\xc2\xa0whitespace&trade; and control-char highlighting (hover over the highlights).\r\n\tⅤersion 3.3 adds cօnfᴜsable char highlighting\x04",
	'boolean yea' => true,
	'boolean nay' => false,
	'int' => 7,
	'float' => 123.45,
	'null' => null,
	'timestamp (string)' => (string) time(),
	'numeric string' => '42',
));
$debug->groupEnd();
$debug->table(array(
	array('city' => 'Atlanta', 'state' => 'GA', 'population' => 472522,),
	array('city' => 'Buffalo', 'state' => 'NY', 'population' => 256902,),
	array('city' => 'Chicago', 'state' => 'IL', 'population' => 2704958,),
	array('city' => 'Denver', 'state' => 'CO', 'population' => 693060,),
	array('city' => 'Seattle', 'state' => 'WA', 'population' => 704352,),
	array('city' => 'Tulsa', 'state' => 'OK', 'population' => 403090,),
), 'Table - Click headings to sort');

Methods

Logging methods

Config & Utility methods

Configuration / Options

$debug = new \bdk\Debug(array(
    'key' => 'Joshua',
    'emailTo' => 'sfalken@wargames.com',
));

$debug->setCfg('key', 'Joshua');
$debug->setCfg('emailTo', 'sfalken@wargames.com');

general options

collect

false

Whether the debugger is "on" or not. When false, debug calls are essentially "no-op"

It is not necessary to explicitly set to true if using the key config setting

emailFrom

null

Specify From address

If non-null, will be passed to emailFunc in $additionalHeaders param.

PHP's mail() will default to value defined to php.ini's sendmail_from value

emailFunc

email

A callable that receives 4 parameters: $to, $subject, $body, & string $additionalHeaders

emailLog

false

Whether to email a debug log.

Values may be:

• false - log not sent
• 'onError' (or true) - log sent if there was an error masked by the errorHandler.emailMask config value
• 'always' - log always sent (if not otherwise output)

Log Viewer

requires collect to also be true
(we can't email what we don't collect)

emailTo

$_SERVER['SERVER_ADMIN']

Specify where to email logs and error reports

enableProfiling

false

If you will be using profile()/profileEnd() methods, you should set this to true as early as possible.

PHPDebugConsole will only be able to profile methods/functions that have been included/loaded after this has been set to true.

Under the hood: profile() works via PHP's register_tick_function(). This function requires a declare(ticks=1) statement in each file with code that will potentially be profiled… To achieve this requirement, PHPDebugConsole will register a stream wrapper (if/when both collect = true and enableProfiling = true). This streamWrapper will inject declare(ticks=1) on-the-fly. This is done when reading the files - no modification will be written.

See this "how to natively profile scripts" question on stackOverflow

ChangeLog:

• v2.3

file

null

If a valid filepath, log entries to the file. This will supplement the log that is output via output()

key

null

Set a "password/key" to enable/view debug info. This key should be passed to the page as a request parameter ($_GET['debug'] or $_COOKIE['debug']).

Example:
key set to "bosco":

• If we visit our page with the correct debug param (ie http://mysite.com/path/mypage.php?debug=bosco)
  collect will be set to true and
  output will be set to true
• If we don't pass the debug parameter, or pass the incorrect value, collect and output will both be set to false

key takes precedence over collect and output

logEnvInfo

array(
    'cookies' => true,
    'headers' => true,        // request headers
    'phpInfo' => true,        // PHP_VERSION, ini file locations, memoryLimit, etc
    'post' => true,           // $_POST (or request body), & $_FILES
    'serverVals' => true,     // $_SERVER values specified by logServerKeys
)

Specify "environment" information to automatically log.

Also accepts true (all), or false (none), or string[].

Example

Example Source

$debug = new \bdk\Debug(array(
	'collect' => true,
	'output' => true,
	'logEnvInfo' => true, // this is the default (all other examples use `false`)
));
$debug->info('Not all $_SERVER values are output -> only those included in `logServerKeys', $debug->meta('channel', 'php'));

Example Output

PHPDebugConsole

---

---

• Not all $_SERVER values are output -> only those included in `logServerKeys

---

• bdk\PubSub\Event

  extends

  bdk\PubSub\ValueStore

  implements

  • Serializable
  • JsonSerializable
  • ArrayAccess
  • IteratorAggregate
    • Traversable

  properties (via __debugInfo)

  protected Subject subject = bdk\Debug

  protected array<TKey,TValue> values = array()

  private bool propagationStopped = false

  methods

  public __construct(Subject $subject = null, array<TKey,TValue> $values = array())

  public __debugInfo(): array{ propagationStopped: bool, subject: class-string|mixed, values: array<TKey, TValue>, }

  public __serialize(): array<TKey,TValue>

  public __unserialize(array<TKey,TValue> $data): void

  public getIterator(): ArrayIterator<TKey,TValue>

  public getSubject(): Subject

  public getValue(TKey $key): TValue|null

  public getValues(): array<TKey,TValue>

  public hasValue(TKey $key): bool

  public isPropagationStopped(): bool

  public jsonSerialize(): array<TKey,TValue>

  public offsetExists(TKey $key): bool

  public offsetGet(TKey $key): TValue|null

  public offsetSet(TKey $offset, TValue $value): void

  public offsetUnset(TKey $key): void

  public serialize(): string

  public setValue(TKey $key, TValue $value): $this

  public setValues(array<TKey,TValue> $values = array()): $this

  public stopPropagation(): void

  public unserialize(string $data): void

  protected onSet(array<TKey,TValue> $values = array()): void

  phpDoc

  template: Subject of mixed

  template: TKey of array-key

  template: TValue of mixed

  template-extends: ValueStore<TKey, TValue>

This example includes example values
Click on the tabs in the "toolbar"

ChangeLog:

• v2.3: accepts array in addition to boolean
• v2.0

logServerKeys

array("DOCUMENT_ROOT","REMOTE_ADDR","REQUEST_TIME","REQUEST_URI","SERVER_ADDR","SERVER_NAME")

Specified $_SERVER values will be logged if logEnvInfo.serverVals == true

• HTTP_HOST will be included if logEnvInfo doesn't include "headers"
• CONTENT_LENGTH & CONTENT_TYPE will be included if applicable
• REQUEST_METHOD will be included if REQUEST_METHOD != 'GET'

ChangeLog:

• v2.0

onBootstrap

null

A callable to be invoked when debug instance is created.

If setting onBootstrap on an existing instance, it will be called immediately

ChangeLog:

• v2.0

onLog

null

• A callable to be invoked before entry added to log.
• Callback will receive a single param: \bdk\PubSub\Event $event.
• Shortcut for subscribing to debug.log event

ChangeLog:

• v2.0
• v2.0.1: replaces previous onLog value (rather than add additional subscriber)
• v3.0: callable receives a \bdk\Debug\LogEntry object (extends \bdk\PubSub\Event)

onOutput

null

• A callable to be invoked before log is output.
• Callback will receive a single param: \bdk\PubSub\Event $event.
• Shortcut for subscribing to debug.output event.
• Given default subscriber priority of 0 (will get called before log is output)
• Able to modify log, but not do post-output actions such as getHeaders()

ChangeLog:

• v2.0: passed param changed from (string) $outputAs to \bdk\PubSub\Event
• v2.0.1: replaces previous onOutput value (rather than add additional subscriber) (this is the pre v2.0 behavior)

output

false

Should output() actually output the log?

It is not necessary to explicitly set to true if using the key config setting

output related options

These options deal with how the log is output

outputAs

null

• With the default value (null), output will be determined based on request / response
  • "html" if non-ajax, Content-Type: html is being output
  • outputAsHonHtml for other http requests (which defaults to "chromeLogger")
  • "stream" from command line

• Options:

  chromeLogger

  • Outputs the log via special http headers.
  • Requires browser extension to view.
  • Details

  firephp

  • Outputs the log via special http headers
  • Requires browser extension to view.
  • Details

  html

  • Outputs the log as HTML, along with css and javascript

  script

  • Outputs the log as <script></script> containing console.xxx calls
  • Details

  text

  • Outputs the log as plain text
  • Details

  wamp

  • Sends logging in realtime to a WAMP router
  • works with ajax, CLI, html, API server, everything
  • True console-like logging.
  • "Advanced"
  • Details

  OTHER

  Any object implementing \bdk\Debug\PluginInterface

outputAsDefaultNonHtml

chromeLogger

If outputAs is null, this value will be used for http requests that are ajax or non-html response

outputHeaders

true

Should PHPDebugConsole output headers (ie, ChromeLogger, FirePHP, & ServerLog headers) on output?

ChangeLog:

• v3.0: output buffering automatically invoked if using route that outputs headers
• v2.3

html related options

addBR

false

Convert "\n" to "<br />\n" in strings?

• unnecessary if styling with white-space: pre (as base css does)

css

Supplemental CSS to output

filepathCss

./css/Debug.css

Filepath to base CSS.

• (need not be publicly accessible)

filepathScript

./js/Debug.jquery.min.js

Filepath to javascript to include.

• (need not be publicly accessible)

jqueryUrl

//ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js

Only loaded if window.jQuery is undefined

outputCss

true

Output filepathCss contents with the log?

outputScript

true

Output filepathScript contents with the log?

object logging & output options

These options deal specifically with debugging objects

objectsExclude

array("DOMNode","bdk\\Debug\\Abstraction","bdk\\Debug")

Array of classes that will not be recursed into if encountered as a property or array value

Object will be listed as ("(not inspected)")

objectSort

visibility

How to sort properties and methods.

Accepts "visibility", "name", or false|null

useDebugInfo

true

Whether to utilize object's __debugInfo magic method when debuging object

Although __debugInfo is introduced in PHP 5.6, PHPDebugConsole will call the method (if it exists) regardless of PHP version.

• if __debugInfo value differs from regular value, the property will be listed with icon .
• If the value came exclusively from __debugInfo, it will be listed with "debug" visibility

collectConstants

true

Whether to collect object constants

outputConstants

true

Whether to output object's constants

collectMethods

true

Whether to collect object methods, return types, parameter information, etc

outputMethods

true

Whether to output object's methods

cacheMethods

true

Whether PHPDebugConsole assumes all instances of a given class will have the same methods.

The need to disable this is extremely rare

outputMethodDescription

true

Whether to output method's long phpDoc description

errorEmailer options

• configure how error notifications are emailed
• this feature is disabled by default as of v3.0
• errors are only emailed if not captured by debugger (capture = false at time of error)
• errorEmailer options may be set via the Debug object for convenience

emailMask

E_ERROR | E_PARSE | E_COMPILE_ERROR | E_WARNING | E_USER_ERROR | E_USER_NOTICE

Specify which types of errors should send an email notice

emailMin

15

Number of minutes that must elapse before resending an email notice for unique errors

emailThrottleFile

__DIR__ . '/error_emails.json'

A file used to maintain details of recent errors.

See emailThrottleRead and emailThrottleWrite for custom read/write.

Warning: emailThrottleFile should be set to a path outside the document root or .htaccess should be configured to prevent access / return a 404

emailThrottleRead

callable

A callable that returns throttle data. If not specified, throttle data is read from emailThrottleFile.

ChangeLog:

• v2.1

emailThrottleWrite

callable

A callable that receives throttle data as a single param. If not specified, throttle data is written to emailThrottleFile.

ChangeLog:

• v2.1

emailThrottledSummary

true

Whether to send an email summary of throttled errors on trash-collection

emailTraceMask

E_ERROR | E_WARNING | E_USER_ERROR | E_USER_NOTICE

Specify which types of errors should include a backtrace

errorHandler options

• errorHandler options may be set via the Debug object for convenience

continueToPrevHandler

true

• PHP only supports one error handler defined at a time (our handler publishes a event / unlimited subscribers).
• If this is set true, this handler will pass the error off to the previously set handler (chaining).
• Stopping error event's propagation will also prevent continuation to prev handler

errorReporting

E_ALL | E_STRICT

What errors the errorHandler should handle.

Bitmask of error types (or "system", which will use the currently configured php value)

If we're not handling error and continueToPrevHandler is true, the error will be passed to prev handler (if there was one).

onEUserError

log

• This library changes the default behavior of E_USER_ERROR and E_RECOVERABLE_ERROR from terminate to continue
  Unless we're continuing to a previous error handler. In which case, this behavior will be dictated by prev handler.
• For default behavior, use the "normal" value

Using an error handler affects the behavior of E_USER_ERROR and E_RECOVERABLE_ERROR.

no custom error handler

treated as fatal / script terminates

custom error handler that returns false

treated as fatal / script terminates

custom error handler that does not return false

not treated fatal / script continues

This config option gives you control

If error is being passed to a previous error handler:

• We pass-the-buck & this option has no effect
• The behavior is controlled by the previous handler.

allowed values:

"continue"

• Script will continue
• Error will not be logged by PHP

"log"

(default)

• Script will continue
• Error will be logged if error event's propagation not stopped and if $error['continueToNormal'] == true

"normal"

Continue to "normal" error handler.
PHP will log error
Script will terminate.

null|false

Behavior based on the value of $error['continuetoNormal'].

• continueToNormal true: log the error
• continueToNormal false: continue without logging

See errorHandler.error event

ChangeLog:

• v2.1

onError

null

A callable to be invoked when error occurs.

• Shortcut for subscribing to errorHandler.error event
• Will also get called on fatal errors.
• Callback will receive a single param: \bdk\PubSub\Event $error

ChangeLog:

• v1.2: callable receives array of error info
• v2.0: callable receives a \bdk\PubSub\Event object
• v2.0.1: Replace previous onError value (2.0 added an additional subscriber)
• v3.0: callable receives a \bdk\ErrorHandler\Error object (extends \bdk\PubSub\Event)

Events

Version 2.0 introduces events (aka publish/subscribe) that allow allow you to extend PHPDebugConsole and/or create plugins.

debug.bootstrap

published when debug is instantiated

Primarily used internally. This event is published after the debug instance is created. This event can be subscribed to by passing the onBootstrap config option to the debug constructor. If the debug instance has already been instantiated, setting onBootstrap via setCfg will invoke the handler immediately.

debug.config

published when config is updated

• Call $event->getSubject() to get the debug object
• $event['config'] contains the changed config values

Changelog:

• v2.1 - 'config' value added
• v2.0

debug.log

published when a debug method is called

• Only published when "collect" is true

• Call $event->getSubject() to get the debug object
• $event['method'] contains the called debug method
• $event['args'] contains the arguments passed
• $event['meta'] contains meta information
• Call $event->stopPropagation() to prevent the log-entry from being logged

Custom methods

Create custom methods by subscribing to this event.

For example you can call $debug->myMethod("arg1") (which isn't a core method). Rather than error out, this event will be published (just as it is for core methods).

$event['meta']['isCustomMethod'] will exist with a value of true

This event "bubbles" up its ancestor channels.
Calling stopPropagation() will prevent this

Changelog:

• v3.0 - $event['appendLog'] instead of $event->stopPropagation() to control whether to log
• v2.1 - publish when calling inaccessible method (custom methods)
• v2.0

debug.objAbstractEnd

published after object is inspected

This event gives access to the object abstraction after the heavy lifting took place

subscribers to this event have complete control to modify the abstraction values:

Call $event->getSubject() to get the inspected object

This event "bubbles" up its ancestor channels.
Calling stopPropagation() will prevent this

debug.objAbstractStart

published before object is inspected

This event gives access to the object abstraction before the heavy lifting takes place

Subscribers to this event may:

• set `isExcluded`
• set `collectPropertyValues` (boolean)
• set `collectMethods` (boolean)
• set `propertyOverrideValues`
• set `stringified`
  set this value in lieu of a __toString method..
  example: DateTime objects don't have a __toString() method, so PHPDebugConsole uses its debug.objAbstractStart subscriber to set stringified to a human readable format
• set `traverseValues`

Call $event->getSubject() to get the object being inspected

This event "bubbles" up its ancestor channels.
Calling stopPropagation() will prevent this

Changelog:

• v2.3 - added `propertyOverrideValues`

debug.output

published when it's time to output the log

Published on current and all descendant channels

Subscriber with high priority can append log and modify the log before it's output

Subscriber with low priority modify the generated $event['output']

Call $event->getSubject() to get the debug instance

debug.outputLogEntry

For each enabled output plugin, published as each individual log entry is output

Use this event to customize how a particular method is displayed / or to handle custom methods (unhandled methods will be handled the same as a plain 'ol log() call).

• debug.log is published when you call a debug method.
• debug.outputLogEntry is published when that log entry is output

• Call $event->getSubject() to get debug instance
• Call $event->stopPropagation() to prevent the default output
• $event['method'] contains the called debug method
• $event['args'] contains the arguments passed
• $event['meta'] contains meta information
• $event['return'] = null set to non-null to override
• $event['route'] = output "plugin" instance (ie the OutputHtml object)

Changelog:

• v2.1.1 - add the return value
• v2.1

errorHandler.error

published when a php error occurs

• Call $event->getValues() to get all error info
• Call $event->stopPropagation() to prevent continuation to previous error handler

php.shutdown

Published when script execution finishes or exit() is called

Provided via our underlying event manager

This event is essentially a helper/wrapper for register_shutdown_function

Output "Plugins"

/**
 * Set up up debugger to output via Chromelogger for AJAX requests
 *    otherwise log will be output with html output
 */
require '/path/to/Debug.php'; // or via autoloader
$debug = new \bdk\Debug(array(
    // configure so that debug=example_password
    //   must be passed for log to be collected & output
    'key' => 'example_password',
    'routeNonHtml' => 'chromeLogger',
));
$debug->log("It's better than bad.  It's good!");
$debug->info("Info!");
$debug->warn("warning Will Robinson");
$debug->error("Does not compute");
$list = array(
    // note different order of keys / not all rows have all cols
    array('name'=>'Bob', 'age'=>'12', 'sex'=>'M', 'Naughty'=>false),
    array('Naughty'=>true, 'name'=>'Sally', 'extracol' => 'yes', 'sex'=>'F', 'age'=>'10'),
);
$debug->table('clever table caption', $list);
$debug->log('array', $list);
$debug->group('group');
$debug->log('inside the group');
echo $debug->getServerParam('HTTP_X_REQUESTED_WITH') === 'XMLHttpRequest'
    ? '<p>I was loaded via ajax.</p>'
    : '<p>I wasn\'t loaded via ajax</p>';
$debug->groupEnd();

/**
 * Output Content-Type header and image
 * Debug/Console will automatically be sent to chromeLogger
 */
require '/path/to/Debug.php'; // or via autoloader
$debug = new \bdk\Debug(array(
    // configure so that debug=example_password
    //    must be passed for log to be collected & output
    'key' => 'example_password',
    'routeNonHtml' => 'chromeLogger',
));
$debug->log("All kids love log");
$debug->info("Fits on your back.  It's great for a snack.");
$debug->warn("Rolls over your neighbor's dog");
$debug->error('disaster');
$list = array(
    // note different order of keys / not all rows have all cols
    array('name'=>'Bob', 'age'=>'12', 'sex'=>'M', 'Naughty'=>false),
    array('Naughty'=>true, 'name'=>'Sally', 'extracol' => 'yes', 'sex'=>'F', 'age'=>'10'),
);
$debug->table('table()', $list);
$debug->log('array', $list);
$debug->group('output image');
    $debug->log('generate/output image (image could be imagemagick, gd, database, whatever)');
    header('Content-Type: image/jpeg');
    $filepathImg = $_SERVER['DOCUMENT_ROOT'] . '/images/php/debug_example.jpg';
    readfile($filepathImg);
$debug->groupEnd();

/**
 * Set up debugger to output via FirePHP for AJAX requests
 *    otherwise log will be output with html
 */
require '/path/to/Debug.php'; // or via autoloader
$debug = new \bdk\Debug(array(
    // configure so that debug=example_password
    //   must be passed for log to be collected & output
    'key' => 'example_password',
    'routeNonHtml' => 'firephp',
));
$debug->log("It's better than bad.  It's good!");
$debug->info("Info!");
$debug->warn("warning Will Robinson");
$debug->error("Does not compute");
$list = array(
    // note different order of keys / not all rows have all cols
    array('name'=>'Bob', 'age'=>'12', 'sex'=>'M', 'Naughty'=>false),
    array('Naughty'=>true, 'name'=>'Sally', 'extracol' => 'yes', 'sex'=>'F', 'age'=>'10'),
);
$debug->table('clever table caption', $list);
$debug->log('array', $list);
$debug->group('group');
$debug->log('inside the group');
echo $debug->getServerParam('HTTP_X_REQUESTED_WITH') === 'XMLHttpRequest'
    ? '<p>I was loaded via ajax.</p>'
    : '<p>I wasn\'t loaded via ajax</p>';
if (strpos($_SERVER['HTTP_USER_AGENT'], 'FirePHP') !== false) {
    echo '<p>Debug output can be viewed with FirePHP extension</p>';
} else {
    echo '<p class="bs-callout bs-callout-warning bs-callout-sm text-warning">'
        . 'You do not appear to have FirePHP enabled <span class="text-muted">(or don\'t have it set to modify userAgent string)</span></p>';
}
$debug->groupEnd();

/**
 * Output Content-Type header and image
 * Debug/Console will automatically be sent to firePHP
 */
require '/path/to/Debug.php'; // or via autoloader
$debug = new \bdk\Debug(array(
    // configure so that debug=example_password
    //    must be passed for log to be collected & output
    'key' => 'example_password',
    'routeNonHtml' => 'firephp',
));
$debug->log("All kids love log");
$debug->info("Fits on your back.  It's great for a snack.");
$debug->warn("Rolls over your neighbor's dog");
$debug->error('error()');
$list = array(
    // note different order of keys / not all rows have all cols
    array('name'=>'Bob', 'age'=>'12', 'sex'=>'M', 'Naughty'=>false),
    array('Naughty'=>true, 'name'=>'Sally', 'extracol' => 'yes', 'sex'=>'F', 'age'=>'10'),
);
$debug->table('table()', $list);
$debug->log('array', $list);
$debug->group('output image');
    $debug->log('generate/output image (image could be imagemagick, gd, database, whatever)');
    header('Content-Type: image/jpeg');
    $filepathImg = strpos($_SERVER['HTTP_USER_AGENT'], 'FirePHP') !== false
        ? $_SERVER['DOCUMENT_ROOT'].'/images/php/debug_example.jpg'
        : $_SERVER['DOCUMENT_ROOT'].'/images/php/debug_example_no_firephp.jpg';
    readfile($filepathImg);
$debug->groupEnd();

PSR-3 Logger

If you're using a library that uses psr/log, or monolog/monolog, getting up and runniing with PHPDebugConsole couldn't be easier.

$debug = new \bdk\Debug(array(
    'collect' => true,
    'output' => true,
));

$logger = $debug->logger;   // implements Psr\Log\LoggerInterface

$logger->debug('This thing does {what}', array('what'=>'it all'));
$logger->critical('I literally can\'t even');

$monolog = new \Monolog\Logger('PHPDebugConsole');
$monolog->pushHandler(new \Monolog\Handler\PsrHandler($debug->logger));
$monolog->info('yup, it works');

Changelog

v3.3.1 – 2024-12-25

• Php 8.4's lazy objects / eager properties
• Php 8.4's final properties

v3.3 – 2024-11-20

• usage without composer no longer officially supported.
  • bdk/http-message no longer bundled and is now a dependency
  • Autoloader class given two new methods: addClass($className, $filepath) & addPsr4($namespace, $dir)
• Php 8.4
  • No deprecation notices (implicit nullable types / E_STRICT)
  • Display property hook information / virtual properties / write-only properties
  • private/protected set
• SimpleCache decorator/collector now supports v2 and v3 of SimpleCache interface
• Added Doctrine Middleware (Doctrine deprecated/removed SQLLogger)
• "Confusable" characters now highlighted (as whitespace / control chars are)
• PDO / mysqli transaction methods no longer open / close a group. Now create an info logEntry
• PhpDoc
  • descriptions and summaries are now sanitized
  • Full phpDoc now captured for properties and constants (formerly only the descritpion)
  • @deprecated, @since, & version tags now parsed into version & desc values
• alert() - now accepts multiple arguments (like log, info, error, & warn)
• trace() - new limit argument. Arguments may be passed in any order
• properties: collect 'isDeprecated'
• New Abstraction type: TYPE_IDENTIFIER (for constants, classNames, properties, methods
• Deprecate Abstraction types: TYPE_CONST & TYPE_STRING_CLASSNAME
• Response not always getting captured
• Code quality / maintainability improvements

v3.2 – 2024-01-03

• objectSort config is now a space separated list with (default = "inheritance visibility name")
• Implements now stored as a structure that conveys interface inheritance
• What interfaces a method implements are now collected for every implemented interface (prev a select few such as ArrayAccess)
• new config options: methodStaticVarCollect & methodStaticVarOutput
• anonymous objects now collected & stored like other objects… collecting attributes, phpDoc, & interfaces in the process
• html output :
  • display icon on methods implementing an interface (hover for more info)
  • display phpDoc @throws info
  • no longer add "inherited" classname to methods/properties/constants (redundant to data-inherited-from attribute)
  • properties/methods now grouped by inheritance by default. (dependent on "objectSort" first sorted by 'inheritance')
  • new interfacesCollapse config
  • new objectSectionOrder config.
    defaults to ['attributes', 'extends', 'implements', 'constants', 'cases', 'properties', 'methods', 'phpDoc']

v3.1.2 – 2023-12-19

• Debug::varDump() not escaping special chars
• Utility/Php::getIniFiles() not properly handling empty return from php_ini_scanned_files()
• ErrorHandler::handleException() - check headers_sent() before calling http_response_code(500)

v3.1.1 – 2023-12-06

• LogRequest - not "parsing" content-type correctly / not displaying $_POST values (ie for multipart/form-data)
• ReqRes::getResponseHeaders() merging default headers without regards to header case insensitivity leading to default Content-Type being added in addition to "Content-type" etc ... ReqRes::getResponseHeader('Content-Type') getting the default value. (only affects debug output)
• HttpMessage\ServerRequest::fromGlobals() now has $parseStrOpts param
• HttpMessage\Uri::fromGlobals() is now a public static method

v3.1 – 2023-11-18

• New Discord route (for errors)
• New Slack route (for errors)
• New Teams route (for errors)
• New varDump static method for in-place var_dump-like debugging
• Objects
  • Overhaul object abstraction for more efficient collection / storage / serialization / transmission of data
  • Collect (and display) php 8.2's class-level readOnly modifier
  • Added visual callouts to dynamic properties
  • Added visual callouts to constants/properties/methods that override ancestor
• New maxDepth option
• New Utility/Reflection class
• Internals
  • Move more functionality / features / methods to plugins
    all debug methods, "auto route", runtime-values
  • Cleanup bootstrap process
  • Move phpdoc type resolution to phpdoc parser.
• Underscore prefix no longer required to call most methods statically
  \bdk\Debug::log('this is new') and \bdk\Debug::_log('still works')

v3.0.7 – 2023-11-18

• official PHP 8.3 support
• small javascript ui fixes

v3.0.5 / v3.0.6 – 2023-10-11

• Error may occur in certain scenarios when setting config via meta param / Abstracter not yet initialized
• Monolog handler - now compatible with monolog v1 - v3

v3.0.4 – 2023-05-29

• Add more redaction to collectors (Guzzle Request Target / Oauth signature)
• StatementInfo (MySqli, Doctrine, PDO) - don't truncate SQL statement (ignore stringMaxLen)
• improve UriUtils::parseUrl()
• wamp route sending null meta values
• bump bundled PrismJS to latest
• other minor fixes
• coding standards

v3.0.3 – 2023-02-04

• Non-composer autoloader doesn't load main Debug class! (facepalm)
• nested channels ignore their output config value.
• restore non-sidebar channel filter/toggles functionality (used by documentation)
• minor regression with base64-encoded strings' flat-tab html output
• Add unit tests for MonologHandler, & PhpCurlClass collector

v3.0.2 – 2023-01-13

• Guzzle middleware tweaks
• SoapClient collector improvements
• Yii 1.1 tweaks
• Declare closures as static when possible
• Tweak phpcs rules
• Encoded strings.. Don't nest tabs / refactor w/ new HtmlStringEncoded class
• Redact basic password from URLs

v3.0.1 – 2022-11-14

• HttpMessage\Uri::withScheme -> allow empty value
• bdk\Debug\Psr3\Logger (psr3 implemenation) is now compatible with psr/log v1, v2, & v3
• FindExit error when exit/Fatal from static method
• Don't attempt to resolve complex array doctypes
• GuzzleMiddleware tweaks
• new HttpMessage\UriUtils class