Documentation

Envelope
in package

FinalYes

A message wrapped in an envelope with stamps (configurations, markers, ...).

Tags
author

Maxime Steinhausser maxime.steinhausser@gmail.com

Table of Contents

Properties

$message  : object
$stamps  : array<string, array<int, StampInterface>>

Methods

__construct()  : mixed
all()  : array<string|int, StampInterface>|array<string|int, array<string|int, StampInterface>>
getMessage()  : object
last()  : StampInterface|null
with()  : static
Adds one or more stamps.
withoutAll()  : static
Removes all stamps of the given class.
withoutStampsOfType()  : self
Removes all stamps that implement the given type.
wrap()  : self
Makes sure the message is in an Envelope and adds the given stamps.

Properties

Methods

all()

public all([string $stampFqcn = null ]) : array<string|int, StampInterface>|array<string|int, array<string|int, StampInterface>>
Parameters
$stampFqcn : string = null
Return values
array<string|int, StampInterface>|array<string|int, array<string|int, StampInterface>>

The stamps for the specified FQCN, or all stamps by their class name

getMessage()

public getMessage() : object
Return values
object

withoutAll()

Removes all stamps of the given class.

public withoutAll(string $stampFqcn) : static
Parameters
$stampFqcn : string
Return values
static

withoutStampsOfType()

Removes all stamps that implement the given type.

public withoutStampsOfType(string $type) : self
Parameters
$type : string
Return values
self

wrap()

Makes sure the message is in an Envelope and adds the given stamps.

public static wrap(object $message[, array<string|int, StampInterface$stamps = [] ]) : self
Parameters
$message : object
$stamps : array<string|int, StampInterface> = []
Return values
self

        
On this page

Search results