Yiisoft\Queue\Message\EnvelopeTrait

Complexity

Total Complexity

11

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Test Coverage

Coverage

60%

Importance

Changes	3
Bugs	1	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	withData()	0	6	1
A	withMessage()	0	6	1
A	getData()	0	3	1
A	withQueue()	0	6	1
A	getMessage()	0	7	2
A	getHandler()	0	3	1
A	withMetadata()	0	6	1
A	getMetadata()	0	11	1
A	getEnvelopeMetadata()	0	3	1
A	fromMessage()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Queue\Message;

use Yiisoft\Queue\QueueInterface;

trait EnvelopeTrait
{
    private MessageInterface $message;

    public function getMessage(): MessageInterface
    {
        $message = $this->message;
        while ($message instanceof EnvelopeInterface) {
            $message = $message->getMessage();
        }
        return $message;
    }

    public function withMessage(MessageInterface $message): self
    {
        $instance = clone $this;
        $instance->message = $message;

        return $instance;
    }

    /**
     * @return class-string<MessageHandlerInterface>

The doc comment class-string<MessageHandlerInterface> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<MessageHandlerInterface>.

     */
    public function getHandler(): string
    {
        return $this->message->getHandler();

The method getHandler() does not exist on Yiisoft\Queue\Message\MessageInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Yiisoft\Queue\Message\EnvelopeInterface or Yiisoft\Queue\Message\Message. Are you sure you never get one of those?

    }

    public function getData(): mixed
    {
        return $this->message->getData();
    }

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

The call to Yiisoft\Queue\Message\EnvelopeTrait::__construct() has too many arguments starting with $message.

    }

    public function getMetadata(): array
    {
        return array_merge(
            $this->message->getMetadata(),
            [
                self::ENVELOPE_STACK_KEY => array_merge(

The constant Yiisoft\Queue\Message\EnvelopeTrait::ENVELOPE_STACK_KEY was not found. Maybe you did not declare it correctly or list all dependencies?

                    $this->message->getMetadata()[self::ENVELOPE_STACK_KEY] ?? [],
                    [self::class],
                ),
            ],
            $this->getEnvelopeMetadata(),
        );
    }

    public function getEnvelopeMetadata(): array
    {
        return [];
    }

    public function withData(mixed $data): self
    {
        $instance = clone $this;
        $instance->message = $instance->message->withData($data);

        return $instance;
    }

    public function withMetadata(array $metadata): self
    {
        $instance = clone $this;
        $instance->message = $instance->message->withMetadata($metadata);

        return $instance;
    }

    public function withQueue(QueueInterface $queue): self
    {
        $instance = clone $this;
        $instance->message = $instance->message->withQueue($queue);

The method withQueue() does not exist on Yiisoft\Queue\Message\MessageInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Yiisoft\Queue\Message\EnvelopeInterface or Yiisoft\Queue\Message\Message. Are you sure you never get one of those?

        return $instance;
    }
}