kalanis\kw_templates\GroupedTemplate

Complexity

Total Complexity

5

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	resetItems()	0	4	1
A	selectTemplate()	0	7	2
A	loadTemplate()	0	6	2

<?php

namespace kalanis\kw_templates;


/**
 * Class GroupedTemplate
 * @package kalanis\kw_templates
 * Load external source as template
 */
abstract class GroupedTemplate extends ATemplate
{
    /** @var array<string, string> */
    protected static array $knownTemplates;

    protected function loadTemplate(): string
    {
        if (empty(static::$knownTemplates)) {
            static::$knownTemplates = $this->defineAvailableTemplates();
        }
        return '';
    }

    /**
     * Define templates available from this class
     * array key is to select one, value is for content
     * @return array<string, string>
     */
    abstract protected function defineAvailableTemplates(): array;

    protected function resetItems(): self
    {
        $this->items = [];
        return $this;
    }

    /**
     * @param string $key
     * @throws TemplateException
     * @return $this
     * Call only from method in extending class and be prepared for resetting items due unavailability some of them
     */
    protected function selectTemplate(string $key): self
    {
        if (!isset(static::$knownTemplates[$key])) {
            throw new TemplateException(sprintf('Unknown template %s from group %s', $key, get_class($this)));
        }
        $this->setTemplate(static::$knownTemplates[$key]);
        return $this;
    }
}