Neomerx\JsonApi\Http\Headers\AcceptHeader

Complexity

Total Complexity

19

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	2
A	parse()	0	4	1
A	parseMediaType()	0	4	1
A	newInstance()	0	5	1
B	getMediaTypeCompareClosure()	0	26	5
A	compareQuality()	0	11	3
A	compareStrings()	0	4	3
A	compareParameters()	0	4	3

<?php namespace Neomerx\JsonApi\Http\Headers;

/**
 * Copyright 2015 info@neomerx.com (www.neomerx.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use \Closure;
use \InvalidArgumentException;
use \Neomerx\JsonApi\Contracts\Http\Headers\AcceptHeaderInterface;
use \Neomerx\JsonApi\Contracts\Http\Headers\AcceptMediaTypeInterface;

/**
 * @package Neomerx\JsonApi
 */
class AcceptHeader extends Header implements AcceptHeaderInterface
{
    /**
     * @param AcceptMediaTypeInterface[] $unsortedMediaTypes
     */
    public function __construct($unsortedMediaTypes)
    {

        if (is_array($unsortedMediaTypes) ===  false) {
            throw new InvalidArgumentException('unsortedMediaTypes');
        }

        usort($unsortedMediaTypes, $this->getMediaTypeCompareClosure());

        parent::__construct(self::HEADER_ACCEPT, $unsortedMediaTypes);
    }

    /**
     * @inheritdoc
     *
     * @return AcceptHeaderInterface

Should the return type not be Header?

     */
    public static function parse($header, $accept = self::HEADER_ACCEPT)
    {
        return parent::parse($header, self::HEADER_ACCEPT);
    }

    /**
     * @inheritdoc
     *
     * @return AcceptMediaTypeInterface

Consider making the return type a bit more specific; maybe use AcceptMediaType.

     */
    protected static function parseMediaType($position, $mediaType)
    {
        return AcceptMediaType::parse($position, $mediaType);
    }

    /**
     * @inheritdoc
     *
     * @return AcceptHeaderInterface

Consider making the return type a bit more specific; maybe use AcceptHeader.

     */
    protected static function newInstance($name, $mediaTypes)
    {
        /** @var AcceptMediaTypeInterface[] $mediaTypes */
        return new static($mediaTypes);
    }

    /**
     * @return Closure
     */
    private function getMediaTypeCompareClosure()
    {
        return function (AcceptMediaTypeInterface $lhs, AcceptMediaTypeInterface $rhs) {
            $qualityCompare = $this->compareQuality($lhs->getQuality(), $rhs->getQuality());
            if ($qualityCompare !== 0) {
                return $qualityCompare;
            }

            $typeCompare = $this->compareStrings($lhs->getType(), $rhs->getType());
            if ($typeCompare !== 0) {
                return $typeCompare;
            }

            $subTypeCompare = $this->compareStrings($lhs->getSubType(), $rhs->getSubType());
            if ($subTypeCompare !== 0) {
                return $subTypeCompare;
            }

            $parametersCompare = $this->compareParameters($lhs->getParameters(), $rhs->getParameters());
            if ($parametersCompare !== 0) {
                return $parametersCompare;
            }

            return ($lhs->getPosition() - $rhs->getPosition());
        };
    }

    /**
     * @param float $lhs
     * @param float $rhs
     *
     * @return int
     */
    private function compareQuality($lhs, $rhs)
    {
        $qualityDiff = $lhs - $rhs;

        // rfc2616: 3 digits are meaningful (#3.9 Quality Values)
        if (abs($qualityDiff) < 0.001) {
            return 0;
        } else {
            return $lhs > $rhs ? -1 : 1;
        }
    }

    /**
     * @param string $lhs
     * @param string $rhs
     *
     * @return int
     */
    private function compareStrings($lhs, $rhs)
    {
        return ($rhs !== '*' ? 1 : 0) - ($lhs !== '*' ? 1 : 0);
    }

    /**
     * @param array|null $lhs
     * @param array|null $rhs
     *
     * @return int
     */
    private function compareParameters($lhs, $rhs)
    {
        return (empty($lhs) !== false ? 1 : 0) - (empty($rhs) !== false ? 1 : 0);
    }
}