Yiisoft\Widget\WidgetFactoryInitializationException

Complexity

Total Complexity

2

Size/Duplication

Total Lines	10
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

2 Methods

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

<?php

declare(strict_types=1);

namespace Yiisoft\Widget;

use RuntimeException;
use Yiisoft\FriendlyException\FriendlyExceptionInterface;

/**
 * @deprecated Will be removed in version 3.0.
 */
final class WidgetFactoryInitializationException extends RuntimeException implements FriendlyExceptionInterface
{
    public function getName(): string
    {
        return 'Failed to create a widget because WidgetFactory is not initialized.';
    }

    public function getSolution(): ?string
    {
        return <<<'SOLUTION'
To initialize the widget factory call `WidgetFactory::initialize()` before using the widget.
It is a good idea to do that for the whole application.

Example:

```php
/**
 * @var Psr\Container\ContainerInterface $container
 */

Yiisoft\Widget\WidgetFactory::initialize(
    container: $container,
    definitions: [MyWidget::class => new MyWidget(/*...*/)],
    themes: [
        'custom' => [
            MyWidget::class => [
                'setValue()' => [42],
            ],
        ],
    ],
    validate: true, // Whether definitions need to be validated.
);
```

See Yii example in the configuration file of this package `config/bootstrap.php`.
SOLUTION;
    }
}