Class Formatter

A formatter transforms an incident into a format for further processing, i.e. renders a text or HTML output with incident details and trace.

Core\Object implements Core\Chainable

Core\Set implements Core\Accessor

Core\Fault\Formatter

Direct known subclasses

Core\Fault\Formatter\Driver\html, Core\Fault\Formatter\Driver\plain

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

Methods summary

`protected`	# `__construct( Core\URI $uri )` Driver initialisation. Driver initialisation. Parameters `$uri` Driver configuration URI. Since 3.2
`public static Core\Fault\Formatter`	# `autocreate( Core\URI $uri )` Fault formatter driver factory. Fault formatter driver factory. Parameters `$uri` Driver configuration URI. Returns `Core\Fault\Formatter` New fault formatter driver instance. Since 3.2
`public Core\Charset`	# `charset( )` Returns the character set used by the formatter. Returns the character set used by the formatter. Defaults to the currently active character at time of the creation of the formatter instance unless overridden by a specific formatter implementation. Returns `Core\Charset` Character set instance used by the formatter. If no character set is available, `null` is returned instead. Since 3.2
`abstract public string`	# `contentType( )` Returns the content type of the output generated by the formatter. This is used by some reporters that allows a flexible configuration of the formatter being used but need to know the type of output generated. Returns the content type of the output generated by the formatter. This is used by some reporters that allows a flexible configuration of the formatter being used but need to know the type of output generated. Returns string Content type of generated output. Since 3.2
`public string`	# `encodeCDATA( $string )` Encodes CDATA for output. Takes the current character set into account if available. Encodes CDATA for output. Takes the current character set into account if available. Parameters `$string` to encode. Returns string Encoded string. Since 3.2
`abstract public mixed`	# `format( Core\Fault\Incident $incident )` Formats an incident. Formats an incident. Parameters `$incident` Incident to format. Returns mixed Formatted incident. Since 3.2
`public string`	# `formatFilename( Core\Fault\Incident\|array $incident )` Formats a filename for display. Formats a filename for display. Parameters `$incident` Incident or associative array to fetch filename from. Returns string Formatted filename. Since 3.2
`abstract public mixed`	# `formatTrace( array $trace )` Formats the trace of an incident. Formats the trace of an incident. Parameters `$trace` Trace to format. Returns mixed Formatted incident trace. 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

Constants inherited from Core\Object

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

Properties summary

`protected Core\Charset`	`$_charset` Associated character set instance for the formatter. If no character set is used or the character set fails to load, the value should be set to `false` to avoid further attempts to resolve the character set. Associated character set instance for the formatter. If no character set is used or the character set fails to load, the value should be set to `false` to avoid further attempts to resolve the character set. Since 3.2	#

Magic properties

`public read-only Core\Charset`	`$charset` The character set used by the formatter.
`public read-only string`	`$contentType` Content type of generated output.

Magic properties inherited from Core\Object

$hash, $uuid

Namespaces

Classes

Class Formatter

Direct known subclasses

Methods summary

Parameters

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Methods inherited from Core\Set

Methods inherited from Core\Object

Constants summary

Constants inherited from Core\Object

Properties summary

Since

Magic properties

Magic properties inherited from Core\Object