Neomerx\JsonApi\Http\Headers\Header

Complexity

Total Complexity

11

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	3
A	getName()	0	4	1
A	getMediaTypes()	0	4	1
A	parse()	0	15	4
A	parseMediaType()	0	4	1
A	newInstance()	0	4	1

<?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 \InvalidArgumentException;
use \Neomerx\JsonApi\Contracts\Http\Headers\HeaderInterface;
use \Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface;

/**
 * @package Neomerx\JsonApi
 */
class Header implements HeaderInterface
{
    /**
     * @var string
     */
    private $name;

    /**
     * @var MediaTypeInterface[]
     */
    private $mediaTypes;

    /**
     * @param string               $name
     * @param MediaTypeInterface[] $mediaTypes
     */
    public function __construct($name, $mediaTypes)
    {
        $name = trim($name);
        if (empty($name) === true) {
            throw new InvalidArgumentException('name');
        }

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

        $this->name       = $name;
        $this->mediaTypes = $mediaTypes;
    }

    /**
     * @inheritdoc
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @inheritdoc
     */
    public function getMediaTypes()
    {
        return $this->mediaTypes;
    }

    /**
     * Parse header.
     *
     * @param string $header
     * @param string $name
     *
     * @return HeaderInterface

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

     */
    public static function parse($header, $name)
    {
        if (is_string($name) === false || empty($name) === true) {
            throw new InvalidArgumentException('header');
        }

        $mediaTypes = [];
        $ranges     = preg_split("/,(?=([^\"]*\"[^\"]*\")*[^\"]*$)/", $header);

The string literal /,(?=([^\"]*\"[^\"]*\")*[^\"]*$)/ does not require double quotes, as per coding-style, please use single quotes.

        $count      = count($ranges);
        for ($idx = 0; $idx < $count; ++$idx) {
            $mediaTypes[] = static::parseMediaType($idx, $ranges[$idx]);
        }

        return static::newInstance($name, $mediaTypes);
    }

    /**
     * @param int    $position
     * @param string $mediaType
     *
     * @return MediaTypeInterface

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

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

    /**
     * @param string               $name
     * @param MediaTypeInterface[] $mediaTypes
     *
     * @return Header
     */
    protected static function newInstance($name, $mediaTypes)
    {
        return new static($name, $mediaTypes);
    }
}