Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\HttpFoundation;
Chris@0: 
Chris@0: /**
Chris@0:  * ParameterBag is a container for key/value pairs.
Chris@0:  *
Chris@0:  * @author Fabien Potencier <fabien@symfony.com>
Chris@0:  */
Chris@0: class ParameterBag implements \IteratorAggregate, \Countable
Chris@0: {
Chris@0:     /**
Chris@0:      * Parameter storage.
Chris@0:      */
Chris@0:     protected $parameters;
Chris@0: 
Chris@0:     /**
Chris@0:      * @param array $parameters An array of parameters
Chris@0:      */
Chris@17:     public function __construct(array $parameters = [])
Chris@0:     {
Chris@0:         $this->parameters = $parameters;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the parameters.
Chris@0:      *
Chris@0:      * @return array An array of parameters
Chris@0:      */
Chris@0:     public function all()
Chris@0:     {
Chris@0:         return $this->parameters;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the parameter keys.
Chris@0:      *
Chris@0:      * @return array An array of parameter keys
Chris@0:      */
Chris@0:     public function keys()
Chris@0:     {
Chris@0:         return array_keys($this->parameters);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Replaces the current parameters by a new set.
Chris@0:      *
Chris@0:      * @param array $parameters An array of parameters
Chris@0:      */
Chris@17:     public function replace(array $parameters = [])
Chris@0:     {
Chris@0:         $this->parameters = $parameters;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Adds parameters.
Chris@0:      *
Chris@0:      * @param array $parameters An array of parameters
Chris@0:      */
Chris@17:     public function add(array $parameters = [])
Chris@0:     {
Chris@0:         $this->parameters = array_replace($this->parameters, $parameters);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns a parameter by name.
Chris@0:      *
Chris@0:      * @param string $key     The key
Chris@0:      * @param mixed  $default The default value if the parameter key does not exist
Chris@0:      *
Chris@0:      * @return mixed
Chris@0:      */
Chris@0:     public function get($key, $default = null)
Chris@0:     {
Chris@18:         return \array_key_exists($key, $this->parameters) ? $this->parameters[$key] : $default;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Sets a parameter by name.
Chris@0:      *
Chris@0:      * @param string $key   The key
Chris@0:      * @param mixed  $value The value
Chris@0:      */
Chris@0:     public function set($key, $value)
Chris@0:     {
Chris@0:         $this->parameters[$key] = $value;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns true if the parameter is defined.
Chris@0:      *
Chris@0:      * @param string $key The key
Chris@0:      *
Chris@0:      * @return bool true if the parameter exists, false otherwise
Chris@0:      */
Chris@0:     public function has($key)
Chris@0:     {
Chris@18:         return \array_key_exists($key, $this->parameters);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Removes a parameter.
Chris@0:      *
Chris@0:      * @param string $key The key
Chris@0:      */
Chris@0:     public function remove($key)
Chris@0:     {
Chris@0:         unset($this->parameters[$key]);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the alphabetic characters of the parameter value.
Chris@0:      *
Chris@0:      * @param string $key     The parameter key
Chris@0:      * @param string $default The default value if the parameter key does not exist
Chris@0:      *
Chris@0:      * @return string The filtered value
Chris@0:      */
Chris@0:     public function getAlpha($key, $default = '')
Chris@0:     {
Chris@0:         return preg_replace('/[^[:alpha:]]/', '', $this->get($key, $default));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the alphabetic characters and digits of the parameter value.
Chris@0:      *
Chris@0:      * @param string $key     The parameter key
Chris@0:      * @param string $default The default value if the parameter key does not exist
Chris@0:      *
Chris@0:      * @return string The filtered value
Chris@0:      */
Chris@0:     public function getAlnum($key, $default = '')
Chris@0:     {
Chris@0:         return preg_replace('/[^[:alnum:]]/', '', $this->get($key, $default));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the digits of the parameter value.
Chris@0:      *
Chris@0:      * @param string $key     The parameter key
Chris@0:      * @param string $default The default value if the parameter key does not exist
Chris@0:      *
Chris@0:      * @return string The filtered value
Chris@0:      */
Chris@0:     public function getDigits($key, $default = '')
Chris@0:     {
Chris@0:         // we need to remove - and + because they're allowed in the filter
Chris@17:         return str_replace(['-', '+'], '', $this->filter($key, $default, FILTER_SANITIZE_NUMBER_INT));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the parameter value converted to integer.
Chris@0:      *
Chris@0:      * @param string $key     The parameter key
Chris@0:      * @param int    $default The default value if the parameter key does not exist
Chris@0:      *
Chris@0:      * @return int The filtered value
Chris@0:      */
Chris@0:     public function getInt($key, $default = 0)
Chris@0:     {
Chris@0:         return (int) $this->get($key, $default);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the parameter value converted to boolean.
Chris@0:      *
Chris@0:      * @param string $key     The parameter key
Chris@17:      * @param bool   $default The default value if the parameter key does not exist
Chris@0:      *
Chris@0:      * @return bool The filtered value
Chris@0:      */
Chris@0:     public function getBoolean($key, $default = false)
Chris@0:     {
Chris@0:         return $this->filter($key, $default, FILTER_VALIDATE_BOOLEAN);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Filter key.
Chris@0:      *
Chris@0:      * @param string $key     Key
Chris@0:      * @param mixed  $default Default = null
Chris@0:      * @param int    $filter  FILTER_* constant
Chris@0:      * @param mixed  $options Filter options
Chris@0:      *
Chris@0:      * @see http://php.net/manual/en/function.filter-var.php
Chris@0:      *
Chris@0:      * @return mixed
Chris@0:      */
Chris@17:     public function filter($key, $default = null, $filter = FILTER_DEFAULT, $options = [])
Chris@0:     {
Chris@0:         $value = $this->get($key, $default);
Chris@0: 
Chris@0:         // Always turn $options into an array - this allows filter_var option shortcuts.
Chris@17:         if (!\is_array($options) && $options) {
Chris@17:             $options = ['flags' => $options];
Chris@0:         }
Chris@0: 
Chris@0:         // Add a convenience check for arrays.
Chris@17:         if (\is_array($value) && !isset($options['flags'])) {
Chris@0:             $options['flags'] = FILTER_REQUIRE_ARRAY;
Chris@0:         }
Chris@0: 
Chris@0:         return filter_var($value, $filter, $options);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns an iterator for parameters.
Chris@0:      *
Chris@0:      * @return \ArrayIterator An \ArrayIterator instance
Chris@0:      */
Chris@0:     public function getIterator()
Chris@0:     {
Chris@0:         return new \ArrayIterator($this->parameters);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the number of parameters.
Chris@0:      *
Chris@0:      * @return int The number of parameters
Chris@0:      */
Chris@0:     public function count()
Chris@0:     {
Chris@17:         return \count($this->parameters);
Chris@0:     }
Chris@0: }