Borobudur\Http\Header\Accept\AcceptHeaderItem

Complexity

Total Complexity

28

Size/Duplication

Total Lines	215
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	3
A	setParameter()	0	10	2
C	fromString()	0	24	7
A	getValue()	0	4	1
A	getPriority()	0	4	1
A	setPriority()	0	12	3
A	getParameters()	0	4	1
A	getParameter()	0	8	2
A	hasParameter()	0	4	1
A	setIndex()	0	6	1
A	getIndex()	0	4	1
B	__toString()	0	13	5

<?php
/*
 * This file is part of the Borobudur-Http package.
 *
 * (c) Hexacodelabs <http://hexacodelabs.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Borobudur\Http\Header\Accept;

use Borobudur\Http\Exception\InvalidArgumentException;

/**
 * @author      Iqbal Maulana <iq.bluejack@gmail.com>
 * @created     7/18/15
 */
class AcceptHeaderItem
{
    /**
     * @var string
     */
    private $value;

    /**
     * @var float
     */
    private $priority = 1.0;

    /**
     * @var array
     */
    private $parameters = array();

    /**
     * @var int
     */
    private $index = null;

    /**
     * Constructor.
     *
     * @param string     $value
     * @param array|null $parameters
     */
    public function __construct($value, array $parameters = null)
    {
        $this->value = $value;

        if (null !== $parameters) {
            foreach ($parameters as $name => $value) {
                $this->setParameter($name, $value);
            }
        }
    }

    /**
     * Set a parameter.
     *
     * @param string $name
     * @param string $value
     *
     * @return $this
     */
    public function setParameter($name, $value)
    {
        if ('q' === $name) {
            $this->setPriority($value);
        } else {
            $this->parameters[$name] = (string)$value;
        }

        return $this;
    }

    /**
     * Factory create AcceptHeaderItem from string.
     *
     * @param string $itemString
     *
     * @return $this
     */
    public static function fromString($itemString)
    {
        preg_match_all('#((("[^"\']++")|(\'[^"\']++\'))|[^;"\'])+#', (string)$itemString, $parts);
        $bits = $parts[0];
        $fieldValue = array_shift($bits);
        $parameters = array();

        foreach ($bits as $bit) {
            $pos = strpos($bit, '=');
            $name = false === $pos ? $bit : substr($bit, 0, $pos);
            $value = false === $pos ? null : substr($bit, $pos + 1);

            if (null !== $value
                && in_array($value[0], array('\'', '"'))
                && in_array(substr($value, -1), array('\'', '"'))
            ) {
                $value = substr($value, 1, -1);
            }

            $parameters[$name] = $value;
        }

        return new static($fieldValue, $parameters);
    }

    /**
     * Return header item value.
     *
     * @return string
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * Get accept header item quality.
     *
     * @return float
     */
    public function getPriority()
    {
        return $this->priority;
    }

    /**
     * Set accept header item quality.
     *
     * @param float|int $priority
     *
     * @return $this
     *
     * @throws InvalidArgumentException
     */
    public function setPriority($priority)
    {
        $priority = (float)$priority;

        if (0 > $priority || 1 < $priority) {
            throw new InvalidArgumentException(sprintf('Priority must between 0 - 1, "%s" give.', $priority));
        }

        $this->priority = $priority;

        return $this;
    }

    /**
     * Get all parameters.
     *
     * @return array
     */
    public function getParameters()
    {
        return $this->parameters;
    }

    /**
     * Return parameter by name or default value if not exist.
     *
     * @param string      $name
     * @param string|null $default
     *
     * @return string|null
     */
    public function getParameter($name, $default = null)
    {
        if (isset($this->parameters[$name])) {
            return $this->parameters[$name];
        }

        return $default;
    }

    /**
     * Check if parameter exist by name.
     *
     * @param string $name
     *
     * @return bool
     */
    public function hasParameter($name)
    {
        return isset($this->parameters[$name]);
    }

    /**
     * Set accept header item index.
     *
     * @param int $index
     *
     * @return $this
     */
    public function setIndex($index)
    {
        $this->index = (int)$index;

        return $this;
    }

    /**
     * Get index.
     *
     * @return int
     */
    public function getIndex()
    {
        return $this->index;
    }

    /**
     * Cast accept item to string representation.
     *
     * @return string
     */
    public function __toString()
    {
        $string = $this->value . ($this->priority < 1 ? ';q=' . $this->priority : '');

        if (count($this->parameters)) {
            foreach ($this->parameters as $name => $value) {
                $format = preg_match('/[,;=]/', $value) ? ';%s="%s"' : ';%s=%s';
                $string .= sprintf($format, $name, $value);
            }
        }

        return $string;
    }

}