Stadly\Http\Header\Value\CacheControl\IntegerDirective

Complexity

Total Complexity

18

Size/Duplication

Total Lines	101
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	__toString()	0	3	1
B	fromString()	0	19	7
A	getValue()	0	3	1
A	setName()	0	15	5
A	setValue()	0	9	3

<?php

declare(strict_types=1);

namespace Stadly\Http\Header\Value\CacheControl;

use InvalidArgumentException;
use Stadly\Http\Utilities\Rfc7230;
use Stadly\Http\Utilities\Rfc7234;

/**
 * Class for handling cache control directives with integer value.
 *
 * Specification: https://tools.ietf.org/html/rfc7234#section-5.2.2
 */
final class IntegerDirective extends Directive
{
    public const RESERVED_NAMES = [
        'max-age',
        's-maxage',
    ];

    /**
     * @var string Value.
     */
    private $value;

    /**
     * Constructor.
     *
     * @param string $name Name.
     * @param string $value Value.
     */
    public function __construct(string $name, string $value)
    {
        $this->setName($name);
        $this->setValue($value);
    }

    /**
     * Construct directive from string.
     *
     * @param string $directive Directive string.
     * @return self Directive generated based on the string.
     */
    public static function fromString(string $directive): self
    {
        $regEx = '{^' . Rfc7234::CACHE_DIRECTIVE_CAPTURE . '$}';
        $plainDirective = mb_convert_encoding($directive, 'ISO-8859-1', 'UTF-8');
        if ($plainDirective !== $directive || preg_match($regEx, $directive, $matches) !== 1) {
            throw new InvalidArgumentException('Invalid directive: ' . $directive);
        }

        if (!isset($matches['VALUE'])) {
            throw new InvalidArgumentException('Directive must have value');
        }

        $value = $matches['VALUE'];
        // Strip slashes if value is quoted.
        if (mb_strlen($value) >= 2 && mb_substr($value, 0, 1) === '"' && mb_substr($value, -1) === '"') {
            $value = stripslashes(mb_substr($value, 1, -1));
        }

        return new self($matches['NAME'], $value);
    }

    /**
     * @inheritDoc
     */
    public function __toString(): string
    {
        return $this->name . '=' . $this->value;
    }

    /**
     * @param string $name Name.
     */
    public function setName(string $name): void
    {
        $plainName = mb_convert_encoding($name, 'ISO-8859-1', 'UTF-8');
        if ($plainName !== $name || preg_match('{^' . Rfc7230::TOKEN . '$}', $name) !== 1) {
            throw new InvalidArgumentException('Invalid name: ' . $name);
        }

        if (in_array(strtolower($name), FieldListDirective::RESERVED_NAMES, /*strict*/true)) {
            throw new InvalidArgumentException('Name reserved for field list directive: ' . $name);
        }
        if (in_array(strtolower($name), ValuelessDirective::RESERVED_NAMES, /*strict*/true)) {
            throw new InvalidArgumentException('Name reserved for valueless directive: ' . $name);
        }

        $this->name = $name;
    }

    /**
     * @return string Value.
     */
    public function getValue(): string
    {
        return $this->value;
    }

    /**
     * Set the value. It must be a non-negative integer string.
     *
     * @param string $value Value.
     */
    public function setValue(string $value): void
    {
        $regEx = '{^' . Rfc7234::DELTA_SECONDS . '$}';
        $plainValue = mb_convert_encoding($value, 'ISO-8859-1', 'UTF-8');
        if ($plainValue !== $value || preg_match($regEx, $value) !== 1) {
            throw new InvalidArgumentException('Invalid value: ' . $value);
        }

        $this->value = $value;
    }
}