Spinen\BrowserFilter\Stack\Filter

Complexity

Total Complexity

5

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	8
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	generateCacheKey()	0	6	1
A	parseFilterString()	0	7	1
A	setFilterType()	0	18	3

<?php

namespace Spinen\BrowserFilter\Stack;

use Illuminate\Http\Request;
use Spinen\BrowserFilter\Exceptions\InvalidFilterTypeException;
use Spinen\BrowserFilter\Filter as CoreFilter;

/**
 * Class Filter
 *
 * @package Spinen\BrowserFilter\Stack
 */
class Filter extends CoreFilter
{
    /**
     * @inheritDoc
     */
    protected $block_filter = true;

    /**
     * @inheritDoc
     */
    public function generateCacheKey(Request $request)
    {
        // Append the rules with the version of the browser to allow new rules to bust the cache
        return md5(json_encode($this->config->get($this->config_path . 'rules', []))) .
            ':' .
            parent::generateCacheKey($request);
    }

    /**
     * @inheritDoc
     */
    public function parseFilterString($filter_string)
    {
        // NOTE: $filter_string is unused, but needed to match signature of the method.

        $this->setFilterType($this->config->get($this->config_path . 'type'));

        $this->rules = $this->config->get($this->config_path . 'rules', []);
    }

    /**
     * Set the filter type.
     *
     * @param string $type
     *
     * @return void
     *
     * @throws InvalidFilterTypeException
     */
    protected function setFilterType(string $type)
    {
        if ('allow' === $type) {
            $this->block_filter = false;

            return;
        }

        if ('block' === $type) {
            $this->block_filter = true;

            return;
        }

        throw new InvalidFilterTypeException(
            sprintf(
                "Invalid filter type [%s] was given. Only allow or block are permitted.",
                $type
            )
        );
    }
}