Merge pull request #121 from ergnuor/connection-and-result-set-refactoring/ergnuor

refactor Connection and ResultSet classes

Author: oohnoitz

src/Drivers/ConnectionBase.php

@@ -18,6 +18,13 @@ abstract class ConnectionBase implements ConnectionInterface
      */
     protected $connection = null;
 
+    /**
+     * Disables any warning outputs returned on the connection with @ prefix.
+     *
+     * @var boolean
+     */
+    protected $silence_connection_warning = false;
+
     /**
      * Sets one or more connection parameters.
      *
@@ -133,4 +140,30 @@ public function quoteArr(Array $array = array())
 
         return $result;
     }
+
+    /**
+     * Establishes a connection if needed
+     * @throws ConnectionException
+     */
+    protected function ensureConnection()
+    {
+        try {
+            $this->getConnection();
+        } catch (ConnectionException $e) {
+            $this->connect();
+        }
+    }
+
+    /**
+     * Forces the connection to suppress all errors returned. This should only be used
+     * when the production server is running with high error reporting settings.
+     *
+     * @param boolean $enable True if it should be enabled, false if it should be disabled
+     * @deprecated
+     * not good
+     */
+    public function silenceConnectionWarning($enable = true)
+    {
+        $this->silence_connection_warning = $enable;
+    }
 }

src/Drivers/MultiResultSetAdapterInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Foolz\SphinxQL\Drivers;
+
+
+interface MultiResultSetAdapterInterface
+{
+    public function getNext();
+
+    public function current();
+
+    public function valid();
+}

src/Drivers/MultiResultSetBase.php

@@ -1,6 +1,8 @@
 <?php
 namespace Foolz\SphinxQL\Drivers;
 
+use Foolz\SphinxQL\Exception\DatabaseException;
+
 abstract class MultiResultSetBase implements MultiResultSetInterface
 {
     /**
@@ -11,7 +13,27 @@ abstract class MultiResultSetBase implements MultiResultSetInterface
     /**
      * @var int
      */
-    public $cursor = null;
+    public $cursor = 0;
+
+    /**
+     * @var int
+     */
+    protected $next_cursor = 0;
+
+    /**
+     * @var \Foolz\SphinxQL\Drivers\ResultSetInterface|null
+     */
+    protected $rowSet = null;
+
+    /**
+     * @var \Foolz\SphinxQL\Drivers\MultiResultSetAdapterInterface|null
+     */
+    protected $adapter = null;
+
+    /**
+     * @var bool
+     */
+    protected $valid = true;
 
     public function getStored()
     {
@@ -34,7 +56,7 @@ public function getStored()
     public function offsetExists($offset)
     {
         $this->store();
-        return $offset >= 0 && $offset < count($this->stored);
+        return $this->storedValid($offset);
     }
 
     /**
@@ -95,11 +117,7 @@ public function offsetUnset($offset)
      */
     public function next()
     {
-        if ($this->cursor === null) {
-            $this->cursor = 0;
-        } else {
-            $this->cursor++;
-        }
+        $this->rowSet = $this->getNext();
     }
 
     /**
@@ -122,7 +140,9 @@ public function key()
     public function rewind()
     {
         // we actually can't roll this back unless it was stored first
-        $this->cursor = null;
+        $this->cursor = 0;
+        $this->next_cursor = 0;
+        $this->rowSet = $this->getNext();
     }
 
     /**
@@ -139,4 +159,95 @@ public function count()
         $this->store();
         return count($this->stored);
     }
+
+    /**
+     * (PHP 5 &gt;= 5.0.0)<br/>
+     * Checks if current position is valid
+     * @link http://php.net/manual/en/iterator.valid.php
+     * @return boolean The return value will be casted to boolean and then evaluated.
+     * Returns true on success or false on failure.
+     */
+    public function valid()
+    {
+        if ($this->stored !== null) {
+            return $this->storedValid();
+        }
+
+        return $this->adapter->valid();
+    }
+
+    /**
+     * (PHP 5 &gt;= 5.0.0)<br/>
+     * Return the current element
+     * @link http://php.net/manual/en/iterator.current.php
+     * @return mixed Can return any type.
+     */
+    public function current()
+    {
+        $rowSet = $this->rowSet;
+        unset($this->rowSet);
+        return $rowSet;
+    }
+
+    /**
+     * @param null|int $cursor
+     * @return bool
+     */
+    protected function storedValid($cursor = null)
+    {
+        $cursor = (!is_null($cursor) ? $cursor : $this->cursor);
+        return $cursor >= 0 && $cursor < count($this->stored);
+    }
+
+    /*
+     * @return \Foolz\SphinxQL\Drivers\ResultSetInterface|false
+     */
+    public function getNext()
+    {
+        $this->cursor = $this->next_cursor;
+
+        if ($this->stored !== null) {
+            $resultSet = !$this->storedValid() ? false : $this->stored[$this->cursor];
+        } else {
+            if ($this->next_cursor > 0) {
+                $this->adapter->getNext();
+            }
+
+            $resultSet = !$this->adapter->valid() ? false : $this->adapter->current();
+        }
+
+        $this->next_cursor++;
+
+        return $resultSet;
+    }
+
+    /**
+     * @return $this
+     * @throws DatabaseException
+     */
+    public function store()
+    {
+        if ($this->stored !== null) {
+            return $this;
+        }
+
+        // don't let users mix storage and driver cursors
+        if ($this->next_cursor > 0) {
+            throw new DatabaseException('The MultiResultSet is using the driver cursors, store() can\'t fetch all the data');
+        }
+
+        $store = array();
+        while ($set = $this->getNext()) {
+            // this relies on stored being null!
+            $store[] = $set->store();
+        }
+
+        $this->cursor = 0;
+        $this->next_cursor = 0;
+
+        // if we write the array straight to $this->stored it won't be null anymore and functions relying on null will break
+        $this->stored = $store;
+
+        return $this;
+    }
 }

src/Drivers/Mysqli/Connection.php

@@ -7,6 +7,11 @@
 use Foolz\SphinxQL\Exception\SphinxQLException;
 use Foolz\SphinxQL\Drivers\ConnectionBase;
 
+/**
+ * SphinxQL connection class utilizing the MySQLi extension.
+ * It also contains escaping and quoting functions.
+ * @package Foolz\SphinxQL
+ */
 class Connection extends ConnectionBase
 {
     /**
@@ -16,24 +21,6 @@ class Connection extends ConnectionBase
      */
     protected $internal_encoding = null;
 
-    /**
-     * Disables any warning outputs returned on the \MySQLi connection with @ prefix.
-     *
-     * @var boolean
-     */
-    protected $silence_connection_warning = false;
-
-    /**
-     * Forces the \MySQLi connection to suppress all errors returned. This should only be used
-     * when the production server is running with high error reporting settings.
-     *
-     * @param boolean $enable True if it should be enabled, false if it should be disabled
-     */
-    public function silenceConnectionWarning($enable = true)
-    {
-        $this->silence_connection_warning = $enable;
-    }
-
     /**
      * Returns the internal encoding.
      *
@@ -92,19 +79,6 @@ public function ping()
         return $this->getConnection()->ping();
     }
 
-    /**
-     * Establishes a connection if needed
-     * @throws ConnectionException
-     */
-    private function ensureConnection()
-    {
-        try {
-            $this->getConnection();
-        } catch (ConnectionException $e) {
-            $this->connect();
-        }
-    }
-
     /**
      * Closes and unset the connection to the Sphinx server.
      */
@@ -134,7 +108,7 @@ public function query($query)
                 $this->getConnection()->error.' [ '.$query.']');
         }
 
-        return new ResultSet($this, $resource);
+        return ResultSet::make($this, $resource);
     }
 
     /**
@@ -162,7 +136,7 @@ public function multiQuery(Array $queue)
                 $this->getConnection()->error.' [ '.implode(';', $queue).']');
         };
 
-        return new MultiResultSet($this, $count);
+        return MultiResultSet::make($this);
     }
 
     /**