PHP Class Bravo3\Orm\Serialisers\SerialiserMap

Inheritance: implements ArrayAccess, implements IteratorAggregate
Datei anzeigen Open project: bravo3/orm Class Usage Examples

Protected Properties

Property Type Description
$default_serialiser string
$serialisers Bravo3\Orm\Serialisers\SerialiserInterface[]

Public Methods

Method Description
addSerialiser ( Bravo3\Orm\Serialisers\SerialiserInterface $serialiser )
getDefaultSerialiser ( ) : Bravo3\Orm\Serialisers\SerialiserInterface Get the default serialiser
getDefaultSerialiserId ( ) : string Get the ID of the default serialiser
getIterator ( ) : Traversable Retrieve an iterator for all serialisers in the map
getSerialiser ( string $id ) : Bravo3\Orm\Serialisers\SerialiserInterface Get a serialiser by ID
offsetExists ( mixed $offset ) : boolean (PHP 5 >= 5.0.0)
Whether a offset exists
offsetGet ( string $offset ) : Bravo3\Orm\Serialisers\SerialiserInterface Get a serialiser by ID
offsetSet ( null $offset, Bravo3\Orm\Serialisers\SerialiserInterface $value ) This function is an alias for addSerialiser(), the offset is ignored
offsetUnset ( string $offset ) This function is an alias for removeSerialiser()
removeSerialiser ( string $id ) Remove a serialiser from the list
setDefaultSerialiserId ( string $id ) Set the default serialiser by ID

Method Details

addSerialiser() public method

public addSerialiser ( Bravo3\Orm\Serialisers\SerialiserInterface $serialiser )
$serialiser Bravo3\Orm\Serialisers\SerialiserInterface

getDefaultSerialiser() public method

Get the default serialiser
public getDefaultSerialiser ( ) : Bravo3\Orm\Serialisers\SerialiserInterface
return Bravo3\Orm\Serialisers\SerialiserInterface

getDefaultSerialiserId() public method

Get the ID of the default serialiser
public getDefaultSerialiserId ( ) : string
return string

getIterator() public method

Retrieve an iterator for all serialisers in the map
public getIterator ( ) : Traversable
return Traversable

getSerialiser() public method

Get a serialiser by ID
public getSerialiser ( string $id ) : Bravo3\Orm\Serialisers\SerialiserInterface
$id string
return Bravo3\Orm\Serialisers\SerialiserInterface

offsetExists() public method

(PHP 5 >= 5.0.0)
Whether a offset exists
See link: http://php.net/manual/en/arrayaccess.offsetexists.php
public offsetExists ( mixed $offset ) : boolean
$offset mixed

An offset to check for.

return boolean true on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

offsetGet() public method

Get a serialiser by ID
public offsetGet ( string $offset ) : Bravo3\Orm\Serialisers\SerialiserInterface
$offset string
return Bravo3\Orm\Serialisers\SerialiserInterface

offsetSet() public method

This function is an alias for addSerialiser(), the offset is ignored
public offsetSet ( null $offset, Bravo3\Orm\Serialisers\SerialiserInterface $value )
$offset null
$value Bravo3\Orm\Serialisers\SerialiserInterface

offsetUnset() public method

This function is an alias for removeSerialiser()
public offsetUnset ( string $offset )
$offset string

removeSerialiser() public method

Remove a serialiser from the list
public removeSerialiser ( string $id )
$id string

setDefaultSerialiserId() public method

Set the default serialiser by ID
public setDefaultSerialiserId ( string $id )
$id string

Property Details

$default_serialiser protected_oe property

protected string $default_serialiser
return string

$serialisers protected_oe property

protected SerialiserInterface[],Bravo3\Orm\Serialisers $serialisers
return Bravo3\Orm\Serialisers\SerialiserInterface[]