Merge pull request php-curl-class#272 from zachborboa/264

Merge php-curl-class#264

Author: zachborboa

src/Curl/CaseInsensitiveArray.php

@@ -4,70 +4,231 @@
 
 class CaseInsensitiveArray implements \ArrayAccess, \Countable, \Iterator
 {
-    private $container = array();
 
+    /**
+     * @var mixed[] Data storage with lower-case keys
+     * @see offsetSet()
+     * @see offsetExists()
+     * @see offsetUnset()
+     * @see offsetGet()
+     * @see count()
+     * @see current()
+     * @see next()
+     * @see key()
+     */
+    private $data = array();
+
+    /**
+     * @var string[] Case-Sensitive keys.
+     * @see offsetSet()
+     * @see offsetUnset()
+     * @see key()
+     */
+    private $keys = array();
+
+    /**
+     * Construct
+     *
+     * Allow creating either an empty Array, or convert an existing Array to a
+     * Case-Insensitive Array.  (Caution: Data may be lost when converting Case-
+     * Sensitive Arrays to Case-Insensitive Arrays)
+     *
+     * @param mixed[] $initial (optional) Existing Array to convert.
+     *
+     * @return void
+     *
+     * @access public
+     */
+    public function __construct(Array $initial = NULL)
+    {
+        if ($initial !== NULL) {
+            foreach ($initial as $key => $value) {
+                $this->offsetSet($key, $value);
+            }
+        }
+    }
+
+    /**
+     * Offset Set
+     *
+     * Set data at a specified Offset.  Converts the offset to lower-case, and
+     * stores the Case-Sensitive Offset and the Data at the lower-case indexes
+     * in $this->keys and @this->data.
+     *
+     * @see https://secure.php.net/manual/en/arrayaccess.offseteset.php
+     *
+     * @param string $offset The offset to store the data at (case-insensitive).
+     * @param mixed $value The data to store at the specified offset.
+     *
+     * @return void
+     *
+     * @access public
+     */
     public function offsetSet($offset, $value)
     {
         if ($offset === null) {
-            $this->container[] = $value;
+            $this->data[] = $value;
         } else {
-            $index = array_search(strtolower($offset), array_keys(array_change_key_case($this->container, CASE_LOWER)));
-            if (!($index === false)) {
-                $keys = array_keys($this->container);
-                unset($this->container[$keys[$index]]);
-            }
-            $this->container[$offset] = $value;
+            $offsetlower = strtolower($offset);
+            $this->data[$offsetlower] = $value;
+            $this->keys[$offsetlower] = $offset;
         }
     }
 
+    /**
+     * Offset Exists
+     *
+     * Checks if the Offset exists in data storage.  The index is looked up with
+     * the lower-case version of the provided offset.
+     *
+     * @see https://secure.php.net/manual/en/arrayaccess.offsetexists.php
+     *
+     * @param string $offset Offset to check
+     *
+     * @return bool If the offset exists.
+     *
+     * @access public
+     */
     public function offsetExists($offset)
     {
-        return array_key_exists(strtolower($offset), array_change_key_case($this->container, CASE_LOWER));
+        return (bool) array_key_exists(strtolower($offset), $this->data);
     }
 
+    /**
+     * Offset Unset
+     *
+     * Unsets the specified offset. Converts the provided offset to lowercase,
+     * and unsets the Case-Sensitive Key, as well as the stored data.
+     *
+     * @see https://secure.php.net/manual/en/arrayaccess.offsetunset.php
+     *
+     * @param string $offset The offset to unset.
+     *
+     * @return void
+     *
+     * @access public
+     */
     public function offsetUnset($offset)
     {
-        unset($this->container[$offset]);
+        $offsetlower = strtolower($offset);
+        unset($this->data[$offsetlower]);
+        unset($this->keys[$offsetlower]);
     }
 
+    /**
+     * Offset Get
+     *
+     * Return the stored data at the provided offset. The offset is converted to
+     * lowercase and the lookup is done on the Data store directly.
+     *
+     * @see https://secure.php.net/manual/en/arrayaccess.offsetget.php
+     *
+     * @param string $offset Offset to lookup.
+     *
+     * @return mixed The data stored at the offset.
+     *
+     * @access public
+     */
     public function offsetGet($offset)
     {
-        $index = array_search(strtolower($offset), array_keys(array_change_key_case($this->container, CASE_LOWER)));
-        if ($index === false) {
-            return null;
-        }
-
-        $values = array_values($this->container);
-        return $values[$index];
+        $offsetlower = strtolower($offset);
+        return isset($this->data[$offsetlower]) ? $this->data[$offsetlower] : NULL;
     }
 
+    /**
+     * Count
+     *
+     * @see https://secure.php.net/manual/en/countable.count.php
+     *
+     * @param void
+     *
+     * @return int The number of elements stored in the Array.
+     *
+     * @access public
+     */
     public function count()
     {
-        return count($this->container);
+        return (int) count($this->data);
     }
 
+    /**
+     * Current
+     *
+     * @see https://secure.php.net/manual/en/iterator.current.php
+     *
+     * @param void
+     *
+     * @return mixed Data at the current position.
+     *
+     * @access public
+     */
     public function current()
     {
-        return current($this->container);
+        return current($this->data);
     }
 
+    /**
+     * Next
+     *
+     * @see https://secure.php.net/manual/en/iterator.next.php
+     *
+     * @param void
+     *
+     * @return void
+     *
+     * @access public
+     */
     public function next()
     {
-        return next($this->container);
+        next($this->data);
     }
 
+    /**
+     * Key
+     *
+     * @see https://secure.php.net/manual/en/iterator.key.php
+     *
+     * @param void
+     *
+     * @return mixed Case-Sensitive key at current position.
+     *
+     * @access public
+     */
     public function key()
     {
-        return key($this->container);
+        $key = key($this->data);
+        return isset($this->keys[$key]) ? $this->keys[$key] : $key;
     }
 
+    /**
+     * Valid
+     *
+     * @see https://secure.php.net/manual/en/iterator.valid.php
+     *
+     * @param void
+     *
+     * @return bool If the current position is valid.
+     *
+     * @access public
+     */
     public function valid()
     {
-        return !($this->current() === false);
+        return (bool) !(key($this->data) === NULL);
     }
 
+    /**
+     * Rewind
+     *
+     * @see https://secure.php.net/manual/en/iterator.rewind.php
+     *
+     * @param void
+     *
+     * @return void
+     *
+     * @access public
+     */
     public function rewind()
     {
-        reset($this->container);
+        reset($this->data);
     }
 }