EnvelopeTrait::getMetadata() - Code Metrics - Inspection of "Allow to restore original pushed message class on..." - yiisoft/queue - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#214)

by Alexander

created 2024-09-15 17:28 UTC

EnvelopeTrait::getMetadata() A

↳ Parent: EnvelopeTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	6
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	11
ccs	10
cts	10
cp	1
crap	1
rs	10

<?php

declare(strict_types=1);

namespace Yiisoft\Queue\Message;

trait EnvelopeTrait
{
    private MessageInterface $message;

    /**
     * A mirror of {@see MessageInterface::fromData()}
     */
    abstract public static function fromMessage(MessageInterface $message): self;

    public static function fromData(string $handlerName, mixed $data, array $metadata = []): MessageInterface
    {
        $message = new Message($handlerName, $data, $metadata);

        return self::fromMessage($message);

    }

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

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

        return $instance;
    }

    public function getHandlerName(): string
    {
        return $this->message->getHandlerName();
    }

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

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

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

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


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Queue\Message;
6
7		trait EnvelopeTrait
8		{
9		private MessageInterface $message;
10
11		/**
12		* A mirror of {@see MessageInterface::fromData()}
13		*/
14		abstract public static function fromMessage(MessageInterface $message): self;
15
16		public static function fromData(string $handlerName, mixed $data, array $metadata = []): MessageInterface
17		{
18		$message = new Message($handlerName, $data, $metadata);
19
20		return self::fromMessage($message);
		0 ignored issues – show Bug Best Practice introduced 2024-09-15 17:30 UTC by Report Bug Copy Issue Report The expression `return self::fromMessage($message)` returns the type `Yiisoft\Queue\Message\EnvelopeTrait` which is incompatible with the type-hinted return `Yiisoft\Queue\Message\MessageInterface`. Loading history...
21		}
22
23	5	public function getMessage(): MessageInterface
24		{
25	5	return $this->message;
26		}
27
28		public function withMessage(MessageInterface $message): self
29		{
30		$instance = clone $this;
31		$instance->message = $message;
32
33		return $instance;
34		}
35
36	9	public function getHandlerName(): string
37		{
38	9	return $this->message->getHandlerName();
39		}
40
41	5	public function getData(): mixed
42		{
43	5	return $this->message->getData();
44		}
45
46	13	public function getMetadata(): array
47		{
48	13	return array_merge(
49	13	$this->message->getMetadata(),
50	13	[
51	13	self::ENVELOPE_STACK_KEY => array_merge(
		0 ignored issues – show Bug introduced 2024-01-13 16:13 UTC by Report Bug Copy Issue Report The constant `Yiisoft\Queue\Message\En...ait::ENVELOPE_STACK_KEY` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
52	13	$this->message->getMetadata()[self::ENVELOPE_STACK_KEY] ?? [],
53	13	[self::class],
54	13	),
55	13	],
56	13	$this->getEnvelopeMetadata(),
57	13	);
58		}
59
60		public function getEnvelopeMetadata(): array
61		{
62		return [];
63		}
64		}
65

yiisoft / queue

Pull Request — master (#214)

EnvelopeTrait::getMetadata() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like