final class MessageCodecRegistry (View source)

Maps stable queue aliases to explicitly trusted message classes and codecs.

Handler registration never changes this allow-list; applications extend it deliberately from a service provider before resolving the database queue transport.

Methods

void
register(string $alias, string $messageClass, MessageCodecInterface $codec, int $version = 1)

Registers one stable alias and schema version for an exact message class.

void
array
encode(object $message)

Encodes an exact registered message class and returns its persisted type identity.

array
object
decode(string $alias, int $version, array $payload)

Reconstructs a message only when its authenticated alias and version are registered.

object

Details

register

void register(string $alias, string $messageClass, MessageCodecInterface $codec, int $version = 1)

Registers one stable alias and schema version for an exact message class.

Reusing an alias or class is rejected so provider order cannot silently change persisted message identity.

Parameters

string $alias
string $messageClass
MessageCodecInterface $codec
int $version

Return Value

void

encode

array encode(object $message)

Encodes an exact registered message class and returns its persisted type identity.

Parameters

object $message

Return Value

array

decode

object decode(string $alias, int $version, array $payload)

Reconstructs a message only when its authenticated alias and version are registered.

Parameters

string $alias
int $version
array $payload

Return Value

object

Exceptions

InvalidQueuePayloadException