ParameterBag.php

Go to the documentation of this file.

<?php
namespace Elgg\Http;

class ParameterBag implements \IteratorAggregate, \Countable {

    protected $parameters;

    public function __construct(array $parameters = array()) {
        $this->parameters = $parameters;
    }

    public function all() {
        return $this->parameters;
    }

    public function keys() {
        return array_keys($this->parameters);
    }

    public function replace(array $parameters = array()) {
        $this->parameters = $parameters;
    }

    public function add(array $parameters = array()) {
        // original uses array_replace. using array_merge for 5.2 BC
        $this->parameters = array_merge($this->parameters, $parameters);
    }

    public function get($path, $default = null, $deep = false) {
        if (!$deep || false === $pos = strpos($path, '[')) {
            return array_key_exists($path, $this->parameters) ? $this->parameters[$path] : $default;
        }

        $root = substr($path, 0, $pos);
        if (!array_key_exists($root, $this->parameters)) {
            return $default;
        }

        $value = $this->parameters[$root];
        $currentKey = null;
        for ($i = $pos, $c = strlen($path); $i < $c; $i++) {
            $char = $path[$i];

            if ('[' === $char) {
                if (null !== $currentKey) {
                    throw new \InvalidArgumentException(sprintf('Malformed path. Unexpected "[" at position %d.', $i));
                }

                $currentKey = '';
            } elseif (']' === $char) {
                if (null === $currentKey) {
                    throw new \InvalidArgumentException(sprintf('Malformed path. Unexpected "]" at position %d.', $i));
                }

                if (!is_array($value) || !array_key_exists($currentKey, $value)) {
                    return $default;
                }

                $value = $value[$currentKey];
                $currentKey = null;
            } else {
                if (null === $currentKey) {
                    throw new \InvalidArgumentException(sprintf('Malformed path. Unexpected "%s" at position %d.', $char, $i));
                }

                $currentKey .= $char;
            }
        }

        if (null !== $currentKey) {
            throw new \InvalidArgumentException(sprintf('Malformed path. Path must end with "]".'));
        }

        return $value;
    }

    public function set($key, $value) {
        $this->parameters[$key] = $value;
    }

    public function has($key) {
        return array_key_exists($key, $this->parameters);
    }

    public function remove($key) {
        unset($this->parameters[$key]);
    }

    public function getAlpha($key, $default = '', $deep = false) {
        return preg_replace('/[^[:alpha:]]/', '', $this->get($key, $default, $deep));
    }

    public function getAlnum($key, $default = '', $deep = false) {
        return preg_replace('/[^[:alnum:]]/', '', $this->get($key, $default, $deep));
    }

    public function getDigits($key, $default = '', $deep = false) {
        // we need to remove - and + because they're allowed in the filter
        return str_replace(array('-', '+'), '', $this->filter($key, $default, $deep, FILTER_SANITIZE_NUMBER_INT));
    }

    public function getInt($key, $default = 0, $deep = false) {
        return (int) $this->get($key, $default, $deep);
    }

    public function filter($key, $default = null, $deep = false, $filter = FILTER_DEFAULT, $options = array()) {
        $value = $this->get($key, $default, $deep);

        // 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);
    }

    public function getIterator() {
        return new \ArrayIterator($this->parameters);
    }

    public function count() {
        return count($this->parameters);
    }

}