actually implement SplObjectStorage

hphp/system/php/spl/datastructures/SplObjectStorage.php

@@ -9,9 +9,10 @@
  * cases involving the need to uniquely identify objects.
  *
  */
-class SplObjectStorage implements Iterator, Countable {
+class SplObjectStorage
+  implements Iterator, Countable, Serializable, ArrayAccess {
+
   private $storage = array();
-  private $index = 0;
 
   // This doc comment block generated by idl/sysdoc.php
   /**
@@ -21,8 +22,8 @@ class SplObjectStorage implements Iterator, Countable {
    *
    * @return     mixed   No value is returned.
    */
-  function rewind() {
-    rewind($this->storage);
+  public function rewind() {
+    reset($this->storage);
   }
 
   // This doc comment block generated by idl/sysdoc.php
@@ -34,8 +35,8 @@ class SplObjectStorage implements Iterator, Countable {
    * @return     mixed   Returns TRUE if the iterator entry is valid, FALSE
    *                     otherwise.
    */
-  function valid() {
-    return key($this->storage) !== false;
+  public function valid() {
+    return key($this->storage) !== NULL;
   }
 
   // This doc comment block generated by idl/sysdoc.php
@@ -47,8 +48,8 @@ class SplObjectStorage implements Iterator, Countable {
    * @return     mixed   The index corresponding to the position of the
    *                     iterator.
    */
-  function key() {
-    return $this->index;
+  public function key() {
+    return key($this->storage);
   }
 
   // This doc comment block generated by idl/sysdoc.php
@@ -59,8 +60,8 @@ class SplObjectStorage implements Iterator, Countable {
    *
    * @return     mixed   The object at the current iterator position.
    */
-  function current() {
-    return current($this->storage);
+  public function current() {
+    return current($this->storage)['obj'];
   }
 
   // This doc comment block generated by idl/sysdoc.php
@@ -71,9 +72,8 @@ class SplObjectStorage implements Iterator, Countable {
    *
    * @return     mixed   No value is returned.
    */
-  function next() {
+  public function next() {
     next($this->storage);
-    $this->index++;
   }
 
   // This doc comment block generated by idl/sysdoc.php
@@ -84,7 +84,7 @@ class SplObjectStorage implements Iterator, Countable {
    *
    * @return     mixed   The number of objects in the storage.
    */
-  function count() {
+  public function count() {
     return count($this->storage);
   }
 
@@ -99,13 +99,9 @@ class SplObjectStorage implements Iterator, Countable {
    * @return     mixed   Returns TRUE if the object is in the storage, FALSE
    *                     otherwise.
    */
-  function contains($obj) {
+  public function contains($obj) {
     if (is_object($obj)) {
-      foreach($this->storage as $object) {
-        if ($object === $obj) {
-          return true;
-        }
-      }
+      return isset($this->storage[$this->getHashAndValidate($obj)]);
     }
     return false;
   }
@@ -118,12 +114,15 @@ class SplObjectStorage implements Iterator, Countable {
    * data.
    *
    * @obj        mixed   The object to add.
+   * @data       mixed   The data to associate with the object.
    *
    * @return     mixed   No value is returned.
    */
-  function attach($obj) {
+  public function attach($obj, $data = null) {
     if (is_object($obj) && !$this->contains($obj)) {
-      $this->storage[] = $obj;
+      $this->storage[$this->getHashAndValidate($obj)] = array(
+        'obj' => $obj, 'inf' => $data
+      );
     }
   }
 
@@ -137,15 +136,224 @@ class SplObjectStorage implements Iterator, Countable {
    *
    * @return     mixed   No value is returned.
    */
-  function detach($obj) {
+  public function detach($obj) {
     if (is_object($obj)) {
-      foreach($this->storage as $idx => $object) {
-        if ($object === $obj) {
-          unset($this->storage[$idx]);
-          $this->rewind();
-          return;
-        }
-      }
+      unset($this->storage[$this->getHashAndValidate($obj)]);
     }
   }
+
+  // This doc comment block generated by idl/sysdoc.php
+  /**
+   * ( excerpt from
+   * http://php.net/manual/en/splobjectstorage.offsetexists.php )
+   *
+   * Checks whether an object exists in the storage.
+   *
+   * SplObjectStorage::offsetExists() is an alias of
+   * SplObjectStorage::contains().
+   *
+   * @object     mixed   The object to look for.
+   *
+   * @return     mixed   Returns TRUE if the object exists in the storage,
+   *                     and FALSE otherwise.
+   */
+  public function offsetExists($object) {
+    return $this->contains($object);
+  }
+
+  // This doc comment block generated by idl/sysdoc.php
+  /**
+   * ( excerpt from http://php.net/manual/en/splobjectstorage.offsetget.php )
+   *
+   * Returns the data associated with an object in the storage.
+   *
+   * @object     mixed   The object to look for.
+   *
+   * @return     mixed   The data previously associated with the object in
+   *                     the storage.
+   */
+  public function offsetGet($object) {
+    if (is_object($object)) {
+      if (!$this->contains($object)) {
+        throw new UnexpectedValueException('Object not found');
+      }
+      return $this->storage[$this->getHashAndValidate($object)]['inf'];
+    }
+  }
+
+  // This doc comment block generated by idl/sysdoc.php
+  /**
+   * ( excerpt from http://php.net/manual/en/splobjectstorage.offsetset.php )
+   *
+   * Associate data to an object in the storage.
+   *
+   * SplObjectStorage::offsetSet() is an alias of
+   * SplObjectStorage::attach().
+   *
+   * @object     mixed   The object to associate data with.
+   * @data       mixed   The data to associate with the object.
+   *
+   * @return     mixed   No value is returned.
+   */
+  public function offsetSet($object, $data = null) {
+    return $this->attach($object, $data);
+  }
+
+  // This doc comment block generated by idl/sysdoc.php
+  /**
+   * ( excerpt from http://php.net/manual/en/splobjectstorage.offsetunset.php
+   * )
+   *
+   * Removes an object from the storage.
+   *
+   * SplObjectStorage::offsetUnset() is an alias of
+   * SplObjectStorage::detach().
+   *
+   * @object     mixed   The object to remove.
+   *
+   * @return     mixed   No value is returned.
+   */
+  public function offsetUnset($object) {
+    return $this->detach($object);
+  }
+
+  // This doc comment block generated by idl/sysdoc.php
+  /**
+   * ( excerpt from http://php.net/manual/en/splobjectstorage.removeall.php )
+   *
+   * Removes objects contained in another storage from the current storage.
+   *
+   * @storage    mixed   The storage containing the elements to remove.
+   *
+   * @return     mixed   No value is returned.
+   */
+  public function removeAll($storage) {
+    $cache = array();
+    foreach ($storage as $obj) {
+      $cache[] = $obj;
+    }
+    foreach ($cache as $obj) {
+      $this->detach($obj);
+    }
+  }
+
+  // This doc comment block generated by idl/sysdoc.php
+  /**
+   * ( excerpt from
+   * http://php.net/manual/en/splobjectstorage.removeallexcept.php )
+   *
+   * Removes all objects except for those contained in another storage from
+   * the current storage.
+   *
+   * @storage    mixed   The storage containing the elements to retain in the
+   *                     current storage.
+   *
+   * @return     mixed   No value is returned.
+   */
+  public function removeAllExcept($storage) {
+    $cache = array();
+    foreach ($this->storage as $object) {
+      if (!$storage->contains($object['obj'])) {
+        $cache[] = $object['obj'];
+      }
+    }
+    foreach ($cache as $object) {
+      $this->detach($object);
+    }
+  }
+
+  // This doc comment block generated by idl/sysdoc.php
+  /**
+   * ( excerpt from http://php.net/manual/en/splobjectstorage.addall.php )
+   *
+   * Adds all objects-data pairs from a different storage in the current
+   * storage.
+   *
+   * @storage    mixed   The storage you want to import.
+   *
+   * @return     mixed   No value is returned.
+   */
+  public function addAll($storage) {
+    foreach ($storage as $object) {
+      $this->attach($object);
+    }
+  }
+
+  // This doc comment block generated by idl/sysdoc.php
+  /**
+   * ( excerpt from http://php.net/manual/en/splobjectstorage.gethash.php )
+   *
+   * This method calculates an identifier for the objects added to an
+   * SplObjectStorage object.
+   *
+   * The implementation in SplObjectStorage returns the same value as
+   * spl_object_hash().
+   *
+   * The storage object will never contain more than one object with the
+   * same identifier. As such, it can be used to implement a set (a
+   * collection of unique values) where the quality of an object being unique
+   * is determined by the value returned by this function being unique.
+   *
+   * @object     mixed   The object whose identifier is to be calculated.
+   *
+   * @return     mixed   A string with the calculated identifier.
+   */
+  public function getHash($object) {
+    return spl_object_hash($object);
+  }
+
+  private function getHashAndValidate($object) {
+    $hash = $this->getHash($object);
+    if (!is_string($hash)) {
+      throw new RuntimeException('Hash needs to be a string');
+    }
+    return $hash;
+  }
+
+  // This doc comment block generated by idl/sysdoc.php
+  /**
+   * ( excerpt from http://php.net/manual/en/splobjectstorage.serialize.php )
+   *
+   * Returns a string representation of the storage.
+   *
+   * @return     mixed   A string representing the storage.
+   */
+  public function serialize() {
+    return $this->storage;
+  }
+
+  // This doc comment block generated by idl/sysdoc.php
+  /**
+   * ( excerpt from http://php.net/manual/en/splobjectstorage.unserialize.php
+   * )
+   *
+   * Unserializes storage entries and attach them to the current storage.
+   *
+   * @serialized mixed   The serialized representation of a storage.
+   *
+   * @return     mixed   No value is returned.
+   */
+  public function unserialize($serialized) {
+    $arr = unserialize($serialized);
+    if (is_array($arr)) {
+      $this->storage = $arr;
+    }
+  }
+
+  // This doc comment block generated by idl/sysdoc.php
+  /**
+   * ( excerpt from http://php.net/manual/en/splobjectstorage.setinfo.php )
+   *
+   * Associates data, or info, with the object currently pointed to by the
+   * iterator.
+   *
+   * @data       mixed   The data to associate with the current iterator
+   *                     entry.
+   *
+   * @return     mixed   No value is returned.
+   */
+  public function setInfo($data) {
+    current($this->storage)['inf'] = $data;;
+  }
+
 }