Class Incident

An incident stores information over the cause of a fault.

Core\Object implements Core\Chainable

Core\Set implements Core\Accessor

Core\Fault\Incident

Direct known subclasses

Core\Fault\Incident\Error, Core\Fault\Incident\Exception

Indirect known subclasses

Core\Fault\Incident\Exception\Recoverable

Abstract
Namespace: Core\Fault
Package: Core\Fault
Since: 3.2
Requires: PHP 5.3
Version: 1.0
Located at Fault/Incident.inc.php

Methods summary

`protected`	# `__construct( $raw )` Initialises a new incident. Initialises a new incident. Var mixed $raw Associative array of PHP error information or exception instance. Since 3.2
`abstract public integer`	# `code( )` Returns the error code of the incident. Returns the error code of the incident. Returns integer Error code of incident. Since 3.2
`abstract public string`	# `filename( )` Returns the incident origin filename. Returns the incident origin filename. Returns string Filename of incident origin. Since 3.2
`abstract public integer`	# `line( )` Returns the incident origin file line number. Returns the incident origin file line number. Returns integer File line number of incident origin. Since 3.2
`abstract public string`	# `message( )` Returns the incident error message. Returns the incident error message. Returns string Error message of incident. Since 3.2
`abstract public string`	# `name( )` Returns a name for the incident, based on the type. Returns a name for the incident, based on the type. Returns string A name for the incident, for display purposes only. Since 3.2
`public Core\Fault\Incident`	# `next( )` Returns the next incident (for chained exceptions). Only available on incidents retrieved via the `Core\Fault\Incident::previous()` method. Returns the next incident (for chained exceptions). Only available on incidents retrieved via the `Core\Fault\Incident::previous()` method. Returns `Core\Fault\Incident` Next incident that returned this incident as its previous incident. Since 3.2
`abstract public Core\Fault\Incident`	# `previous( )` Returns the previous incident (for chained exceptions). Returns the previous incident (for chained exceptions). Returns `Core\Fault\Incident` Previous incident. Since 3.2
`abstract public boolean`	# `recoverable( )` Determines whether the incident is recoverable, i.e. whether execution can continue. Determines whether the incident is recoverable, i.e. whether execution can continue. Returns boolean `true`, if incident is recoverable, otherwise `false`. Since 3.2
`abstract public boolean`	# `silent( )` Indicates whether the incident should be treated silently. Indicates whether the incident should be treated silently. Returns boolean If `true`, the incident should be treated silently (i.e. suppress error message to user or completely do not report the error, depending on the configured reporter). Since 3.2
`public DateTime`	# `timestamp( )` Returns the timestamp when the incident occurred. Returns the timestamp when the incident occurred. Returns `DateTime` Timestamp of incident. Since 3.2
`abstract public array`	# `trace( )` Returns the incident back-trace stack. Returns the incident back-trace stack. Returns array Incident back-trace stack. Since 3.2
`abstract public string`	# `type( )` Returns the incident type. Returns the incident type. Returns string Incident type. Since 3.2

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

__autocreateFactory(), __call(), __processParameters(), __toString(), attachMethod(), chain(), getValueForKey(), getValueForKeyPath(), getValueForUndefinedKey(), hash(), issetValueForKey(), setValueForKey(), setValueForKeyPath(), setValueForUndefinedKey(), uuid()

Constants summary

`string`	`ErrorType` Incident is an error, either triggered by PHP or the user. Incident is an error, either triggered by PHP or the user. Since 3.2	# `'error'`
`string`	`ExceptionType` Incident is an uncaught exception. Incident is an uncaught exception. Since 3.2	# `'exception'`

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

`protected Core\Fault\Incident`	`$_next` Next incident instance, that returned this instance as its previous incident. Next incident instance, that returned this instance as its previous incident. Since 3.2	#
`protected DateTime`	`$_timestamp` Timestamp when the incident occurred; default to the timestamp of the moment the instance was created. Timestamp when the incident occurred; default to the timestamp of the moment the instance was created. Since 3.2	#
`protected mixed`	`$_v_raw` Incident-specific raw data (i.e. associative data array or exception instance). Incident-specific raw data (i.e. associative data array or exception instance). Since 3.2	#

Magic properties

`public read-only integer`	`$code` Error code of incident.
`public read-only string`	`$filename` Filename of incident origin.
`public read-only integer`	`$line` File line number of incident origin.
`public read-only string`	`$message` Incident error message.
`public read-only Core\Fault\Incident`	`$previous` Previous incident.
`public read-only mixed`	`$raw` Associative array of PHP error information or exception instance.
`public read-only boolean`	`$silent` Indicates whether the incident should be treated silently.
`public read-only DateTime`	`$timestamp` Timestamp when the incident occurred.
`public read-only array`	`$trace` Incident back-trace stack.
`public read-only string`	`$type` Incident type.

Magic properties inherited from Core\Object

$hash, $uuid

Namespaces

Classes

Class Incident

Direct known subclasses

Indirect known subclasses

Methods summary

Var

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Methods inherited from Core\Set

Methods inherited from Core\Object

Constants summary

Since

Since

Constants inherited from Core\Object

Properties summary

Since

Since

Since

Magic properties

Magic properties inherited from Core\Object