@ -125,7 +125,7 @@ Unregisters the Catcher instance as an error, exception and shutdown handler.
Unshifts the specified handler(s) onto the beginning of the stack
Unshifts the specified handler(s) onto the beginning of the stack
### MensBeam\Foundation\Handler
### MensBeam\Foundation\Catcher\Handler
All handlers inherit from this abstract class. Since it is an abstract class meant for constructing handlers protected methods and properties will be documented as well.
All handlers inherit from this abstract class. Since it is an abstract class meant for constructing handlers protected methods and properties will be documented as well.
@ -179,48 +179,30 @@ abstract class Handler {
#### Constants
#### Constants
_CONTENT\_TYPE_: The mime type of the content that is output by the handler
_CONTENT\_TYPE_: The mime type of the content that is output by the handler
_CONTINUE_: The stack loop continues onto the next handler after handling; this is the default behavior
_CONTINUE_: The stack loop continues onto the next handler after handling; this is the default behavior
_BREAK_: The stack loop breaks after the handler finishes, causing any further down in the stack to not run
_EXIT_: The stack loop exits after running all handlers
_BREAK_: The stack loop breaks after the handler finishes, causing any further down in the stack to not run
_OUTPUT_: The handler will output
_SILENT_: The handler will be silent
_EXIT_: The stack loop exits after running all handlers
_OUTPUT_: The handler will output
_SILENT_: The handler will be silent
_NOW_: Outputs immediately after handling
_NOW_: Outputs immediately after handling
#### Properties (Protected)
#### Properties (Protected)
Properties which begin with an underscore all are options. They can be set either through the constructor or via `setHandler` by name, removing the underscore at the beginning. All handlers inherit these options.
Properties which begin with an underscore all are options. They can be set either through the constructor or via `setHandler` by name, removing the underscore at the beginning. All handlers inherit these options.
_outputBuffer_: This is where the output arrays representing the handled throwables are stored until they are dispatched.
_outputBuffer_: This is where the output arrays representing the handled throwables are stored until they are dispatched.
_\_backtraceArgFrameLimit_: The number of frames by which there can be arguments output with them. Defaults to _5_.
_\_backtraceArgFrameLimit_: The number of frames by which there can be arguments output with them. Defaults to _5_.
_\_charset_: The character set of the output; only used if headers weren't sent before an error occurred. Defaults to _"UTF\_8"_.
_\_forceBreak_: When set this will force the stack loop to break after the handler has run. Defaults to _false_.
_\_charset_: The character set of the output; only used if headers weren't sent before an error occurred. Defaults to _"UTF\_8"_.
_\_forceExit_: When set this will force an exit after all handlers have been run. Defaults to _false_.
_\_forceOutputNow_: When set this will force output of the handler immediately. Defaults to _false_.
_\_forceBreak_: When set this will force the stack loop to break after the handler has run. Defaults to _false_.
_\_httpCode_: The HTTP code to be sent; possible values are 200, 400-599. Defaults to _500_.
_\_outputBacktrace_: When true will output a stack trace. Defaults to _false_.
_\_forceExit_: When set this will force an exit after all handlers have been run. Defaults to _false_.
_\_outputPrevious_: When true will output previous throwables. Defaults to _true_.
_\_outputTime_: When true will output times to the output. Defaults to _true_.
_\_forceOutputNow_: When set this will force output of the handler immediately. Defaults to _false_.
_\_outputToStderr_: When the SAPI is cli output errors to stderr. Defaults to _true_.
_\_silent_: When true the handler won't output anything. Defaults to _false_.
_\_httpCode_: The HTTP code to be sent; possible values are 200, 400-599. Defaults to _500_.
_\_outputBacktrace_: When true will output a stack trace. Defaults to _false_.
_\_outputPrevious_: When true will output previous throwables. Defaults to _true_.
_\_outputTime_: When true will output times to the output. Defaults to _true_.
_\_outputToStderr_: When the SAPI is cli output errors to stderr. Defaults to _true_.
_\_silent_: When true the handler won't output anything. Defaults to _false_.
_\_timeFormat_: The PHP-standard date format which to use for times in output. Defaults to _"Y-m-d\\TH:i:s.vO"_.
_\_timeFormat_: The PHP-standard date format which to use for times in output. Defaults to _"Y-m-d\\TH:i:s.vO"_.
Returns the error type of a `MensBeam\Foundation\Catcher\Error`, meaning a human-friendly representation of the error code or null if the throwable isn't an `Error`.