Sauls\Component\Widget\Widgets\CacheableWidget

Complexity

Total Complexity

7

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	1	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	render()	0	12	1
A	resolveContentToCache()	0	10	2
A	configureOptions()	0	20	1
A	createKey()	0	7	1
A	getName()	0	3	1

<?php
/**
 * This file is part of the sauls/widget package.
 *
 * @author    Saulius Vaičeliūnas <vaiceliunas@inbox.lt>
 * @link      http://saulius.vaiceliunas.lt
 * @copyright 2020
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Sauls\Component\Widget\Widgets;

use Psr\Cache\InvalidArgumentException;
use Sauls\Component\Widget\Exception\WidgetFactoryIsNullException;
use Sauls\Component\Widget\Factory\Traits\WidgetFactoryAwareTrait;
use Sauls\Component\Widget\Named;
use Sauls\Component\Widget\Widget;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Contracts\Cache\CacheInterface;
use Symfony\Contracts\Cache\ItemInterface;

use function json_encode;
use function sprintf;

class CacheableWidget extends Widget implements Named
{
    use WidgetFactoryAwareTrait;

    public static $prefix = 'cw';
    public static $total = 0;
    private CacheInterface $cache;

    public function __construct(CacheInterface $cache)
    {
        $this->cache = $cache;
    }

    /**
     * @throws InvalidArgumentException
     */
    public function render(): string
    {
        $self = $this;

        return $this->cache->get(
                $this->createKey(),
                function (ItemInterface $item) use ($self) {
                    $item->expiresAfter($self->getOption('ttl'));

                    return $self->resolveContentToCache();
                }
            ) ?? '';
    }

    private function createKey(): string
    {
        return sprintf(
            '__%1$s%2$s__%3$s__',
            $this->getOption('namespace') . self::$prefix,
            md5($this->getOption('widget.id') . json_encode($this->getOptions())),
            $this->getId()
        );
    }

    private function resolveContentToCache(): string
    {
        if (null === $this->widgetFactory) {
            throw new WidgetFactoryIsNullException('Widget factory is needed for this widget to work properly');
        }

        return (string)$this->widgetFactory->create(
                $this->getOption('widget.id') ?? '',
                $this->getOption('widget.options') ?? []
            ) ?? '';
    }

    public function getName(): string
    {
        return 'cacheable_widget';
    }

    protected function configureOptions(OptionsResolver $resolver): void
    {
        $resolver
            ->setDefined(
                [
                    'widget',
                    'namespace',
                    'ttl',
                ]
            )
            ->addAllowedTypes('widget', ['array'])
            ->addAllowedTypes('namespace', ['string'])
            ->addAllowedTypes('ttl', ['int'])
            ->setDefaults(
                [
                    'namespace' => '__widget__',
                    'ttl' => 3600,
                    'widget' => [
                        'id' => '',
                        'options' => [],
                    ],
                ]
            );
    }
}