Stadly\Http\Header\Response\ETag

Complexity

Total Complexity

10

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	setEntityTag()	0	3	1
A	__toString()	0	3	1
A	getEntityTag()	0	3	1
A	fromValue()	0	9	3
A	getValue()	0	3	1
A	isValid()	0	3	1
A	getName()	0	3	1

<?php

declare(strict_types=1);

namespace Stadly\Http\Header\Response;

use Stadly\Http\Exception\InvalidHeader;
use Stadly\Http\Header\Value\EntityTag\EntityTag;
use Stadly\Http\Utilities\Rfc7232;

/**
 * Class for handling the HTTP header field ETag.
 *
 * Specification: https://tools.ietf.org/html/rfc7232#section-2.3
 */
final class ETag implements Header
{
    /**
     * @var EntityTag Entity tag.
     */
    private $entityTag;

    /**
     * Constructor.
     *
     * @param EntityTag $entityTag Entity tag.
     */
    public function __construct(EntityTag $entityTag)
    {
        $this->setEntityTag($entityTag);
    }

    /**
     * Construct header from value.
     *
     * @param string $value Header value.
     * @return self Header generated based on the value.
     * @throws InvalidHeader If the header value is invalid.
     */
    public static function fromValue(string $value): self
    {
        $regEx = '{^' . Rfc7232::ETAG . '$}';
        $plainValue = mb_convert_encoding($value, 'ISO-8859-1', 'UTF-8');
        if ($plainValue !== $value || preg_match($regEx, $value) !== 1) {
            throw new InvalidHeader('Invalid header value: ' . $value);
        }

        return new self(EntityTag::fromString($value));
    }

    /**
     * @inheritDoc
     * @throws void The header is always valid.
     */
    public function __toString(): string
    {
        return $this->getName() . ': ' . $this->getValue();
    }

    /**
     * @return true The header is always valid.
     */
    public function isValid(): bool
    {
        return true;
    }

    /**
     * @inheritDoc
     */
    public function getName(): string
    {
        return 'ETag';
    }

    /**
     * @inheritDoc
     * @throws void The header is always valid.
     */
    public function getValue(): string
    {
        return (string)$this->entityTag;
    }

    /**
     * @return EntityTag Entity tag.
     */
    public function getEntityTag(): EntityTag
    {
        return $this->entityTag;
    }

    /**
     * Set entity tag.
     *
     * @param EntityTag $entityTag Entity tag.
     */
    public function setEntityTag(EntityTag $entityTag): void
    {
        $this->entityTag = $entityTag;
    }
}