Classes List

Symfony\Component\HttpFoundation\AcceptHeader

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
<?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 Symfony\Component\HttpFoundation;

/** * Represents an Accept-* header. * * An accept header is compound with a list of items, * sorted by descending quality. * * @author Jean-François Simon <contact@jfsimon.fr> */
class AcceptHeader
{
    /** * @var AcceptHeaderItem[] */
    private $items = array();

    /** * @var bool */
    private $sorted = true;

    /** * @param AcceptHeaderItem[] $items */
    public function __construct(array $items)
    {
        foreach ($items as $item) {
            $this->add($item);
        }
    }

    /** * Builds an AcceptHeader instance from a string. * * @param string $headerValue * * @return self */
    public static function fromString($headerValue)
    {
        $index = 0;

        return new self(array_map(function ($itemValueuse (&$index) {
            $item = AcceptHeaderItem::fromString($itemValue);
            $item->setIndex($index++);

            return $item;
        }, preg_split('/\s*(?:,*("[^"]+"),*|,*(\'[^\']+\'),*|,+)\s*/'$headerValue0PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE)));
    }

    /** * Returns header value's string representation. * * @return string */
    public function __toString()
    {
        return implode(','$this->items);
    }

    /** * Tests if header has given value. * * @param string $value * * @return bool */
    public function has($value)
    {
        return isset($this->items[$value]);
    }

    /** * Returns given value's item, if exists. * * @param string $value * * @return AcceptHeaderItem|null */
    public function get($value)
    {
        return isset($this->items[$value]) ? $this->items[$value] : null;
    }

    /** * Adds an item. * * @return $this */
    public function add(AcceptHeaderItem $item)
    {
        $this->items[$item->getValue()] = $item;
        $this->sorted = false;

        return $this;
    }

    /** * Returns all items. * * @return AcceptHeaderItem[] */
    public function all()
    {
        $this->sort();

        return $this->items;
    }

    /** * Filters items on their value using given regex. * * @param string $pattern * * @return self */
    public function filter($pattern)
    {
        return new self(array_filter($this->itemsfunction (AcceptHeaderItem $itemuse ($pattern) {
            return preg_match($pattern$item->getValue());
        }));
    }

    /** * Returns first item. * * @return AcceptHeaderItem|null */
    public function first()
    {
        $this->sort();

        return !empty($this->items) ? reset($this->items) : null;
    }

    /** * Sorts items by descending quality. */
    private function sort()
    {
        if (!$this->sorted) {
            uasort($this->itemsfunction (AcceptHeaderItem $aAcceptHeaderItem $b) {
                $qA = $a->getQuality();
                $qB = $b->getQuality();

                if ($qA === $qB) {
                    return $a->getIndex() > $b->getIndex() ? 1 : -1;
                }

                return $qA > $qB ? -1 : 1;
            });

            $this->sorted = true;
        }
    }
}