Jasny\Controller\Traits\ContentNegotiation

Complexity

Total Complexity

10

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	negotiateEncoding()	0	9	2
A	negotiateCharset()	0	12	2
A	negotiateContentType()	0	9	2
A	negotiateLanguage()	0	9	2
A	negotiate()	0	6	2

<?php
declare(strict_types=1);

Missing file doc comment

namespace Jasny\Controller\Traits;

use Negotiation\{AbstractNegotiator, Negotiator, LanguageNegotiator, EncodingNegotiator, CharsetNegotiator};
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

/**
 * Controller methods to negotiate content
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

trait ContentNegotiation
{
    abstract protected function getRequest(): ServerRequestInterface;

Missing doc comment for function getRequest()

    abstract protected function getResponse(): ResponseInterface;

Missing doc comment for function getResponse()

    abstract protected function header(string $header, string|int|\Stringable $value, bool $add = false): static;

Missing doc comment for function header()

    /**
     * Pick the best content type
     *
     * @param string[] $priorities

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function negotiateContentType(array $priorities): string
    {
        $contentType = $this->negotiate(new Negotiator(), 'Accept', $priorities);

        if ($contentType !== '') {
            $this->header('Content-Type', $contentType);
        }

        return $contentType;
    }

    /**
     * Pick the best language and set the `Content-Language` header
     *
     * @param string[] $priorities

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function negotiateLanguage(array $priorities): string
    {
        $language = $this->negotiate(new LanguageNegotiator(), 'Accept-Language', $priorities);

        if ($language !== '') {
            $this->header('Content-Language', $language);
        }

        return $language;
    }

    /**
     * Pick the best encoding and set `Content-Encoding` header
     *
     * @param string[] $priorities

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function negotiateEncoding(array $priorities): string
    {
        $encoding = $this->negotiate(new EncodingNegotiator(), 'Accept-Encoding', $priorities);

        if ($encoding !== '') {
            $this->header('Content-Encoding', $encoding);
        }

        return $encoding;
    }

    /**
     * Pick the best charset.
     * This method will modify the `Content-Type` header if it's set.
     *
     * @param string[] $priorities

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function negotiateCharset(array $priorities): string
    {
        $charset = $this->negotiate(new CharsetNegotiator(), 'Accept-Charset', $priorities);

        $contentType = $this->getResponse()->getHeaderLine('Content-Type');
        if ($contentType !== '') {
            $contentType = preg_replace('/;\s*charset\s*=[^;]+/', '', $contentType)
                . "; charset=$charset";
            $this->header('Content-Type', $contentType);
        }

        return $charset;
    }

    /**

Parameter $negotiator should have a doc-comment as per coding-style.

Parameter $header should have a doc-comment as per coding-style.

Parameter $priorities should have a doc-comment as per coding-style.

     * Generalize negotiation.
     */

Missing @return tag in function comment

    private function negotiate(AbstractNegotiator $negotiator, string $header, array $priorities): string

Private method name "ContentNegotiation::negotiate" must be prefixed with an underscore

    {
        $value = $this->getRequest()->getHeaderLine($header);
        $chosen = $negotiator->getBest($value, $priorities);

        return $chosen ? $chosen->getType() : '';

Call to an undefined method Negotiation\AcceptHeader::getType().

Only booleans are allowed in a ternary operator condition, Negotiation\AcceptHeader|null given.

    }
}