Yiisoft\Widget\ContentDecorator

Complexity

Total Complexity

5

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

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

<?php
declare(strict_types = 1);

namespace Yiisoft\Widget;

use Yiisoft\View\WebView;

/**
 * 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
 * <?php ContentDecorator::begin()
 *     ->viewFile('@app/views/layouts/base.php'),
 *     ->params([]),
 *     ->view($this),
 * ]) ?>
 *
 * some content here
 *
 * <?php ContentDecorator::end() ?>
 * ```
 *
 * There are {@see \Yiisoft\View\View::beginContent()} and {@see \Yiisoft\View\View::endContent()} wrapper methods in
 * the {@see \Yiisoft\View\View} component to make syntax more friendly. In the view these could be used as follows:
 *
 * ```php
 * <?php $this->beginContent('@app/views/layouts/base.php') ?>
 *
 * some content here
 *
 * <?php $this->endContent() ?>
 * ```
 *
 * @method static ContentDecorator begin()
 * @method static ContentDecorator end()
 */
class ContentDecorator extends Widget
{
    /**
     * @var array the parameters (name => value) to be extracted and made available in the decorative view.
     */
    private $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 $viewFile;

    /**
     * @param WebView $webView
     */
    private $webView;

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

    public function init(): 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);
    }

    public function params(array $value): self
    {
        $this->params = $value;

        return $this;
    }

    public function viewFile(string $value): self
    {
        $this->viewFile = $value;

        return $this;
    }
}