Docs For Class WFValueTransformer

Description

WFValueTransformer

Value transformers provide one-way or reversible transformations.

Value transformers are part of the bindings system.

To create your own value transformer, simply subclass WFValueTransformer, implement the necessary methods, etc. Then, in the ViewDidLoad method of the view that uses the transformer, register the named transformer. To add a valueTransformer to the bindings, simply add an option to the bindings config with WFBinding::VALUE_TRANSFORMER_NAME => 'name of registered transformer'.

abstract:

Located in /framework/ValueTransformers/WFValueTransformer.php (line 23)

WFObject
   |
   --WFValueTransformer

Direct descendents

Class	Description
WFIsEmptyTransformer	WFIsEmptyTransformer
WFIsNotEmptyTransformer	WFIsNotEmptyTransformer
WFNegateBooleanTransformer	WFNegateBooleanTransformer
WFUrlencodeTransformer	WFUrlencodeTransformer

Variable Summary

static A $transformerList

boolean $reversible

Method Summary

static void setValueTransformerForName (object A $valueTransformer, string $name)

static object A valueTransformerForName (string $name)

static array valueTransformerNames ()

WFValueTransformer __construct ()

mixed reverseTransformedValue (mixed $value)

void reversible ()

void setReversible ( $reversible)

mixed transformedValue (mixed $value)

Variables

static A $transformerList = array() (line 29)

var: list of all transformers currently registered. Format: transformerName => transformerInstance (a WFValueTransformer subclass)
access: protected

boolean $reversible (line 33)

var: TRUE if the transformation is reversible.
access: protected

Methods

static method setValueTransformerForName (line 73)

Register a value transformer for the passed name.

throws: if you try to set a non-WFValueTransformer object.
access: public

static void setValueTransformerForName (object A $valueTransformer, string $name)

object A $valueTransformer: WFValueTransformer object.
string $name: The name of the instance. Each instance is registered separately to promoted re-use. For instance you may write a MultiplierTransformer that has a multiplier as a member variable. The you could instantiate it more than once with different multipliers and register them as "MutliplyBy10Transformer", "MultplyBy2Transformer", etc.

static method valueTransformerForName (line 86)

Retrieve a named value transformer instance.

return: WFValueTransformer instance.
throws: for unknown transformers.
access: public

static object A valueTransformerForName (string $name)

string $name: The name of the value transformer to retrieve.

static method valueTransformerNames (line 97)

Get a list of all registered transformers.

return: An array of WFValueTransformer instances that are registered and available.
access: public

static array valueTransformerNames ()

Constructor __construct (line 35)

WFValueTransformer __construct ()

Redefinition of:

WFObject::__construct()

Redefined in descendants as:

reverseTransformedValue (line 61)

Get the reverse-transfored value.

return: The reverse-transformed value.
abstract:

mixed reverseTransformedValue (mixed $value)

mixed $value: The value to reverse-transform.

Redefined in descendants as:

reversible (line 45)

void reversible ()

setReversible (line 41)

void setReversible ( $reversible)

$reversible

transformedValue (line 55)

Get the transfored value.

return: The transformed value.
abstract:

mixed transformedValue (mixed $value)

mixed $value: The value to transform.

Redefined in descendants as:

Inherited Methods

Inherited From WFObject

WFObject::__construct()
WFObject::exposedProperties()
WFObject::getClass()
WFObject::keyPathToTargetAndKey()
WFObject::setValueForKey()
WFObject::setValueForKeyPath()
WFObject::validateValueForKey()
WFObject::validateValueForKeyPath()
WFObject::valueForKey()
WFObject::valueForKeyPath()
WFObject::valueForUndefinedKey()
WFObject::__toString()