class Parameters in Zircon Profile 8

Hierarchy

• class \Zend\Stdlib\Parameters extends \ArrayObject implements ParametersInterface

File

vendor/zendframework/zend-stdlib/src/Parameters.php, line 14

Namespace

Zend\Stdlib

class Parameters extends PhpArrayObject implements ParametersInterface {

  /**
   * Constructor
   *
   * Enforces that we have an array, and enforces parameter access to array
   * elements.
   *
   * @param  array $values
   */
  public function __construct(array $values = null) {
    if (null === $values) {
      $values = [];
    }
    parent::__construct($values, ArrayObject::ARRAY_AS_PROPS);
  }

  /**
   * Populate from native PHP array
   *
   * @param  array $values
   * @return void
   */
  public function fromArray(array $values) {
    $this
      ->exchangeArray($values);
  }

  /**
   * Populate from query string
   *
   * @param  string $string
   * @return void
   */
  public function fromString($string) {
    $array = [];
    parse_str($string, $array);
    $this
      ->fromArray($array);
  }

  /**
   * Serialize to native PHP array
   *
   * @return array
   */
  public function toArray() {
    return $this
      ->getArrayCopy();
  }

  /**
   * Serialize to query string
   *
   * @return string
   */
  public function toString() {
    return http_build_query($this);
  }

  /**
   * Retrieve by key
   *
   * Returns null if the key does not exist.
   *
   * @param  string $name
   * @return mixed
   */
  public function offsetGet($name) {
    if ($this
      ->offsetExists($name)) {
      return parent::offsetGet($name);
    }
    return;
  }

  /**
   * @param string $name
   * @param mixed $default optional default value
   * @return mixed
   */
  public function get($name, $default = null) {
    if ($this
      ->offsetExists($name)) {
      return parent::offsetGet($name);
    }
    return $default;
  }

  /**
   * @param string $name
   * @param mixed $value
   * @return Parameters
   */
  public function set($name, $value) {
    $this[$name] = $value;
    return $this;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Parameters::fromArray	public	function	Populate from native PHP array Overrides ParametersInterface::fromArray
Parameters::fromString	public	function	Populate from query string Overrides ParametersInterface::fromString
Parameters::get	public	function	Overrides ParametersInterface::get
Parameters::offsetGet	public	function	Retrieve by key
Parameters::set	public	function	Overrides ParametersInterface::set
Parameters::toArray	public	function	Serialize to native PHP array Overrides ParametersInterface::toArray
Parameters::toString	public	function	Serialize to query string Overrides ParametersInterface::toString
Parameters::__construct	public	function	Constructor Overrides ParametersInterface::__construct