Yiisoft\Queue\Exception\AdapterConfiguration\AdapterNotConfiguredException

Complexity

Total Complexity

2

Size/Duplication

Total Lines	24
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getSolution()	0	15	1
A	getName()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Queue\Exception\AdapterConfiguration;

use RuntimeException;
use Yiisoft\FriendlyException\FriendlyExceptionInterface;
use Yiisoft\Queue\Queue;
use Yiisoft\Queue\QueueFactory;

class AdapterNotConfiguredException extends RuntimeException implements FriendlyExceptionInterface
{
    protected $message = 'Queue adapter is not configured';

    public function getName(): string
    {
        return 'Adapter is not configured';
    }

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

        return <<<SOLUTION
            Adapter property must be set in the Queue object before you can use it.
            Please use either a constructor "\$adapter" parameter, or "withAdapter()" queue method
            to set an appropriate adapter.
            A more convenient way to get a configured Queue is a QueueFactory usage.

            References:
            - $queueClass::\$adapter
            - $queueClass::withAdapter()
            - $factoryClass::get()
            SOLUTION;
    }
}