72 lines
1.6 KiB
YAML
72 lines
1.6 KiB
YAML
|
name: SerializerInterface
|
||
|
|
class_comment: null
|
||
|
|
dependencies:
|
||
|
|
- name: Envelope
|
||
|
|
type: class
|
||
|
|
source: Symfony\Component\Messenger\Envelope
|
||
|
|
- name: MessageDecodingFailedException
|
||
|
|
type: class
|
||
|
|
source: Symfony\Component\Messenger\Exception\MessageDecodingFailedException
|
||
|
|
properties: []
|
||
|
|
methods:
|
||
|
|
- name: decode
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: encodedEnvelope
|
||
|
|
comment: '# * @author Samuel Roze <samuel.roze@gmail.com>
|
||
|
|
|
||
|
|
# */
|
||
|
|
|
||
|
|
# interface SerializerInterface
|
||
|
|
|
||
|
|
# {
|
||
|
|
|
||
|
|
# /**
|
||
|
|
|
||
|
|
# * Decodes an envelope and its message from an encoded-form.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * The `$encodedEnvelope` parameter is a key-value array that
|
||
|
|
|
||
|
|
# * describes the envelope and its content, that will be used by the different
|
||
|
|
transports.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * The most common keys are:
|
||
|
|
|
||
|
|
# * - `body` (string) - the message body
|
||
|
|
|
||
|
|
# * - `headers` (string<string>) - a key/value pair of headers
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @throws MessageDecodingFailedException'
|
||
|
|
- name: encode
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: envelope
|
||
|
|
comment: '# * Encodes an envelope content (message & stamps) to a common format
|
||
|
|
understandable by transports.
|
||
|
|
|
||
|
|
# * The encoded array should only contain scalars and arrays.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * Stamps that implement NonSendableStampInterface should
|
||
|
|
|
||
|
|
# * not be encoded.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * The most common keys of the encoded array are:
|
||
|
|
|
||
|
|
# * - `body` (string) - the message body
|
||
|
|
|
||
|
|
# * - `headers` (string<string>) - a key/value pair of headers'
|
||
|
|
traits:
|
||
|
|
- Symfony\Component\Messenger\Envelope
|
||
|
|
- Symfony\Component\Messenger\Exception\MessageDecodingFailedException
|
||
|
|
interfaces: []
|