PHP Class Doctrine\OXM\Types\Type

A Type object is obtained by calling the static {@link getType()} method.
Since: 2.0
Author: Richard Fullmer ([email protected])
Show file Open project: doctrine/oxm Class Usage Examples

Public Methods

Method Description
__toString ( )
addType ( string $name, string $className ) Adds a custom type to the type map.
convertToPHPValue ( mixed $value ) : mixed Converts a value from its database representation to its PHP representation of this type.
convertToXmlValue ( mixed $value ) : mixed Converts a value from its PHP representation to its XML representation of this type.
getName ( ) : string Gets the name of this type.
getType ( string $name ) : Type Factory method to create type instances.
getTypesMap ( ) : array Get the types array map which holds all registered types and the corresponding type class
hasType ( string $name ) : boolean Checks if exists support for a type.
overrideType ( string $name, string $className ) Overrides an already defined type to use a different implementation.

Private Methods

Method Description
__construct ( ) * Prevent instantiation and force use of the factory method.

Method Details

__toString() public method

public __toString ( )

addType() public static method

Adds a custom type to the type map.
public static addType ( string $name, string $className )
$name string Name of the type. This should correspond to what getName() returns.
$className string The class name of the custom type.

convertToPHPValue() public method

Converts a value from its database representation to its PHP representation of this type.
public convertToPHPValue ( mixed $value ) : mixed
$value mixed The value to convert.
return mixed The PHP representation of the value.

convertToXmlValue() public method

Converts a value from its PHP representation to its XML representation of this type.
public convertToXmlValue ( mixed $value ) : mixed
$value mixed The value to convert.
return mixed The XML representation of the value.

getName() abstract public method

Gets the name of this type.
abstract public getName ( ) : string
return string

getType() public static method

Type instances are implemented as flyweights.
public static getType ( string $name ) : Type
$name string The name of the type (as returned by getName()).
return Type

getTypesMap() public static method

Get the types array map which holds all registered types and the corresponding type class
public static getTypesMap ( ) : array
return array $typesMap

hasType() public static method

Checks if exists support for a type.
public static hasType ( string $name ) : boolean
$name string Name of the type
return boolean TRUE if type is supported; FALSE otherwise

overrideType() public static method

Overrides an already defined type to use a different implementation.
public static overrideType ( string $name, string $className )
$name string
$className string