Yiisoft\Yii\Widgets\ContentDecorator

Complexity

Total Complexity

5

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	viewFile()	0	5	1
A	start()	0	5	1
A	params()	0	5	1
A	__construct()	0	3	1
A	run()	0	8	1

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Widgets;

use Yiisoft\View\Exception\ViewNotFoundException;
use Yiisoft\View\WebView;
use Yiisoft\Widget\Widget;

/**
 * ContentDecorator records all output between {@see begin()} and {@see end()]} calls, passes it to the given view file
 * as `$content` and then echoes rendering result.
 *
 * ```php
 * <?= ContentDecorator::begin()
 *     ->viewFile('@app/views/layouts/base.php')
 *     ->params([])
 *     ->view($this)
 *     ->start(); ?>
 *
 * some content here
 *
 * <?= ContentDecorator::end() ?>
 * ```
 */
class ContentDecorator extends Widget
{
    /**
     * @var array the parameters (name => value) to be extracted and made available in the decorative view.
     */
    private array $params = [];

    /**
     * @var string the view file that will be used to decorate the content enclosed by this widget. This can be
     * specified as either the view file path or alias path.
     */
    private ?string $viewFile = null;

    private WebView $webView;

    public function __construct(WebView $webView)
    {
        $this->webView = $webView;
    }

    public function start(): void
    {
        /* Starts recording a clip. */
        ob_start();
        ob_implicit_flush(0);
    }

    /**
     * Ends recording a clip.
     *
     * This method stops output buffering and saves the rendering result as a named clip in the controller.
     *
     * @return string the result of widget execution to be outputted.
     */
    public function run(): string
    {
        $params = $this->params;

        $params['content'] = ob_get_clean();

        /* render under the existing context */
        return $this->webView->renderFile($this->viewFile, $params);

It seems like $this->viewFile can also be of type null; however, parameter $viewFile of Yiisoft\View\View::renderFile() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * {@see $params}
     *
     * @param array $value
     *
     * @return ContentDecorator
     */
    public function params(array $value): ContentDecorator
    {
        $this->params = $value;

        return $this;
    }

    /**
     * {@see $viewFile}
     *
     * @param string $value
     *
     * @return ContentDecorator
     */
    public function viewFile(string $value): ContentDecorator
    {
        $this->viewFile = $value;

        return $this;
    }
}