0

Final Class Yiisoft\Queue\Stubs\DummyEnvelope

All Classes | Properties | Methods
InheritanceYiisoft\Queue\Stubs\DummyEnvelope » Yiisoft\Queue\Message\Envelope
ImplementsYiisoft\Queue\Message\MessageInterface

Dummy envelope stub for testing purposes.

Protected Properties

Hide inherited properties

Property Type Description Defined By
$meta array Yiisoft\Queue\Message\Envelope

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Queue\Stubs\DummyEnvelope
fromMessage() Yiisoft\Queue\Stubs\DummyEnvelope
fromPayload() Envelopes cannot be created from a raw payload. Use {@see fromMessage()} to wrap an existing message instead. Yiisoft\Queue\Message\Envelope
getMessage() Yiisoft\Queue\Message\Envelope
getMeta() Yiisoft\Queue\Message\Envelope
getPayload() Yiisoft\Queue\Message\Envelope
getType() Yiisoft\Queue\Message\Envelope
withMeta() Yiisoft\Queue\Message\Envelope

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( Yiisoft\Queue\Message\MessageInterface $message )
$message Yiisoft\Queue\Message\MessageInterface 

                public function __construct(MessageInterface $message)
{
    parent::__construct($message, []);
}
fromMessage() public static method

public static static fromMessage ( Yiisoft\Queue\Message\MessageInterface $message )
$message Yiisoft\Queue\Message\MessageInterface 

                public static function fromMessage(MessageInterface $message): static
{
    return new self($message);
}
fromPayload() public static method

Defined in: Yiisoft\Queue\Message\Envelope::fromPayload()

Envelopes cannot be created from a raw payload. Use {@see fromMessage()} to wrap an existing message instead.

public static static fromPayload ( string $type, mixed $payload )
$type string
$payload mixed
throws LogicException

Always, since this method is not supported for envelopes.

 

                final public static function fromPayload(string $type, mixed $payload): static
{
    throw new LogicException(
        'Envelopes cannot be created via "fromPayload()". Wrap an existing "MessageInterface" instance instead.',
    );
}
getMessage() public method

Defined in: Yiisoft\Queue\Message\Envelope::getMessage()

public Yiisoft\Queue\Message\MessageInterface getMessage ( )

                final public function getMessage(): MessageInterface
{
    return $this->message;
}
getMeta() public method

Defined in: Yiisoft\Queue\Message\Envelope::getMeta()

public array getMeta ( )

                final public function getMeta(): array
{
    return $this->meta;
}
getPayload() public method

Defined in: Yiisoft\Queue\Message\Envelope::getPayload()

public bool|int|float|string|array|null getPayload ( )

                final public function getPayload(): bool|int|float|string|array|null
{
    return $this->message->getPayload();
}
getType() public method

Defined in: Yiisoft\Queue\Message\Envelope::getType()

public string getType ( )

                final public function getType(): string
{
    return $this->message->getType();
}
withMeta() public method

Defined in: Yiisoft\Queue\Message\Envelope::withMeta()

public static withMeta ( array $meta )
$meta array 

                final public function withMeta(array $meta): static
{
    return static::fromMessage($this->message->withMeta($meta));
}