Adding upstream version 2.12.1.upstream/2.12.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 289 insertions, 0 deletions

diff --git a/library/Icinga/Data/ConfigObject.php b/library/Icinga/Data/ConfigObject.php
new file mode 100644
index 0000000..c9a3134
--- /dev/null
+++ b/library/Icinga/Data/ConfigObject.php
@@ -0,0 +1,289 @@
+<?php
+/* Icinga Web 2 | (c) 2013 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Data;
+
+use Iterator;
+use ArrayAccess;
+use Icinga\Data\DataArray\ArrayDatasource;
+use Icinga\Exception\ProgrammingError;
+
+/**
+ * Container for configuration values
+ */
+class ConfigObject extends ArrayDatasource implements Iterator, ArrayAccess
+{
+    /**
+     * Create a new config
+     *
+     * @param   array   $data   The data to initialize the new config with
+     */
+    public function __construct(array $data = array())
+    {
+        // Convert all embedded arrays to ConfigObjects as well
+        foreach ($data as & $value) {
+            if (is_array($value)) {
+                $value = new static($value);
+            }
+        }
+
+        parent::__construct($data);
+    }
+
+    /**
+     * Deep clone this config
+     */
+    public function __clone()
+    {
+        $array = array();
+        foreach ($this->data as $key => $value) {
+            if ($value instanceof self) {
+                $array[$key] = clone $value;
+            } else {
+                $array[$key] = $value;
+            }
+        }
+
+        $this->data = $array;
+    }
+
+    /**
+     * Reset the current position of $this->data
+     *
+     * @return  void
+     */
+    public function rewind(): void
+    {
+        reset($this->data);
+    }
+
+    /**
+     * Return the section's or property's value of the current iteration
+     *
+     * @return  mixed
+     */
+    #[\ReturnTypeWillChange]
+    public function current()
+    {
+        return current($this->data);
+    }
+
+    /**
+     * Return whether the position of the current iteration is valid
+     *
+     * @return  bool
+     */
+    public function valid(): bool
+    {
+        return key($this->data) !== null;
+    }
+
+    /**
+     * Return the section's or property's name of the current iteration
+     *
+     * @return  string
+     */
+    public function key(): string
+    {
+        return key($this->data);
+    }
+
+    /**
+     * Advance the position of the current iteration and return the new section's or property's value
+     *
+     * @return  void
+     */
+    public function next(): void
+    {
+        next($this->data);
+    }
+
+    /**
+     * Return whether the given section or property is set
+     *
+     * @param   string  $key    The name of the section or property
+     *
+     * @return  bool
+     */
+    public function __isset($key)
+    {
+        return isset($this->data[$key]);
+    }
+
+    /**
+     * Return the value for the given property or the config for the given section
+     *
+     * @param   string  $key    The name of the property or section
+     *
+     * @return  mixed|NULL      The value or NULL in case $key does not exist
+     */
+    public function __get($key)
+    {
+        return $this->get($key);
+    }
+
+    /**
+     * Add a new property or section
+     *
+     * @param   string  $key    The name of the new property or section
+     * @param   mixed   $value  The value to set for the new property or section
+     */
+    public function __set($key, $value)
+    {
+        if (is_array($value)) {
+            $this->data[$key] = new static($value);
+        } else {
+            $this->data[$key] = $value;
+        }
+    }
+
+    /**
+     * Remove the given property or section
+     *
+     * @param   string  $key    The property or section to remove
+     */
+    public function __unset($key)
+    {
+        unset($this->data[$key]);
+    }
+
+    /**
+     * Return whether the given section or property is set
+     *
+     * @param   string  $key    The name of the section or property
+     *
+     * @return  bool
+     */
+    public function offsetExists($key): bool
+    {
+        return isset($this->$key);
+    }
+
+    /**
+     * Return the value for the given property or the config for the given section
+     *
+     * @param   string  $key    The name of the property or section
+     *
+     * @return  ?mixed      The value or NULL in case $key does not exist
+     */
+    #[\ReturnTypeWillChange]
+    public function offsetGet($key)
+    {
+        return $this->get($key);
+    }
+
+    /**
+     * Add a new property or section
+     *
+     * @param   string  $key        The name of the new property or section
+     * @param   mixed   $value      The value to set for the new property or section
+     *
+     * @throws  ProgrammingError    If the key is null
+     */
+    public function offsetSet($key, $value): void
+    {
+        if ($key === null) {
+            throw new ProgrammingError('Appending values without an explicit key is not supported');
+        }
+
+        $this->$key = $value;
+    }
+
+    /**
+     * Remove the given property or section
+     *
+     * @param   string  $key    The property or section to remove
+     */
+    public function offsetUnset($key): void
+    {
+        unset($this->$key);
+    }
+
+    /**
+     * Return whether this config has any data
+     *
+     * @return  bool
+     */
+    public function isEmpty()
+    {
+        return empty($this->data);
+    }
+
+    /**
+     * Return the value for the given property or the config for the given section
+     *
+     * @param   string  $key        The name of the property or section
+     * @param   mixed   $default    The value to return in case the property or section is missing
+     *
+     * @return  mixed
+     */
+    public function get($key, $default = null)
+    {
+        if (array_key_exists($key, $this->data)) {
+            return $this->data[$key];
+        }
+
+        return $default;
+    }
+
+    /**
+     * Return all section and property names
+     *
+     * @return  array
+     */
+    public function keys()
+    {
+        return array_keys($this->data);
+    }
+
+    /**
+     * Return this config's data as associative array
+     *
+     * @return  array
+     */
+    public function toArray()
+    {
+        $array = array();
+        foreach ($this->data as $key => $value) {
+            if ($value instanceof self) {
+                $array[$key] = $value->toArray();
+            } else {
+                $array[$key] = $value;
+            }
+        }
+
+        return $array;
+    }
+
+    /**
+     * Merge the given data with this config
+     *
+     * @param   array|ConfigObject $data An array or a config
+     *
+     * @return  $this
+     */
+    public function merge($data)
+    {
+        if ($data instanceof self) {
+            $data = $data->toArray();
+        }
+
+        foreach ($data as $key => $value) {
+            if (array_key_exists($key, $this->data)) {
+                if (is_array($value)) {
+                    if ($this->data[$key] instanceof self) {
+                        $this->data[$key]->merge($value);
+                    } else {
+                        $this->data[$key] = new static($value);
+                    }
+                } else {
+                    $this->data[$key] = $value;
+                }
+            } else {
+                $this->data[$key] = is_array($value) ? new static($value) : $value;
+            }
+        }
+
+        return $this;
+    }
+}