# AcceptHeaderItem

class AcceptHeaderItem

Represents an Accept-* header item.

## Methods

`public` | `` | `__construct(string $value, array $attributes = array())` | No description |
`public static` | `AcceptHeaderItem` | `fromString(string $itemValue)` | Builds an AcceptHeaderInstance instance from a string. |
`public` | `string` | `__toString()` | Returns header value's string representation. |
`public` | `$this` | `setValue(string $value)` | Set the item value. |
`public` | `string` | `getValue()` | Returns the item value. |
`public` | `$this` | `setQuality(float $quality)` | Set the item quality. |
`public` | `float` | `getQuality()` | Returns the item quality. |
`public` | `$this` | `setIndex(int $index)` | Set the item index. |
`public` | `int` | `getIndex()` | Returns the item index. |
`public` | `bool` | `hasAttribute(string $name)` | Tests if an attribute exists. |
`public` | `mixed` | `getAttribute(string $name, mixed $default = null)` | Returns an attribute by its name. |
`public` | `array` | `getAttributes()` | Returns all attributes. |
`public` | `$this` | `setAttribute(string $name, string $value)` | Set an attribute. |

## Details

at line 26

### `__construct()`

`public __construct(string $value, array $attributes = array())`

#### Parameters

`string` | `$value` |
`array` | `$attributes` |

at line 41

### `fromString()`

`public static AcceptHeaderItem fromString(string $itemValue)`

Builds an AcceptHeaderInstance instance from a string.

#### Parameters

`string` | `$itemValue` |

#### Return Value

`AcceptHeaderItem` |

at line 68

### `__toString()`

`public string __toString()`

Returns header value's string representation.

#### Return Value

`string` |

at line 87

### `setValue()`

`public $this setValue(string $value)`

Set the item value.

#### Parameters

`string` | `$value` |

#### Return Value

`$this` |

at line 99

### `getValue()`

`public string getValue()`

Returns the item value.

#### Return Value

`string` |

at line 111

### `setQuality()`

`public $this setQuality(float $quality)`

Set the item quality.

#### Parameters

`float` | `$quality` |

#### Return Value

`$this` |

at line 123

### `getQuality()`

`public float getQuality()`

Returns the item quality.

#### Return Value

`float` |

at line 135

### `setIndex()`

`public $this setIndex(int $index)`

Set the item index.

#### Parameters

`int` | `$index` |

#### Return Value

`$this` |

at line 147

### `getIndex()`

`public int getIndex()`

Returns the item index.

#### Return Value

`int` |

at line 159

### `hasAttribute()`

`public bool hasAttribute(string $name)`

Tests if an attribute exists.

#### Parameters

`string` | `$name` |

#### Return Value

`bool` |

at line 172

### `getAttribute()`

`public mixed getAttribute(string $name, mixed $default = null)`

Returns an attribute by its name.

#### Parameters

`string` | `$name` |
`mixed` | `$default` |

#### Return Value

`mixed` |

at line 182

### `getAttributes()`

`public array getAttributes()`

Returns all attributes.

#### Return Value

`array` |

at line 195

### `setAttribute()`

`public $this setAttribute(string $name, string $value)`

Set an attribute.

#### Parameters

`string` | `$name` |
`string` | `$value` |

#### Return Value

`$this` |

## Source code

    <?php

    /*
     * This file is part of the Symfony package.
     *
     * (c) Fabien Potencier <fabien@symfony.com>
     *
     * For the full copyright and license information, please view the LICENSE
     * file that was distributed with this source code.
     */

    namespace App\Khan\Component\HttpFoundation;

    /**
     * Represents an Accept-* header item.
     *
     * @author Jean-François Simon <contact@jfsimon.fr>
     */
    class AcceptHeaderItem
    {
        private $value;
        private $quality = 1.0;
        private $index = 0;
        private $attributes = array();

        public function __construct(string $value, array $attributes = array())
        {
            $this->value = $value;
            foreach ($attributes as $name => $value) {
                $this->setAttribute($name, $value);
            }
        }

        /**
         * Builds an AcceptHeaderInstance instance from a string.
         *
         * @param string $itemValue
         *
         * @return self
         */
        public static function fromString($itemValue)
        {
            $bits = preg_split('/\s*(?:;*("[^"]+");*|;*(\'[^\']+\');*|;+)\s*/', $itemValue, 0, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE);
            $value = array_shift($bits);
            $attributes = array();

            $lastNullAttribute = null;
            foreach ($bits as $bit) {
                if (($start = substr($bit, 0, 1)) === ($end = substr($bit, -1)) && ('"' === $start || '\'' === $start)) {
                    $attributes[$lastNullAttribute] = substr($bit, 1, -1);
                } elseif ('=' === $end) {
                    $lastNullAttribute = $bit = substr($bit, 0, -1);
                    $attributes[$bit] = null;
                } else {
                    $parts = explode('=', $bit);
                    $attributes[$parts[0]] = isset($parts[1]) && strlen($parts[1]) > 0 ? $parts[1] : '';
                }
            }

            return new self(($start = substr($value, 0, 1)) === ($end = substr($value, -1)) && ('"' === $start || '\'' === $start) ? substr($value, 1, -1) : $value, $attributes);
        }

        /**
         * Returns header  value's string representation.
         *
         * @return string
         */
        public function __toString()
        {
            $string = $this->value.($this->quality < 1 ? ';q='.$this->quality : '');
            if (count($this->attributes) > 0) {
                $string .= ';'.implode(';', array_map(function ($name, $value) {
                    return sprintf(preg_match('/[,;=]/', $value) ? '%s="%s"' : '%s=%s', $name, $value);
                }, array_keys($this->attributes), $this->attributes));
            }

            return $string;
        }

        /**
         * Set the item value.
         *
         * @param string $value
         *
         * @return $this
         */
        public function setValue($value)
        {
            $this->value = $value;

            return $this;
        }

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

        /**
         * Set the item quality.
         *
         * @param float $quality
         *
         * @return $this
         */
        public function setQuality($quality)
        {
            $this->quality = $quality;

            return $this;
        }

        /**
         * Returns the item quality.
         *
         * @return float
         */
        public function getQuality()
        {
            return $this->quality;
        }

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

            return $this;
        }

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

        /**
         * Tests if an attribute exists.
         *
         * @param string $name
         *
         * @return bool
         */
        public function hasAttribute($name)
        {
            return isset($this->attributes[$name]);
        }

        /**
         * Returns an attribute by its name.
         *
         * @param string $name
         * @param mixed  $default
         *
         * @return mixed
         */
        public function getAttribute($name, $default = null)
        {
            return isset($this->attributes[$name]) ? $this->attributes[$name] : $default;
        }

        /**
         * Returns all attributes.
         *
         * @return array
         */
        public function getAttributes()
        {
            return $this->attributes;
        }

        /**
         * Set an attribute.
         *
         * @param string $name
         * @param string $value
         *
         * @return $this
         */
        public function setAttribute($name, $value)
        {
            if ('q' === $name) {
                $this->quality = (float) $value;
            } else {
                $this->attributes[$name] = (string) $value;
            }

            return $this;
        }
    }