Sunrise\Http\Message\Header\WWWAuthenticateHeader

Complexity

Total Complexity

5

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getFieldName()	0	3	1
A	__construct()	0	8	1
A	getFieldValue()	0	14	3

<?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 Sunrise\Http\Message\Exception\InvalidHeaderValueException;
use Sunrise\Http\Message\Exception\InvalidHeaderValueParameterException;
use Sunrise\Http\Message\Header;

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

/**
 * @link https://tools.ietf.org/html/rfc7235#section-4.1
 */
class WWWAuthenticateHeader extends Header
{

    /**
     * HTTP Authentication Schemes
     *
     * @link https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml
     */
    public const HTTP_AUTHENTICATE_SCHEME_BASIC         = 'Basic';
    public const HTTP_AUTHENTICATE_SCHEME_BEARER        = 'Bearer';
    public const HTTP_AUTHENTICATE_SCHEME_DIGEST        = 'Digest';
    public const HTTP_AUTHENTICATE_SCHEME_HOBA          = 'HOBA';
    public const HTTP_AUTHENTICATE_SCHEME_MUTUAL        = 'Mutual';
    public const HTTP_AUTHENTICATE_SCHEME_NEGOTIATE     = 'Negotiate';
    public const HTTP_AUTHENTICATE_SCHEME_OAUTH         = 'OAuth';
    public const HTTP_AUTHENTICATE_SCHEME_SCRAM_SHA_1   = 'SCRAM-SHA-1';
    public const HTTP_AUTHENTICATE_SCHEME_SCRAM_SHA_256 = 'SCRAM-SHA-256';
    public const HTTP_AUTHENTICATE_SCHEME_VAPID         = 'vapid';

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

    /**
     * @var array<string, string>
     */
    private array $parameters;

    /**
     * Constructor of the class
     *
     * @param string $scheme
     * @param array<array-key, mixed> $parameters

The doc comment array<array-key, mixed> at position 2 could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, mixed>.

     *
     * @throws InvalidHeaderValueException
     *         If the scheme isn't valid.
     *
     * @throws InvalidHeaderValueParameterException
     *         If the parameters aren't valid.
     */
    public function __construct(string $scheme, array $parameters = [])
    {
        $this->validateToken($scheme);

        $parameters = $this->validateParameters($parameters);

        $this->scheme = $scheme;
        $this->parameters = $parameters;
    }

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

    /**
     * {@inheritdoc}
     */
    public function getFieldValue(): string
    {
        $v = $this->scheme;

        $challenge = [];
        foreach ($this->parameters as $name => $value) {
            $challenge[] = sprintf(' %s="%s"', $name, $value);
        }

        if (!empty($challenge)) {
            $v .= implode(',', $challenge);
        }

        return $v;
    }
}