Docs For Class Formatter

Description

Formatter base class

Formatters provide a interface for value formatting/rewriting for xdo views. Formatters can be used for either DataSet and DataObject views (this can be configured - seeXDOViewDefinition).

Please note that Formatters cannot be used for read-write fields, as they have no possiblity to reverse their formatting. For custom input formats, you will need to create widgets.

abstract:

Located in /phpsatk-lib/global/org.eenterphace.sat.formatter/formatter.php (line 41)

Direct descendents

Class	Description
FormatterRoleID	Formatter transforming a RoleID into a name
FormatterUserID	Formatter transforming a User ID into a name
FormatterDateTime	Timestamp formatter for date/time values
FormatterNumber	Formatter for numbers
FormatterTimespan	Timestamp formatter for timespans
FormatterShorten	Shortening formatter
FormatterEnum	Formatter for enumerations

Variable Summary

DOMElement $domnode

Method Summary

Formatter __construct (DOMElement $domnode)

mixed format (mixed $value)

Variables

DOMElement $domnode (line 48)

The formatter configuration DOM

access: protected

Methods

Constructor __construct (line 60)

Initialize the formatter

The formatter will be passed a dom node which might contain configuration elements for it. This configuration should be parsed in the constructor and made available as class property to the formatting function.

access: public

Formatter __construct (DOMElement $domnode)

DOMElement $domnode: Formatter Configuration

Redefined in descendants as:

FormatterShorten::__construct() : Initializes the formatter
FormatterEnum::__construct() : Initialize the formatter

format (line 72)

The actual formatting function

Implement your formatting here.

access: public
abstract:

mixed format (mixed $value)

mixed $value: Value to format

Redefined in descendants as:

FormatterRoleID::format() : Resolves a Role name from a RoleID
FormatterUserID::format() : Resolves a Role name from a RoleID
FormatterDateTime::format()
FormatterNumber::format() : Format the value
FormatterTimespan::format() : Formats the value
FormatterShorten::format() : Formats the value
FormatterEnum::format() : Formats the value