PHPDebugConsole is a browser/javascript like console class for PHP.

Quick Start

{
    "require": {
        "bdk/debug": "3.0"
    }
}

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

<?php
require __DIR__.'/vendor/autoload.php';		// If installed via composer

// If not using composer uncomment the next 3 lines
// require 'path-to/src/Debug/Autoloader.php';
// $autoloader = new \bdk\Debug\Autoloader();
// $autoloader->register();

$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 (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)\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');

• Automatically outputs to HTML, serverLog, or stream appropriate to environment / request
• Channels:
  • Log PDO/SQL related entries in a "PDO" channel. Log guzzle in a "guzzle" channel. Log routing info in a "route" channel. etc
  • Html output can be filtered by channels. Other routes can filter what they handle / output by channel name.
• HTML output features
  • Collapsable drawer docked to bottom of viewport.. (look at bottom of window for example)
  • filter sidebar - filter by channel, or log-level (alert, error, warning, info, other)
  • syntax highlighted json, xml, sql, php
  • editor links (click on error or file to open relevant file/line in your editor/IDE)
  • fatal error backtraces get context (file-snippets)
• Automatically email fatal error details to SERVER_ADMIN (configurable / disabled by default)
• Methods may be called statically or as an instance method
  • To call statically, prefix the method name with an underscore
  • example: \bdk\Debug::_log('I was logged statically');
• Logs environment, request/response, $_SESSION, & files included during request. If using a framework extension/bundle, more information may be logged
  • Php Version, ini file(s) location, configured timezone, memory limit
  • If error reporting is less than E_ALL | E_STRICT
  • Checks if expose_php is disabled, whether common extensions, curl & mbstring enabled, whether xdebug is enabled
• Plugins/collectors for Guzzle, Monolog, Mysqli, OAuth, PDO, PhpCurlClass, PSR-3 (logger), PSR-16 (SimpleCache), SoapClient, SwiftMailer, & Twig. See documentation.

Strings

• Control chars & non-visual chars shown
• Base64, json, & serialized detected & inspected. (serialized only unserialized if safe to do so)
• HTML, json, SQL, & XML prettified. (Other formats may be prettified via plugin)
• Binary strings inspected and mime/content-type shown
• Numeric strings tested if timestamp and (readable date time shown)

Objects

PHPDebugConsole dumps just about every piece of info you would need to know about an object

• Classname
• Interfaces
• Inheritance
• Final?
• Constants
  • Name
  • Value
  • Attributes (PHP 8)
  • PhpDoc description (PHP 7.1)
  • Visibility (PHP 7.1)
• Properties
  • Name
  • Type
  • Value

    Did value come from object's debugInfo() method?

  • Visibility - public | protected | private | magic | magic-read | magic-write | debug
    Can can be combination of the above (example private magic-read)
  • Attributes (PHP 8)
  • Inheritance
    (Where was it last declared?)
  • PhpDoc description
  • Promoted (PHP 8)
  • Static?
• Methods
  • Name
  • Visibility - public | protected | private | magic
  • If implements interface / can show/hide interface methods for ArrayAccess, Countable, Iterator, IteratorAggregate
  • Attributes (PHP 8)
  • Inheritance
    (Where was it last declared?)
  • Deprecated?
  • Final?
  • Static?
  • PhpDoc description
  • Return type & PhpDoc description
  • Parameters
    • name
    • type
    • optional?
    • default value
    • Attributes (PHP 8)
    • Promoted? (PHP 8)
    • PhpDoc description
• PhpDoc tags
• Attributes (PHP 8)

  PHP Attributes are inspected for Class, Constants, Properties, Methods, Method Params

• Anonymous?

At a minimum, you must configure either key or both collect and output for the log to be collected & output

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

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

general options

channels

array()

Provide configuration for yet-to-be-created channels

example:

array(
    'channelName' => array(
        'channelIcon' => 'fa fa-bolt',
    )
)

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' log sent if there was an error masked by the errorHandler.emailMask config value
• true (or 'always') - log always sent (if not being output)

See email route for more information

• Raw log data will be serialized & base64-encoded
• Unserialize with \bdk\Debug\Utility\Utility\SerializeLog::unserialize()
• Import the data with \bdk\Debug::setData($unserialized)

Log Viewer

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

ChangeLog:

v3.0: true is now synonymous with "always" (was "onError")

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 "get around" 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: introduced

headerMaxAll

250000

Maximum size of all headers combined. (Chrome has a limit of 256KB)

ChangeLog:

v3.0

headerMaxPer

null

If defined, the maximum size any individual header should be.

Primarily for ChromeLogger… behind a proxy/load-balancer.

Many proxies/load-balancers have a hard limit on header size and may throw a 500 error if they receive a large header.

If you run into an issue, try setting this value to "16K", "8K", "8000", etc

ChangeLog:

v3.0

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 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

ChangeLog:

• v3.0: No effect for scripts called from the command line

logEnvInfo

array(
    'errorReporting' => true, // notice if not `E_ALL | E_STRICT`
    'files' => true,          // files included during request
    'gitInfo' => true,        // git branch if applicable
    'phpInfo' => true,        // PHP_VERSION, ini file locations, memoryLimit, etc
    'serverVals' => true,     // $_SERVER values specified by logServerKeys
    'session' => true,        // session data
)

Specify "environment" information to automatically log.

Also accepts true (all), or false (none).

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

• 17 files required
• 12 files logged
• array(
  • /var/www=>array(
    • 0=>controllers/php/Debug.php
    • vendor=>array(
      • 0=>5 omitted
      )
    • views/php/debug=>array(
      • 0=>index.php
      • 1=>changelog.php
      • 2=>config.php
      • 3=>events.php
      • 4=>framework.php
      • 5=>index.php
      • 6=>methods.php
      • 7=>overview.php
      • 8=>route.php
      )
    • 1=>bootstrap.php
    • 2=>index.php
    )
  )

• PHP Version = 8.2.0-dev
• ini files = array(
  • /path/to/php.ini
  • /usr/local/etc/php/8.2/conf.d/ext-opcache.ini
  • /usr/local/etc/php/8.2/conf.d/ext-xdebug.ini
  )
• date.timezone = America/Chicago
• memory_limit = redacted MB
• expose_php: should be disabled
• Xdebug v3.2.0alpha3 is installed (mode: debug,coverage,develop)
• $_SERVER = array(
  • HTTP_HOST=>local.bradkent.com
  • REMOTE_ADDR=>127.0.0.1
  • REQUEST_TIME=>1679429115
  • REQUEST_URI=>/php/debug&debug=backdoor
  • SERVER_ADDR=>127.0.0.1
  • SERVER_NAME=>local.bradkent.com
  )
• Not all $_SERVER values are output -> only those included in `logServerKeys

• session.cookie_httponly: should be enabled
• session.cache_limiter = nocache
• session save_path = /var/tmp/
• session name = SESSIONID
• session id = pgfh5nlgsnh59mduas64dqk9ud
• $_SESSION = array(
  • form_persist=>array(
    • global=>array()
    • comment=>array(
      • name=>comment
      • pages=>array(
        • 0=>array(
          • name=>0
          • completed=>false
          • values=>array()
          • addPages=>array()
          )
        )
      • i=>0
      • PRGState=>null
      • submitted=>false
      • key=>1a3d7acd5009fa19c5e6767632f6f5e2
      • persist=>array(
        • pid=>760
        • commentId=>null
        • keys=>array(
          • name=>b5feb67c98
          • location=>9aaa1cb2ae
          • email=>e0ade29217
          • url=>f3b2bd778b
          • save=>057ebdbf89
          • comment=>dcfb96e732
          • captcha=>51ed977231
          • submit=>b453fc15ca
          )
        )
      • timestamp=>1674848590.8413
      • trashCollectable=>true
      • ver=>1.0
      )
    )
  )

• git branch: master
• Built In 1.9628 sec
• Peak Memory Usage ?⃝: 16 MB / redacted MB

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

ChangeLog:

• v3.0: errorReporting, gitInfo, & session added
  cookies, headers, & post removed (moved to logRequestInfo)
• v2.3: accepts array in addition to boolean
• v2.0: introduced

logRequestInfo

array(
    'cookies' => true,
    'files' => true,   // $_FILES
    'headers' => true, // request headers
    'post' => true,    // $_POST (or request body)
)

Specify request information to automatically log.

Also accepts true (all), or false (none).

Example

Example Source

$debug = new \bdk\Debug(array(
	'collect' => true,
	'output' => true,
	'logRequestInfo' => true, // this is the default (all other examples use `false`),
	'logResponse' => true, // this is the default (other other examples use `false`),
));

Example Output

PHPDebugConsole

GET /php/debug&debug=backdoor

• Request

• request headers

  	value
  Accept	text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7
  Accept-Encoding	gzip, deflate, br
  Accept-Language	en-US,en;q=0.9
  Cache-Control	max-age=0
  Connection	keep-alive
  Content-Length	0
  Cookie	SESSIONID=pgfh5nlgsnh59mduas64dqk9ud
  Host	local.bradkent.com
  If-Modified-Since	Fri, 09 Dec 2022 19:55:14 GMT
  Sec-Ch-Ua	"Google Chrome";v="111", "Not(A:Brand";v="8", "Chromium";v="111"
  Sec-Ch-Ua-Mobile	?0
  Sec-Ch-Ua-Platform	"macOS"
  Sec-Fetch-Dest	document
  Sec-Fetch-Mode	navigate
  Sec-Fetch-Site	none
  Sec-Fetch-User	?1
  User-Agent	Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36

• $_COOKIE

  	value
  SESSIONID	pgfh5nlgsnh59mduas64dqk9ud

• Response

• response headers

  	value
  X-Powered-By	PHP/8.2.0-dev
  Set-Cookie	SESSIONID=pgfh5nlgsnh59mduas64dqk9ud; path=/
  Expires	Thu, 19 Nov 1981 08:52:00 GMT
  Cache-Control	no-store, no-cache, must-revalidate
  Pragma	no-cache

• Content-Type unknown: Not logging response body.

• Built In 1.9628 sec
• Peak Memory Usage ?⃝: 16 MB / redacted MB

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

ChangeLog:

v3.0

logResponse

auto

Whether to begin buffering output & potentialy log response

auto

(default) We will begin buffering output if ajax request, have SoapAction header, or have a Accepts header that does not contain "html"

true

Begin buffering output

false

Don't buffer output. Response will not be logged

If output is being buffered, we will log the output upon shutdown if response Content-Type is json or xml.

See also writeToResponse()

ChangeLog:

v3.0

logResponseMaxLen

1 MB

Set a size limit to logging response

If size is exceeded, response will not be output

integer or string

0 / null : No Limit

logRuntime

true

Log script duration and memory usage.

ChangeLog:

v3.0

logServerKeys

array("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: introduced

onBootstrap

null

A callable to be called when debug instance is created.

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

ChangeLog:

v2.0: introduced

onLog

null

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

ChangeLog:

• v2.0: introduced
• v2.0.1: replaces previous onLog value (rather than add additional subscriber)

onMiddleware

null

• A Callable to be called before our middleware writes to response
• Callback will receive a single param: \bdk\PubSub\Event $event. Event object contains request and response objects
• Shortcut for subscribing to \bdk\Debug::EVENT_MIDDLEWARE event.

ChangeLog:

• v3.0: introduced

onOutput

null

• A callable to be called before log is output.
• Callback will receive a single param: \bdk\PubSub\Event $event.
• Shortcut for subscribing to \bdk\Debug::EVENT_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

redactKeys

array("password")

A list of keys that should be redacted when redact meta option is passed.

Keys will also be found and redacted in url-encoded strings, xml, & json

The string (or portion thereof) that needs redacted will be passed to the callable defined by redactReplace

Examples:

Perform redaction on xml

$debug->log('response', $xml, $debug->meta('redact'));

Perform redaction on an array

$debug->log('api params', $params, $debug->meta('redact'));

• Redaction is not performed on all log entries.
• Redcation is only performed when redact meta option is passed.

Redaction is performed on out-of-the-box logging of input/$_POST, $_COOKIE, request headers, $_SERVER values, & response

ChangeLog:

v3.0

redactReplace

callable

A callable that receives the string being redacted and the key

Default callable returns "█████████"

See also redactKeys

ChangeLog:

v3.0

serviceProvider

array()

\bdk\Container\ServiceProviderInterface, array, or callable that receives \bdk\Container as param.

Used to specify dependencies

sessionName

null

If logging session data (see logEnvInfo), optionally specify session name

If not specified, we will try "PHPSESSID" (php's default, but not recommended), "SESSIONID", "SESSION_ID", "SESSID", and "SESS_ID"

stream

null

A valid filepath, stream-url, or resource, to write the log. This will supplement the log that is output via output()

ChangeLog:

v3.0 replaces "file" option

stringMaxLen

array(
    'base64' => 154, // only 1st 154 chars of base-64 string will be shown
    'binary' => array(
        128 => 0,    // if over 128 bytes don't capture / store
    ),
    'other' => 8192,
)

Controls the maximum string length (in bytes) that is collected/shown for string values

specifying an int (vs array) will set the "other" value

-1 = no maximum

ChangeLog:

v3.0: introduced

stringMinLen

array(
    'contentType' => 256, // try to determine content-type of binary string
    'encoded' => 16, // test if bas64, json, or serialized (-1 = don't check)
)

Specify the minimum length of a string before we inspect it to determine the content-type or check if json/base64/serialized

ChangeLog:

v3.0: introduced

output related options

These options deal with how the log is output

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: introduced

route

auto

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

• Options:

  chromeLogger

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

  email

  • Email the log data.
  • 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
  • Details

  serverLog

  • Writes the log to a file which is retrieved by browser extension.
  • Outputs header which specifies url for browser extension to retrieve the log
  • Requires browser extension to view.
  • Details

  script

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

  stream

  • Writes log entries to a file/resource/url specified by the stream option
  • 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\RouteInterface

ChangeLog:

v3.0 replaces "outputAs" option

routeNonHtml

chromeLogger

If route is "auto", this value will be used for http requests that are ajax or non-html response

ChangeLog:

v3.0 replaces "outputAsDefaultNonHtml" option

html related options

css

Supplemental CSS to output

drawer

true

Place output in dockable "drawer"

ChangeLog:

v3.0

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?

sidebar

true

Display filter sidebar?

ChangeLog:

v3.0

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

phpDocCollect

true

Whether to collect PhpDoc description & summary (for obj, constants, properties, methods, & method params)

phpDocOutput

true

Whether to output PhpDoc description & summary (for obj, constants, properties, methods, & method params)

objAttributeCollect

true

Whether to collect attributes attached to class

objAttributeOutput

true

Whether to output class attributes

toStringOutput

true

Whether to output the __toString() value

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

caseCollect

true

Whether to collect enum cases

caseOutput

true

Whether to output enum cases

caseAttributeCollect

true

Whether to collect attributes attached to enum cases

caseAttributeOutput

true

Whether to output enum case attributes

constCollect

true

Whether to collect object constants 3.0

ChangeLog:

v3.0b2: renamed from collectConstants

constOutput

true

Whether to output object's constants

ChangeLog:

v3.0b2: renamed from outputConstants

constAttributeCollect

true

Whether to collect attributes attached to class constants

constAttributeOutput

true

Whether to output constant attributes

methodCollect

true

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

ChangeLog:

v3.0b2: renamed from collectMethods

methodOutput

true

Whether to output object's methods

ChangeLog:

v3.0b2: renamed from outputMethods

methodAttributeCollect

true

Whether to collect attributes attached to methods

methodAttributeOutput

true

Whether to output method attributes

methodCache

true

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

The need to disable this is extremely rare

ChangeLog:

v3.0b2: renamed from cacheMethods
v2.3: introduced

methodDescOutput

true

Whether to output method's long phpDoc description

ChangeLog:

v3.0: renamed from "outputMethodDescription"

paramAttributeCollect

true

Whether to collect attributes attached to method parameters

paramAttributeOutput

true

Whether to output method parameters attributes

propAttributeCollect

true

Whether to collect attributes attached to properties

propAttributeOutput

true

Whether to output attributes attached to properties

errorEmailer options

• configure how error notifications are emailed
• 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

60

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

ChangeLog:

v3.0 default changed to 60 (was 15)

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

enableEmailer

false

Send error notifications via email

ChangeLog:

v3.0 introduced. formerly enabled/disabled solely via emailMask setting

errorStatsFile

__DIR__ . '/error_emails.json'

A file used to maintain details of recent errors.

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

ChangeLog:

v3.0: renamed. formerly "emailThrottleFile"

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

errorLogNormal

false

Whether to log the error to the error_log as "normal" when the debugger is capturing errors

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: introduced

onError

null

Set to something callable.

• Shortcut for subscribing to errorHandler.error event
• Will also get called on fatal errors.
• Callback will receive a single param: \bdk\ErrorHandler\Error $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)