Sunrise\Http\Message\Header\WarningHeader

Complexity

Total Complexity

7

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	validateCode()	0	7	3
A	getFieldName()	0	3	1
A	getFieldValue()	0	9	2

<?php declare(strict_types=1);

/**
 * It's free open-source software released under the MIT License.
 *
 * @author Anatoly Nekhay <afenric@gmail.com>
 * @copyright Copyright (c) 2018, Anatoly Nekhay
 * @license https://github.com/sunrise-php/http-message/blob/master/LICENSE
 * @link https://github.com/sunrise-php/http-message
 */

namespace Sunrise\Http\Message\Header;

/**
 * Import classes
 */
use DateTimeInterface;
use Sunrise\Http\Message\Exception\InvalidHeaderValueException;
use Sunrise\Http\Message\Header;

/**
 * Import functions
 */
use function sprintf;

/**
 * @link https://tools.ietf.org/html/rfc2616#section-14.46
 */
class WarningHeader extends Header
{

    /**
     * HTTP Warning Codes
     *
     * @link https://www.iana.org/assignments/http-warn-codes/http-warn-codes.xhtml
     */
    public const HTTP_WARNING_CODE_RESPONSE_IS_STALE = 110;
    public const HTTP_WARNING_CODE_REVALIDATION_FAILED = 111;
    public const HTTP_WARNING_CODE_DISCONNECTED_OPERATION = 112;
    public const HTTP_WARNING_CODE_HEURISTIC_EXPIRATION = 113;
    public const HTTP_WARNING_CODE_MISCELLANEOUS_WARNING = 199;
    public const HTTP_WARNING_CODE_TRANSFORMATION_APPLIED = 214;
    public const HTTP_WARNING_CODE_MISCELLANEOUS_PERSISTENT_WARNING = 299;

    /**
     * @var int
     */
    private int $code;

    /**
     * @var string
     */
    private string $agent;

    /**
     * @var string
     */
    private string $text;

    /**
     * @var DateTimeInterface|null
     */
    private ?DateTimeInterface $date;

    /**
     * Constructor of the class
     *
     * @param int $code
     * @param string $agent
     * @param string $text
     * @param DateTimeInterface|null $date
     *
     * @throws InvalidHeaderValueException
     *         If one of parameters isn't valid.
     */
    public function __construct(int $code, string $agent, string $text, ?DateTimeInterface $date = null)
    {
        $this->validateCode($code);
        $this->validateToken($agent);
        $this->validateQuotedString($text);

        $this->code = $code;
        $this->agent = $agent;
        $this->text = $text;
        $this->date = $date;
    }

    /**
     * {@inheritdoc}
     */
    public function getFieldName(): string
    {
        return 'Warning';
    }

    /**
     * {@inheritdoc}
     */
    public function getFieldValue(): string
    {
        $value = sprintf('%s %s "%s"', $this->code, $this->agent, $this->text);

        if (isset($this->date)) {
            $value .= sprintf(' "%s"', $this->formatDateTime($this->date));

It seems like $this->date can also be of type null; however, parameter $dateTime of Sunrise\Http\Message\Header::formatDateTime() does only seem to accept DateTimeInterface, maybe add an additional type check?

        }

        return $value;
    }

    /**
     * Validates the given code
     *
     * @param int $code
     *
     * @return void
     *
     * @throws InvalidHeaderValueException
     *         If the code isn't valid.
     */
    private function validateCode(int $code): void
    {
        if (! ($code >= 100 && $code <= 999)) {
            throw new InvalidHeaderValueException(sprintf(
                'The code "%2$d" for the header "%1$s" is not valid',
                $this->getFieldName(),
                $code
            ));
        }
    }
}