Class Formatter

A Formatter transforms arbitrary data sources into a generally readable format according to a chained data output interface (e.g. a view).

Core\Object implements Core\Chainable

Core\Set implements Core\Accessor

Core\Formatter

Direct known subclasses

Core\Formatter\Driver\coreuimarkup

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

Methods summary

`public static Core\Formatter`	# `autocreate( Core\URI $uri )` URI descriptor-based driver factory. URI descriptor-based driver factory. Parameters `$uri` Driver descriptor URI. Returns `Core\Formatter` New formatter instance derived from `Core\URI` descriptor or `null` on error. Since 3.1
`public mixed`	# `__invoke( mixed $var )` Object invocation variant of `Core\Formatter::format()` method. To provide additional options, `Core\Formatter::format()` must be used instead. Object invocation variant of `Core\Formatter::format()` method. To provide additional options, `Core\Formatter::format()` must be used instead. Parameters `$var` Data to format. Returns mixed Formatted data. See `Core\Formatter::format()` Since 3.1
`public boolean`	# `chain( Core\Chainable $object, array $flags = null )` Chains a successor formatter instance to this instance. Chains a successor formatter instance to this instance. Parameters `$object` Formatter instance to chain as successor. `$flags` See Chainable::chain() for standard flags. Returns boolean `true` on success, otherwise `false`. Throws `Core\Exception\InvalidArgument` Class of provided object is not supported. Since 3.1 Overrides `Core\Object::chain`
`public mixed`	# `format( mixed $var, array $options = null )` Formats data depending on actual formatter implementation. If a formatter successor is chained to the instance, the result of the formatting operation is also processed by the succeeding formatter prior return. Formats data depending on actual formatter implementation. If a formatter successor is chained to the instance, the result of the formatting operation is also processed by the succeeding formatter prior return. Parameters `$var` Data to format. `$options` Hash of options for the specific formatter and successor in use. Returns mixed Formatted data. Since 3.1

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

__autocreateFactory(), __call(), __processParameters(), __toString(), attachMethod(), 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\Formatter`	`$_v_successor` Subsequent (chained) formatter instance, if any. Subsequent (chained) formatter instance, if any. Since 3.1	#

Magic properties

`public read-only Core\Formatter`	`$successor` Subsequent (chained) formatter instance, if any.

Magic properties inherited from Core\Object

$hash, $uuid

Namespaces

Classes

Interfaces

Exceptions

Constants

Class Formatter

Direct known subclasses

Methods summary

Parameters

Returns

Since

Parameters

Returns

See

Since

Parameters

Returns

Throws

Since

Overrides

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