ChannelIncorrectlyConfigured::getSolution() - Code Metrics - yiisoft/queue - Measure and Improve Code Quality continuously with Scrutinizer

ChannelIncorrectlyConfigured::getSolution() A
last analyzed 2024-09-15 17:36 UTC

↳ Parent: ChannelIncorrectlyConfigured

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Yiisoft\Queue\Exception\AdapterConfiguration;

use InvalidArgumentException;
use Throwable;
use Yiisoft\FriendlyException\FriendlyExceptionInterface;
use Yiisoft\Queue\Adapter\AdapterInterface;
use Yiisoft\Queue\QueueFactory;

class ChannelIncorrectlyConfigured extends InvalidArgumentException implements FriendlyExceptionInterface
{
    private string $channel;

    /**
     * ChannelIncorrectlyConfigured constructor.
     *
     * @param mixed|object $definition
     * @param Throwable|null $previous
     */
    public function __construct(string $channel, $definition, int $code = 0, ?Throwable $previous = null)
    {
        $adapterClass = AdapterInterface::class;
        $realType = get_debug_type($definition);
        $message = "Channel \"$channel\" is not properly configured: definition must return $adapterClass, $realType returned";

        $this->channel = $channel;
        parent::__construct($message, $code, $previous);
    }

    public function getName(): string
    {
        return 'Incorrect queue channel configuration';
    }

    public function getSolution(): ?string
    {
        $factoryClass = QueueFactory::class;

        return <<<SOLUTION
            You tried to get a Queue object for channel "$this->channel" which is incorrectly configured.
            Please take a look to the documentation for the $factoryClass "\$definitions" constructor parameter.
            SOLUTION;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Queue\Exception\AdapterConfiguration;
6
7		use InvalidArgumentException;
8		use Throwable;
9		use Yiisoft\FriendlyException\FriendlyExceptionInterface;
10		use Yiisoft\Queue\Adapter\AdapterInterface;
11		use Yiisoft\Queue\QueueFactory;
12
13		class ChannelIncorrectlyConfigured extends InvalidArgumentException implements FriendlyExceptionInterface
14		{
15		private string $channel;
16
17		/**
18		* ChannelIncorrectlyConfigured constructor.
19		*
20		* @param mixed\|object $definition
21		* @param Throwable\|null $previous
22		*/
23	1	public function __construct(string $channel, $definition, int $code = 0, ?Throwable $previous = null)
24		{
25	1	$adapterClass = AdapterInterface::class;
26	1	$realType = get_debug_type($definition);
27	1	$message = "Channel \"$channel\" is not properly configured: definition must return $adapterClass, $realType returned";
28
29	1	$this->channel = $channel;
30	1	parent::__construct($message, $code, $previous);
31		}
32
33	1	public function getName(): string
34		{
35	1	return 'Incorrect queue channel configuration';
36		}
37
38	1	public function getSolution(): ?string
39		{
40	1	$factoryClass = QueueFactory::class;
41
42	1	return <<<SOLUTION
43	1	You tried to get a Queue object for channel "$this->channel" which is incorrectly configured.
44	1	Please take a look to the documentation for the $factoryClass "\$definitions" constructor parameter.
45	1	SOLUTION;
46		}
47		}
48

yiisoft / queue

ChannelIncorrectlyConfigured::getSolution() A last analyzed 2024-09-15 17:36 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ChannelIncorrectlyConfigured::getSolution() A
last analyzed 2024-09-15 17:36 UTC