Référence de la classe StringCodec

Graphe d'héritage de StringCodec:

Fonctions membres publiques
	__construct (UuidBuilderInterface $builder)
	encode (UuidInterface $uuid)
	encodeBinary (UuidInterface $uuid)
	decode ($encodedUuid)
	decodeBytes ($bytes)

Fonctions membres protégées
	getBuilder ()
	extractComponents ($encodedUuid)
	getFields (array $components)

Attributs privés
	$builder

Description détaillée

StringCodec encodes and decodes RFC 4122 UUIDs

http://tools.ietf.org/html/rfc4122

Documentation des constructeurs et destructeur

__construct()

__construct

(

UuidBuilderInterface

$builder

)

Constructs a StringCodec for use encoding and decoding UUIDs

Paramètres

UuidBuilderInterface

$builder

The UUID builder to use when encoding UUIDs

Références StringCodec\$builder.

Documentation des fonctions membres

decode()

decode

(

$encodedUuid

)

Decodes a string representation of a UUID into a UuidInterface object instance

Paramètres

string

$encodedUuid

Renvoie

UuidInterface

Exceptions

InvalidUuidStringException

Implémente CodecInterface.

Références $fields, $this, StringCodec\extractComponents(), et StringCodec\getFields().

Référencé par OrderedTimeCodec\decodeBytes(), et StringCodec\decodeBytes().

decodeBytes()

decodeBytes

(

$bytes

)

Decodes a binary representation of a UUID into a UuidInterface object instance

Paramètres

string

$bytes

Renvoie

UuidInterface

Exceptions

InvalidArgumentException

if string has not 16 characters

Implémente CodecInterface.

Références StringCodec\decode().

encode()

encode

(

UuidInterface

$uuid

)

Encodes a UuidInterface as a string representation of a UUID

Paramètres

UuidInterface

$uuid

Renvoie

string Hexadecimal string representation of a UUID

Implémente CodecInterface.

Références $fields, et UuidInterface\getFieldsHex().

encodeBinary()

encodeBinary

(

UuidInterface

$uuid

)

Encodes a UuidInterface as a binary representation of a UUID

Paramètres

UuidInterface

$uuid

Renvoie

string Binary string representation of a UUID

Implémente CodecInterface.

Références UuidInterface\getHex().

extractComponents()

extractComponents (   $encodedUuid )

protected

Returns an array of UUID components (the UUID exploded on its dashes)

Paramètres

string

$encodedUuid

Renvoie

array

Exceptions

InvalidUuidStringException

Références Uuid\isValid().

Référencé par GuidStringCodec\decode(), TimestampFirstCombCodec\decode(), et StringCodec\decode().

getBuilder()

getBuilder ( )

protected

Returns the UUID builder

Renvoie

UuidBuilderInterface

Références StringCodec\$builder.

Référencé par GuidStringCodec\decode(), et TimestampFirstCombCodec\decode().

getFields()

getFields ( array  $components )

protected

Returns the fields that make up this UUID

Voir également

::getFieldsHex()

Paramètres

array

$components

Renvoie

array

Référencé par GuidStringCodec\decode(), TimestampFirstCombCodec\decode(), et StringCodec\decode().

Documentation des champs

$builder

$builder

private

Référencé par StringCodec\__construct(), et StringCodec\getBuilder().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• StringCodec.php