SprykerShop\Yves\ChartWidget\Plugin\Twig\AbstractTwigChartPlugin

Complexity

Total Complexity

7

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	3	1
A	getChartContext()	0	13	2
A	getChartFunctions()	0	7	1
A	getChartPluginByName()	0	5	1
A	getDefaultTwigOptions()	0	5	1
A	renderChart()	0	6	1

<?php

/**
 * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
 * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
 */

namespace SprykerShop\Yves\ChartWidget\Plugin\Twig;

use Spryker\Shared\Chart\Dependency\Plugin\ChartLayoutablePluginInterface;

The type Spryker\Shared\Chart\Dependency\Plugin\ChartLayoutablePluginInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Spryker\Shared\Chart\Dependency\Plugin\ChartPluginInterface;

The type Spryker\Shared\Chart\Dependency\Plugin\ChartPluginInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Spryker\Shared\Chart\Dependency\Plugin\TwigChartFunctionPluginInterface;

The type Spryker\Shared\Chart\Dependency\Plugin\TwigChartFunctionPluginInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Spryker\Yves\Kernel\AbstractPlugin;
use Twig_Environment;

The type Twig_Environment was not found. Maybe you did not declare it correctly or list all dependencies?

use Twig_SimpleFunction;

The type Twig_SimpleFunction was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * @method \SprykerShop\Yves\ChartWidget\ChartWidgetFactory getFactory()
 * @method \SprykerShop\Yves\ChartWidget\ChartWidgetConfig getConfig()
 */
abstract class AbstractTwigChartPlugin extends AbstractPlugin implements TwigChartFunctionPluginInterface
{
    public const TWIG_FUNCTION_NAME = 'chart';

    /**
     * @return string
     */
    public function getName(): string
    {
        return static::TWIG_FUNCTION_NAME;
    }

    /**
     * @return \Twig_SimpleFunction[]
     */
    public function getChartFunctions(): array
    {
        return [
            new Twig_SimpleFunction(
                static::TWIG_FUNCTION_NAME,
                [$this, 'renderChart'],
                $this->getDefaultTwigOptions()
            ),
        ];
    }

    /**
     * @param \Twig_Environment $twig
     * @param string $chartPluginName
     * @param string|null $dataIdentifier
     *
     * @return string
     */
    public function renderChart(Twig_Environment $twig, $chartPluginName, $dataIdentifier = null): string
    {
        $context = $this->getChartContext($chartPluginName, $dataIdentifier);
        $rendered = $twig->render($this->getTemplateName(), $context);

        return $rendered;
    }

    /**
     * @return string
     */
    abstract protected function getTemplateName(): string;

    /**
     * @param string $chartPluginName
     * @param string|null $dataIdentifier
     *
     * @return array
     */
    protected function getChartContext($chartPluginName, $dataIdentifier): array
    {
        $chartPlugin = $this->getChartPluginByName($chartPluginName);

        $context = [
            'data' => $chartPlugin->getChartData($dataIdentifier),
            'layout' => $this->getConfig()->getDefaultChartLayout(),
        ];
        if ($chartPlugin instanceof ChartLayoutablePluginInterface) {
            $context['layout'] = $chartPlugin->getChartLayout();
        }

        return $context;
    }

    /**
     * @return array
     */
    protected function getDefaultTwigOptions(): array
    {
        return [
            'is_safe' => ['html'],
            'needs_environment' => true,
        ];
    }

    /**
     * @param string $pluginName
     *
     * @return \Spryker\Shared\Chart\Dependency\Plugin\ChartPluginInterface
     */
    protected function getChartPluginByName($pluginName): ChartPluginInterface
    {
        return $this->getFactory()
            ->createChartPluginCollection()
            ->getChartPluginByName($pluginName);
    }
}