Classes List

Symfony\Component\HttpFoundation\ParameterBag

 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 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
 178 
 179 
 180 
 181 
 182 
 183 
 184 
 185 
 186 
 187 
 188 
 189 
 190 
 191 
 192 
 193 
 194 
 195 
 196 
 197 
 198 
 199 
 200 
 201 
 202 
 203 
 204 
 205 
 206 
 207 
 208 
 209 
 210 
 211 
 212 
 213 
 214 
 215 
 216 
 217 
 218 
 219 
 220 
 221 
 222 
 223 
 224 
 225 
 226 
 227 
 228 
 229 
 230 
 231 
 232 
 233 
 234 
 235 
<?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;

/** * ParameterBag is a container for key/value pairs. * * @author Fabien Potencier <fabien@symfony.com> */
class ParameterBag implements \IteratorAggregate\Countable
{
    /** * Parameter storage. */
    protected $parameters;

    /** * @param array $parameters An array of parameters */
    public function __construct(array $parameters = array())
    {
        $this->parameters = $parameters;
    }

    /** * Returns the parameters. * * @return array An array of parameters */
    public function all()
    {
        return $this->parameters;
    }

    /** * Returns the parameter keys. * * @return array An array of parameter keys */
    public function keys()
    {
        return array_keys($this->parameters);
    }

    /** * Replaces the current parameters by a new set. * * @param array $parameters An array of parameters */
    public function replace(array $parameters = array())
    {
        $this->parameters = $parameters;
    }

    /** * Adds parameters. * * @param array $parameters An array of parameters */
    public function add(array $parameters = array())
    {
        $this->parameters = array_replace($this->parameters$parameters);
    }

    /** * Returns a parameter by name. * * @param string $key The key * @param mixed $default The default value if the parameter key does not exist * * @return mixed */
    public function get($key$default = null)
    {
        return array_key_exists($key$this->parameters) ? $this->parameters[$key] : $default;
    }

    /** * Sets a parameter by name. * * @param string $key The key * @param mixed $value The value */
    public function set($key$value)
    {
        $this->parameters[$key] = $value;
    }

    /** * Returns true if the parameter is defined. * * @param string $key The key * * @return bool true if the parameter exists, false otherwise */
    public function has($key)
    {
        return array_key_exists($key$this->parameters);
    }

    /** * Removes a parameter. * * @param string $key The key */
    public function remove($key)
    {
        unset($this->parameters[$key]);
    }

    /** * Returns the alphabetic characters of the parameter value. * * @param string $key The parameter key * @param string $default The default value if the parameter key does not exist * * @return string The filtered value */
    public function getAlpha($key$default = '')
    {
        return preg_replace('/[^[:alpha:]]/'''$this->get($key$default));
    }

    /** * Returns the alphabetic characters and digits of the parameter value. * * @param string $key The parameter key * @param string $default The default value if the parameter key does not exist * * @return string The filtered value */
    public function getAlnum($key$default = '')
    {
        return preg_replace('/[^[:alnum:]]/'''$this->get($key$default));
    }

    /** * Returns the digits of the parameter value. * * @param string $key The parameter key * @param string $default The default value if the parameter key does not exist * * @return string The filtered value */
    public function getDigits($key$default = '')
    {
        // we need to remove - and + because they're allowed in the filter
        return str_replace(array('-''+'), ''$this->filter($key$defaultFILTER_SANITIZE_NUMBER_INT));
    }

    /** * Returns the parameter value converted to integer. * * @param string $key The parameter key * @param int $default The default value if the parameter key does not exist * * @return int The filtered value */
    public function getInt($key$default = 0)
    {
        return (int) $this->get($key$default);
    }

    /** * Returns the parameter value converted to boolean. * * @param string $key The parameter key * @param mixed $default The default value if the parameter key does not exist * * @return bool The filtered value */
    public function getBoolean($key$default = false)
    {
        return $this->filter($key$defaultFILTER_VALIDATE_BOOLEAN);
    }

    /** * Filter key. * * @param string $key Key * @param mixed $default Default = null * @param int $filter FILTER_* constant * @param mixed $options Filter options * * @see http://php.net/manual/en/function.filter-var.php * * @return mixed */
    public function filter($key$default = null$filter = FILTER_DEFAULT$options = array())
    {
        $value = $this->get($key$default);

        // Always turn $options into an array - this allows filter_var option shortcuts.
        if (!is_array($options&& $options) {
            $options = array('flags' => $options);
        }

        // Add a convenience check for arrays.
        if (is_array($value&& !isset($options['flags'])) {
            $options['flags'] = FILTER_REQUIRE_ARRAY;
        }

        return filter_var($value$filter$options);
    }

    /** * Returns an iterator for parameters. * * @return \ArrayIterator An \ArrayIterator instance */
    public function getIterator()
    {
        return new \ArrayIterator($this->parameters);
    }

    /** * Returns the number of parameters. * * @return int The number of parameters */
    public function count()
    {
        return count($this->parameters);
    }
}