WebHemi\Renderer\Helper\DefinedHelper

Complexity

Total Complexity

6

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	4	1
A	getDefinition()	0	4	1
A	getDescription()	0	5	1
A	getOptions()	0	4	1
A	__construct()	0	13	1
A	__invoke()	0	15	1

<?php
/**
 * WebHemi.
 *
 * PHP version 7.1
 *
 * @copyright 2012 - 2017 Gixx-web (http://www.gixx-web.com)
 * @license   https://opensource.org/licenses/MIT The MIT License (MIT)
 *
 * @link      http://www.gixx-web.com
 */
declare(strict_types = 1);

namespace WebHemi\Renderer\Helper;

use WebHemi\Configuration\ServiceInterface as ConfigurationInterface;
use WebHemi\Environment\ServiceInterface as EnvironmentInterface;
use WebHemi\Renderer\HelperInterface;
use WebHemi\Renderer\Traits\GetSelectedThemeResourcePathTrait;

/**
 * Class DefinedHelper.
 */
class DefinedHelper implements HelperInterface
{
    /** @var string */
    private $templateViewPath;
    /** @var string */
    private $defaultTemplateViewPath;

    use GetSelectedThemeResourcePathTrait;

    /**
     * Should return the name of the helper.
     *
     * @return string
     * @codeCoverageIgnore - plain text
     */
    public static function getName() : string
    {
        return 'defined';
    }

    /**
     * Should return the name of the helper.
     *
     * @return string
     * @codeCoverageIgnore - plain text
     */
    public static function getDefinition() : string
    {
        return '{% if defined("templateFileName") %}';
    }

    /**
     * Should return a description text.
     *
     * @return string
     * @codeCoverageIgnore - plain text
     */
    public static function getDescription() : string
    {
        return 'Checks if the given filepath exists in the template\'s path. Use @WebHemi for the default theme and '
            . '@Theme for the actual (custom) theme.';
    }

    /**
     * Gets helper options for the render.
     *
     * @return array
     * @codeCoverageIgnore - empty array
     */
    public static function getOptions() : array
    {
        return [];
    }

    /**
     * DefinedHelper constructor.
     *
     * @param ConfigurationInterface $configuration
     * @param EnvironmentInterface   $environmentManager
     */
    public function __construct(ConfigurationInterface $configuration, EnvironmentInterface $environmentManager)
    {
        $documentRoot = $environmentManager->getDocumentRoot();
        $selectedTheme = $environmentManager->getSelectedTheme();
        $selectedThemeResourcePath = $this->getSelectedThemeResourcePath(
            $selectedTheme,
            $configuration,
            $environmentManager
        );

        $this->defaultTemplateViewPath = $documentRoot.EnvironmentInterface::DEFAULT_THEME_RESOURCE_PATH.'/view';
        $this->templateViewPath = $documentRoot.$selectedThemeResourcePath.'/view';
    }

    /**
     * A renderer helper should be called with its name.
     *
     * @return bool
     */
    public function __invoke() : bool
    {
        $fileName = func_get_args()[0];
        $pattern = [
            '@WebHemi',
            '@Theme',
        ];
        $replacement = [
            $this->defaultTemplateViewPath,
            $this->templateViewPath,
        ];

        $fileName = str_replace($pattern, $replacement, $fileName);
        return file_exists($fileName);
    }
}