NoKeyInPayloadException::getSolution() - Code Metrics - Inspection of "Add envelope stack" - yiisoft/queue - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#188)

by Dmitriy

created 2024-01-13 16:59 UTC

NoKeyInPayloadException::getSolution() A

↳ Parent: NoKeyInPayloadException

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	8
nc	1
nop	0
dl	0
loc	10
ccs	0
cts	7
cp	0
crap	2
rs	10
c	1
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Queue\Exception;

use InvalidArgumentException;
use Throwable;
use Yiisoft\FriendlyException\FriendlyExceptionInterface;
use Yiisoft\Queue\Message\MessageSerializerInterface;

final class NoKeyInPayloadException extends InvalidArgumentException implements FriendlyExceptionInterface
{
    public function __construct(
        protected string $expectedKey,
        protected array $payload,
        int $code = 0,
        Throwable $previous = null
    ) {
        parent::__construct(
            sprintf(
                'No expected key "%s" in payload. Payload key list: "%s".',
                $expectedKey,
                implode('", "', array_keys($payload))
            ),
            $code,
            $previous
        );
    }

    /**
     * @return string
     */
    public function getName(): string
    {
        return sprintf('No key "%s" in payload', $this->expectedKey);
    }

    /**
     * @return string
     *
     * @infection-ignore-all
     */
    public function getSolution(): ?string
    {
        return sprintf(
            "We have successfully unserialized a message, but there was no expected key \"%s\".
        There are the following keys in the message: %s.
        You might want to change message's structure, or make your own implementation of %s,
        which won't rely on this key in the message.",
            $this->expectedKey,
            implode('", "', array_keys($this->payload)),
            MessageSerializerInterface::class
        );
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Yiisoft\Queue\Exception;
6
7			use InvalidArgumentException;
8			use Throwable;
9			use Yiisoft\FriendlyException\FriendlyExceptionInterface;
10			use Yiisoft\Queue\Message\MessageSerializerInterface;
11
12			final class NoKeyInPayloadException extends InvalidArgumentException implements FriendlyExceptionInterface
13			{
14			public function __construct(
15			protected string $expectedKey,
16			protected array $payload,
17			int $code = 0,
18			Throwable $previous = null
19			) {
20			parent::__construct(
21			sprintf(
22			'No expected key "%s" in payload. Payload key list: "%s".',
23			$expectedKey,
24			implode('", "', array_keys($payload))
25			),
26			$code,
27			$previous
28			);
29			}
30
31			/**
32			* @return string
33			*/
34			public function getName(): string
35			{
36			return sprintf('No key "%s" in payload', $this->expectedKey);
37			}
38
39			/**
40			* @return string
41			*
42			* @infection-ignore-all
43			*/
44			public function getSolution(): ?string
45			{
46			return sprintf(
47			"We have successfully unserialized a message, but there was no expected key \"%s\".
48			There are the following keys in the message: %s.
49			You might want to change message's structure, or make your own implementation of %s,
50			which won't rely on this key in the message.",
51			$this->expectedKey,
52			implode('", "', array_keys($this->payload)),
53			MessageSerializerInterface::class
54			);
55			}
56			}
57

yiisoft / queue

Pull Request — master (#188)

NoKeyInPayloadException::getSolution() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like