Class Debug

Namespace: ICanBoogie
Located at vendor/icanboogie/icanboogie/lib/debug.php

Methods summary

`public static`	# `synthesize_config( array $fragments )`
`public static`	# `is_dev( )`
`public static`	# `is_test( )`
`public static`	# `is_production( )`
`public static`	# `configure( array $config )` Configures the class. Configures the class. Parameters `$config` `array` $config A config such as one returned by `$core->configs['debug']`.
`public static`	# `shutdown_handler( )` Stores logged messages in the session and report fatal errors. Stores logged messages in the session and report fatal errors.
`public static`	# `restore_logs( ICanBoogie\Event $event, ICanBoogie\Session $session )`
`public static`	# `error_handler( integer $no, string $str, string $file, integer $line, array $context )` Handles errors. Handles errors. The `ICanBoogie\Debug::$last_error` and `ICanBoogie\Debug::$last_error_message` properties are updated. The alert is formatted, reported and if the `verbose` option is true the alert is displayed. Parameters `$no` `integer` $no The level of the error raised. `$str` `string` $str The error message. `$file` `string` $file The filename that the error was raised in. `$line` `integer` $line The line number the error was raised at. `$context` `array` $context The active symbol table at the point the error occurred.
`public static`	# `exception_handler( ICanBoogie\Exception $exception )` Basic exception handler. Basic exception handler. Parameters `$exception` `Exception` $exception
`public static string`	# `format_alert( Exception\|array $alert )` Formats an alert into a HTML element. Formats an alert into a HTML element. An alert can be an exception or an array representing an error triggered with the trigger_error() function. Parameters `$alert` `Exception\|array` $alert Returns `string`
`public static string`	# `format_trace( array $trace )` Formats a stack trace into an HTML element. Formats a stack trace into an HTML element. Parameters `$trace` `array` $trace Returns `string`
`public static string`	# `format_code_sample( string $file, integer $line = 0 )` Extracts and formats a code sample around the line that triggered the alert. Extracts and formats a code sample around the line that triggered the alert. Parameters `$file` `string` $file `$line` `integer` $line Returns `string`
`public static`	# `report( string $message )` Reports the alert to the admin of the website. Reports the alert to the admin of the website. The method sends an email to the admin of the website defined whose email address is defined in the debug config using the "report_address" key. Parameters `$message` `string` $message
`public static`	# `log( mixed $type, mixed $message, array $params = [], mixed $message_id = null )`
`public static array`	# `get_messages( string $type )` Returns the messages available in a given log. Returns the messages available in a given log. Parameters `$type` `string` $type The log type. Returns `array` The messages available in the given log.
`public static array`	# `fetch_messages( string $type )` Similar to the get_message() method, the method returns the messages available in a given log, but clear the log after the messages have been extracted. Similar to the get_message() method, the method returns the messages available in a given log, but clear the log after the messages have been extracted. Parameters `$type` `string` $type Returns `array` The messages fetched from the given log.

Magic methods summary

Constants summary

`string`	`MODE_DEV`	`'dev'`	#
`string`	`MODE_TEST`	`'test'`	#
`string`	`MODE_PRODUCTION`	`'production'`	#
`integer`	`MAX_MESSAGES`	`100`	#
`integer`	`MAX_STRING_LEN`	`16`	#

Properties summary

`public static string`	`$mode`	#
`public static array[string]mixed`	`$last_error`	# Last error. Last error.
`public static string`	`$last_error_message`	# Last error message. Last error message.
`public static array`	`$logs`	#