Moved collection iterator classes under Collection_ namespace

lib/Doctrine/Collection.php

@@ -667,7 +667,7 @@ class Doctrine_Collection extends Doctrine_Access implements Countable, Iterator
      * @return Doctrine_Iterator_Normal
      */
     public function getNormalIterator() {
-        return new Doctrine_Iterator_Normal($this);
+        return new Doctrine_Collection_Iterator_Normal($this);
     }
     /**
      * save

lib/Doctrine/Collection/Batch.php

@@ -176,7 +176,7 @@ class Doctrine_Collection_Batch extends Doctrine_Collection {
      * @return Doctrine_Iterator
      */
     public function getIterator() {
-        return new Doctrine_Iterator_Expandable($this);
+        return new Doctrine_Collection_Iterator_Expandable($this);
     }
 }
 

lib/Doctrine/Repository.php → lib/Doctrine/Collection/Iterator.php

@@ -19,119 +19,84 @@
  * <http://www.phpdoctrine.com>.
  */
 /**
- * Doctrine_Repository
- * each record is added into Doctrine_Repository at the same time they are created,
- * loaded from the database or retrieved from the cache
+ * Doctrine_Collection_Iterator
+ * iterates through Doctrine_Collection
  *
- * @author      Konsta Vesterinen
  * @package     Doctrine ORM
  * @url         www.phpdoctrine.com
  * @license     LGPL
  */
-class Doctrine_Table_Repository implements Countable, IteratorAggregate {
+abstract class Doctrine_Collection_Iterator implements Iterator {
     /**
-     * @var object Doctrine_Table $table
+     * @var Doctrine_Collection $collection         
      */
-    private $table;
+    protected $collection;
     /**
-     * @var array $registry
-     * an array of all records
-     * keys representing record object identifiers
+     * @var array $keys
      */
-    private $registry = array();
+    protected $keys;
     /**
-     * constructor
-     *
-     * @param Doctrine_Table $table
+     * @var mixed $key
      */
-    public function __construct(Doctrine_Table $table) {
-        $this->table = $table;
-    }
+    protected $key;
     /**
-     * getTable
-     *
-     * @return object Doctrine_Table
+     * @var integer $index
      */
-    public function getTable() {
-        return $this->table;
-    }
+    protected $index;
     /**
-     * add
-     *
-     * @param Doctrine_Record $record       record to be added into registry
-     * @return boolean
+     * @var integer $count
      */
-    public function add(Doctrine_Record $record) {
-        $oid = $record->getOID();
-
-        if(isset($this->registry[$oid]))
-            return false;
+    protected $count;
 
-        $this->registry[$oid] = $record;
-
-        return true;
-    }
     /**
-     * get
-     * @param integer $oid
-     * @throws Doctrine_Table_Repository_Exception
+     * constructor
+     * @var Doctrine_Collection $collection
      */
-    public function get($oid) {
-        if( ! isset($this->registry[$oid]))
-            throw new Doctrine_Table_Repository_Exception("Unknown object identifier");
-
-        return $this->registry[$oid];
+    public function __construct(Doctrine_Collection $collection) {
+        $this->collection = $collection;
+        $this->keys       = $this->collection->getKeys();
+        $this->count      = $this->collection->count();
     }
     /**
-     * count
-     * Doctrine_Registry implements interface Countable
-     * @return integer                      the number of records this registry has
+     * rewinds the iterator
+     *
+     * @return void
      */
-    public function count() {
-        return count($this->registry);
+    public function rewind() {
+        $this->index = 0;
+        $i = $this->index;
+        if(isset($this->keys[$i]))
+            $this->key   = $this->keys[$i];
     }
-    /**
-     * @param integer $oid                  object identifier
-     * @return boolean                      whether ot not the operation was successful
-     */
-    public function evict($oid) {
-        if( ! isset($this->registry[$oid]))
-            return false;
 
-        unset($this->registry[$oid]);
-        return true;
-    }
-    /**
-     * @return integer                      number of records evicted
-     */
-    public function evictAll() {
-        $evicted = 0;
-        foreach($this->registry as $oid=>$record) {
-            if($this->evict($oid))
-                $evicted++;
-        }
-        return $evicted;
-    }
     /**
-     * getIterator
-     * @return ArrayIterator
+     * returns the current key
+     *
+     * @return integer
      */
-    public function getIterator() {
-        return new ArrayIterator($this->registry);
+    public function key() {
+        return $this->key;
     }
     /**
-     * contains
-     * @param integer $oid                  object identifier
+     * returns the current record
+     *
+     * @return Doctrine_Record
      */
-    public function contains($oid) {
-        return isset($this->registry[$oid]);
+    public function current() {
+        return $this->collection->get($this->key);
     }
     /**
-     * loadAll
+     * advances the internal pointer
+     *
      * @return void
      */
-    public function loadAll() {
-        $this->table->findAll();
+    public function next() {
+        $this->index++;
+        $i = $this->index;
+        if(isset($this->keys[$i]))
+            $this->key   = $this->keys[$i];
     }
 }
 
+
+

lib/Doctrine/Collection/Iterator/Expandable.php

+<?php
+/* 
+ *  $Id$
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.phpdoctrine.com>.
+ */
+Doctrine::autoload('Doctrine_Collection_Iterator');
+/**
+ * Doctrine_Collection_Iterator_Normal
+ *
+ * @package     Doctrine ORM
+ * @url         www.phpdoctrine.com
+ * @license     LGPL
+ */
+class Doctrine_Collection_Iterator_Expandable extends Doctrine_Collection_Iterator {
+    public function valid() {
+        if($this->index < $this->count)
+            return true;
+        elseif($this->index == $this->count) {
+
+            $coll  = $this->collection->expand($this->index);
+
+            if($coll instanceof Doctrine_Collection) {
+                $count = count($coll);
+                if($count > 0) {
+                    $this->keys   = array_merge($this->keys, $coll->getKeys());
+                    $this->count += $count;
+                    return true;
+                }
+            }
+
+            return false;
+        }
+    }
+}
+

lib/Doctrine/Collection/Iterator/Normal.php

+<?php
+/* 
+ *  $Id$
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.phpdoctrine.com>.
+ */
+Doctrine::autoload('Doctrine_Collection_Iterator');
+/**
+ * Doctrine_Collection_Iterator_Normal
+ *
+ * @package     Doctrine ORM
+ * @url         www.phpdoctrine.com
+ * @license     LGPL
+ */
+class Doctrine_Collection_Iterator_Normal extends Doctrine_Collection_Iterator {
+    /**
+     * @return boolean                          whether or not the iteration will continue
+     */
+    public function valid() {
+        return ($this->index < $this->count);
+    }
+}
+

lib/Doctrine/Collection/Iterator/Offset.php

+<?php
+/* 
+ *  $Id$
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.phpdoctrine.com>.
+ */
+Doctrine::autoload('Doctrine_Collection_Iterator');
+/**
+ * Doctrine_Collection_Iterator_Normal
+ *
+ * @package     Doctrine ORM
+ * @url         www.phpdoctrine.com
+ * @license     LGPL
+ */
+class Doctrine_Collection_Iterator_Offset extends Doctrine_Collection_Iterator {
+    public function valid() { }
+}
+
+

lib/Doctrine/Collection/Offset.php

@@ -22,10 +22,10 @@ class Doctrine_Collection_Offset extends Doctrine_Collection {
         return $this->limit;
     }
     /**
-     * @return Doctrine_Iterator_Offset
+     * @return Doctrine_Collection_Iterator_Expandable
      */
     public function getIterator() {
-        return new Doctrine_Iterator_Expandable($this);
+        return new Doctrine_Collection_Iterator_Expandable($this);
     }
 }