Stadly\Http\Header\Value\CacheControl\GeneralDirective

Complexity

Total Complexity

23

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setValue()	0	12	4
A	getValue()	0	3	1
A	__toString()	0	7	2
A	setName()	0	17	6
A	encodeValue()	0	8	2
B	fromString()	0	18	7

<?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 optional value.
 *
 * Specification: https://tools.ietf.org/html/rfc7234#section-5.2.2
 */
final class GeneralDirective extends Directive
{
    /**
     * @var string|null Value.
     */
    private $value;

    /**
     * Constructor.
     *
     * @param string $name Name.
     * @param string|null $value Value.
     */
    public function __construct(string $name, ?string $value = null)
    {
        $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 . '$}';
        if (utf8_decode($directive) !== $directive || preg_match($regEx, $directive, $matches) !== 1) {
            throw new InvalidArgumentException('Invalid directive: ' . $directive);
        }

        if (!isset($matches['VALUE'])) {
            return new self($matches['NAME'], /*value*/null);
        }

        $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
    {
        if ($this->value === null) {
            return $this->name;
        }

        return $this->name . '=' . self::encodeValue($this->value);
    }

    /**
     * @param string $name Name.
     */
    public function setName(string $name): void
    {
        if (utf8_decode($name) !== $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), IntegerDirective::RESERVED_NAMES, /*strict*/true)) {
            throw new InvalidArgumentException('Name reserved for integer directive: ' . $name);
        }
        if (in_array(strtolower($name), ValuelessDirective::RESERVED_NAMES, /*strict*/true)) {
            throw new InvalidArgumentException('Name reserved for valueless directive: ' . $name);
        }

        $this->name = $name;
    }

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

    /**
     * @param string|null $value Value.
     */
    public function setValue(?string $value): void
    {
        if ($value !== null) {
            $encodedValue = self::encodeValue($value);

            $regEx = '{^(?:' . Rfc7230::TOKEN . '|' . Rfc7230::QUOTED_STRING . ')$}';
            if (utf8_decode($encodedValue) !== $encodedValue || preg_match($regEx, $encodedValue) !== 1) {
                throw new InvalidArgumentException('Invalid value: ' . $value);
            }
        }

        $this->value = $value;
    }

    /**
     * @param string $value Value.
     * @return string Encoded value.
     */
    private static function encodeValue(string $value): string
    {
        if (preg_match('{^' . Rfc7230::TOKEN . '$}', $value) === 1) {
            return $value;
        }

        // If value is not a valid token, turn it into a quoted token.
        return '"' . addslashes($value) . '"';
    }
}