Core23\MatomoBundle\Block\Service\MatomoStatisticBlockService

Complexity

Total Complexity

7

Size/Duplication

Total Lines	161
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	execute()	0	9	1
B	buildEditForm()	0	64	1
A	configureSettings()	0	18	1
A	getBlockMetadata()	0	6	1
A	getData()	0	20	2

<?php

declare(strict_types=1);

/*
 * (c) Christian Gripp <mail@core23.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Core23\MatomoBundle\Block\Service;

use Core23\MatomoBundle\Client\ClientFactoryInterface;
use Core23\MatomoBundle\Exception\MatomoException;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\NullLogger;
use Sonata\AdminBundle\Form\FormMapper;
use Sonata\BlockBundle\Block\BlockContextInterface;
use Sonata\BlockBundle\Block\Service\AbstractAdminBlockService;
use Sonata\BlockBundle\Model\BlockInterface;
use Sonata\CoreBundle\Form\Type\ImmutableArrayType;
use Sonata\CoreBundle\Model\Metadata;
use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Extension\Core\Type\NumberType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\OptionsResolver\OptionsResolver;

final class MatomoStatisticBlockService extends AbstractAdminBlockService implements LoggerAwareInterface
{
    use LoggerAwareTrait;

    /**
     * @var ClientFactoryInterface
     */
    private $factory;

    /**
     * @param string                 $name
     * @param EngineInterface        $templating
     * @param ClientFactoryInterface $factory
     */
    public function __construct(string $name, EngineInterface $templating, ClientFactoryInterface $factory)
    {
        parent::__construct($name, $templating);

        $this->factory = $factory;
        $this->logger  = new NullLogger();
    }

    /**
     * {@inheritdoc}
     */
    public function execute(BlockContextInterface $blockContext, Response $response = null)
    {
        return $this->renderResponse($blockContext->getTemplate(), [
            'context'  => $blockContext,
            'settings' => $blockContext->getSettings(),
            'block'    => $blockContext->getBlock(),
            'data'     => $this->getData($blockContext->getSettings()),
        ], $response);
    }

    /**
     * {@inheritdoc}
     */
    public function buildEditForm(FormMapper $formMapper, BlockInterface $block): void
    {
        $formMapper->add('settings', ImmutableArrayType::class, [
            'keys' => [
                ['title', TextType::class, [
                    'required' => false,
                    'label'    => 'form.label_title',
                ]],
                ['translation_domain', TextType::class, [
                    'label'    => 'form.label_translation_domain',
                    'required' => false,
                ]],
                ['icon', TextType::class, [
                    'label'    => 'form.label_icon',
                    'required' => false,
                ]],
                ['class', TextType::class, [
                    'label'    => 'form.label_class',
                    'required' => false,
                ]],
                ['host', TextType::class, [
                    'required' => false,
                    'label'    => 'form.label_host',
                ]],
                ['token', TextType::class, [
                    'required' => false,
                    'label'    => 'form.label_token',
                ]],
                ['site', NumberType::class, [
                    'label' => 'form.label_site',
                ]],
                ['method', ChoiceType::class, [
                    'choices' => [
                        'form.choice_visitors'        => 'VisitsSummary.getVisits',
                        'form.choice_unique_visitors' => 'VisitsSummary.getUniqueVisitors',
                        'form.choice_hits'            => 'VisitsSummary.getActions ',
                    ],
                    'label' => 'form.label_method',
                ]],
                ['period', ChoiceType::class, [
                    'choices' => [
                        'form.choice_day'   => 'day',
                        'form.choice_week'  => 'week',
                        'form.choice_month' => 'month',
                        'form.choice_year'  => 'year',
                    ],
                    'label' => 'form.label_period',
                ]],
                ['date', ChoiceType::class, [
                    'choices' => [
                        'form.choice_today'    => 'last1',
                        'form.choice_1_week'   => 'last7',
                        'form.choice_2_weeks'  => 'last14',
                        'form.choice_1_month'  => 'last30',
                        'form.choice_3_months' => 'last90',
                        'form.choice_6_months' => 'last180',
                        'form.choice_1_year'   => 'last360',
                    ],
                    'label' => 'form.label_date',
                ]],
            ],
            'translation_domain' => 'Core23MatomoBundle',
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public function configureSettings(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'title'              => null,
            'translation_domain' => null,
            'icon'               => 'fa fa-bar-chart-o',
            'class'              => null,
            'site'               => null,
            'method'             => 'VisitsSummary.getVisits',
            'host'               => null,
            'token'              => null,
            'period'             => 'day',
            'date'               => 'last30',
            'template'           => '@Core23Matomo/Block/block_matomo_statistic.html.twig',
        ]);

        $resolver->setRequired(['site', 'host', 'token']);
    }

    /**
     * {@inheritdoc}
     */
    public function getBlockMetadata($code = null)
    {
        return new Metadata($this->getName(), $code ?? $this->getName(), false, 'Core23MatomoBundle', [
            'class' => 'fa fa-area-chart',
        ]);
    }

    /**
     * @param array $settings
     *
     * @return array|null
     */
    protected function getData(array $settings = []): ?array
    {
        try {
            $client = $this->factory->createClient($settings['host'], $settings['token']);

            $response = $client->call($settings['method'], [
                'idSite' => $settings['site'],
                'period' => $settings['period'],
                'date'   => $settings['date'],
            ]);

            return $response;
        } catch (MatomoException $ce) {
            $this->logger->warning('Error retrieving Matomo url: '.$settings['host'], [
                'exception' => $ce,
            ]);
        }

        return null;
    }
}