Yiisoft\View\Cache\DynamicContent

Complexity

Total Complexity

4

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	placeholder()	0	3	1
A	content()	0	3	1
A	__construct()	0	6	1
A	id()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\View\Cache;

/**
 * `DynamicContent` generates data for dynamic content that is used for cached content {@see CachedContent}.
 */
final class DynamicContent
{
    /**
     * @var callable
     */
    private $contentGenerator;

    /**
     * @param string $id The unique identifier of the dynamic content.
     * @param callable $contentGenerator PHP callable with the signature: `function (array $parameters = []): string;`.
     * @param array $parameters The parameters (name-value pairs) that will be passed in the $contentGenerator context.
     */
    public function __construct(
        private string $id,
        callable $contentGenerator,
        private array $parameters = []
    ) {
        $this->contentGenerator = $contentGenerator;
    }

    /**
     * Returns a unique identifier of the dynamic content.
     *
     * @return string The unique identifier of the dynamic content.
     */
    public function id(): string
    {
        return $this->id;
    }

    /**
     * Generates the dynamic content.
     *
     * @return string The generated dynamic content.
     *
     * @psalm-suppress MixedInferredReturnType, MixedReturnStatement
     */
    public function content(): string
    {
        return ($this->contentGenerator)($this->parameters);
    }

    /**
     * Returns the placeholder of the dynamic content.
     *
     * @return string The placeholder of the dynamic content.
     */
    public function placeholder(): string
    {
        return "<![CDATA[YII-DYNAMIC-$this->id]]>";
    }
}