Passed
Push — master ( 247ff3...7b0944 )
by Alexander
15:56 queued 13:36
created

WidgetFactoryInitializationException::getName()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 1
c 1
b 0
f 0
nc 1
nop 0
dl 0
loc 3
ccs 2
cts 2
cp 1
crap 1
rs 10
1
<?php
2
3
declare(strict_types=1);
4
5
namespace Yiisoft\Widget;
6
7
use RuntimeException;
8
use Yiisoft\FriendlyException\FriendlyExceptionInterface;
9
10
final class WidgetFactoryInitializationException extends RuntimeException implements FriendlyExceptionInterface
11
{
12 1
    public function getName(): string
13
    {
14 1
        return 'Failed to create a widget because WidgetFactory is not initialized.';
15
    }
16
17
    public function getSolution(): ?string
18
    {
19
        return <<<'SOLUTION'
20
To initialize the widget factory call `WidgetFactory::initialize()` before using the widget.
21
It is a good idea to do that for the whole application.
22
23
Example:
24
25
```php
26
/**
27
 * @var Psr\Container\ContainerInterface $container
28
 */
29
30
Yiisoft\Widget\WidgetFactory::initialize(
31
    $container,
32
    [MyWidget::class, => new MyWidget(/*...*/)],
33
    true, // Whether definitions need to be validated.
34
);
35
```
36
37
See Yii example in the configuration file of this package `config/bootstrap.php`.
38
SOLUTION;
39
    }
40
}
41