审查视图

vendor/symfony/http-foundation/AcceptHeaderItem.php 4.5 KB
王智 authored
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
<?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 item.
 *
 * @author Jean-François Simon <contact@jfsimon.fr>
 */
class AcceptHeaderItem
{
    private $value;
    private $quality = 1.0;
    private $index = 0;
    private $attributes = [];
王智 authored
26 27 28 29
    /**
     * @param string $value
     */
    public function __construct($value, array $attributes = [])
王智 authored
30 31 32 33 34 35 36 37 38 39
    {
        $this->value = $value;
        foreach ($attributes as $name => $value) {
            $this->setAttribute($name, $value);
        }
    }

    /**
     * Builds an AcceptHeaderInstance instance from a string.
     *
王智 authored
40 41
     * @param string $itemValue
     *
王智 authored
42 43
     * @return self
     */
王智 authored
44
    public static function fromString($itemValue)
王智 authored
45
    {
王智 authored
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
        $bits = preg_split('/\s*(?:;*("[^"]+");*|;*(\'[^\']+\');*|;+)\s*/', $itemValue, 0, \PREG_SPLIT_NO_EMPTY | \PREG_SPLIT_DELIM_CAPTURE);
        $value = array_shift($bits);
        $attributes = [];

        $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] : '';
            }
        }
王智 authored
62
王智 authored
63
        return new self(($start = substr($value, 0, 1)) === ($end = substr($value, -1)) && ('"' === $start || '\'' === $start) ? substr($value, 1, -1) : $value, $attributes);
王智 authored
64 65 66 67 68 69 70 71 72 73 74
    }

    /**
     * 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) {
王智 authored
75 76 77
            $string .= ';'.implode(';', array_map(function ($name, $value) {
                return sprintf(preg_match('/[,;=]/', $value) ? '%s="%s"' : '%s=%s', $name, $value);
            }, array_keys($this->attributes), $this->attributes));
王智 authored
78 79 80 81 82 83 84 85
        }

        return $string;
    }

    /**
     * Set the item value.
     *
王智 authored
86 87
     * @param string $value
     *
王智 authored
88 89
     * @return $this
     */
王智 authored
90
    public function setValue($value)
王智 authored
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
    {
        $this->value = $value;

        return $this;
    }

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

    /**
     * Set the item quality.
     *
王智 authored
110 111
     * @param float $quality
     *
王智 authored
112 113
     * @return $this
     */
王智 authored
114
    public function setQuality($quality)
王智 authored
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
    {
        $this->quality = $quality;

        return $this;
    }

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

    /**
     * Set the item index.
     *
王智 authored
134 135
     * @param int $index
     *
王智 authored
136 137
     * @return $this
     */
王智 authored
138
    public function setIndex($index)
王智 authored
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
    {
        $this->index = $index;

        return $this;
    }

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

    /**
     * Tests if an attribute exists.
     *
王智 authored
158 159
     * @param string $name
     *
王智 authored
160 161
     * @return bool
     */
王智 authored
162
    public function hasAttribute($name)
王智 authored
163 164 165 166 167 168 169
    {
        return isset($this->attributes[$name]);
    }

    /**
     * Returns an attribute by its name.
     *
王智 authored
170 171
     * @param string $name
     * @param mixed  $default
王智 authored
172 173 174
     *
     * @return mixed
     */
王智 authored
175
    public function getAttribute($name, $default = null)
王智 authored
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
    {
        return isset($this->attributes[$name]) ? $this->attributes[$name] : $default;
    }

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

    /**
     * Set an attribute.
     *
王智 authored
193 194 195
     * @param string $name
     * @param string $value
     *
王智 authored
196 197
     * @return $this
     */
王智 authored
198
    public function setAttribute($name, $value)
王智 authored
199 200 201 202
    {
        if ('q' === $name) {
            $this->quality = (float) $value;
        } else {
王智 authored
203
            $this->attributes[$name] = (string) $value;
王智 authored
204 205 206 207 208
        }

        return $this;
    }
}