Yiisoft\Queue\Message\HandlerEnvelope

Complexity

Total Complexity

5

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getEnvelopeMetadata()	0	4	1
A	getHandler()	0	4	2
A	setHandler()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Queue\Message;

/**
 * ID envelope allows to identify a message.
 */
final class HandlerEnvelope implements EnvelopeInterface
{
    use EnvelopeTrait;

    public const HANDLER_CLASS_KEY = 'handler_class';

    public function __construct(
        private MessageInterface $message,
        private string $handlerClass = '',
    ) {
    }

    /**
     * @psalm-param class-string<MessageHandlerInterface> $handlerClass
     */
    public function setHandler(string $handlerClass): void
    {
        $this->handlerClass = $handlerClass;
    }

    /**
     * @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
    {
        /** @psalm-suppress LessSpecificReturnStatement  */
        return $this->handlerClass ?: $this->message->getMetadata()[self::HANDLER_CLASS_KEY];
    }

    public function getEnvelopeMetadata(): array
    {
        return [
            self::HANDLER_CLASS_KEY => $this->handlerClass,
        ];
    }
}