Merge pull request #198 from ben221199/php8

Author: oohnoitz

.travis.yml

@@ -1,12 +1,11 @@
 language: php
 
 php:
-  - 5.6
-  - 7.0
   - 7.1
   - 7.2
   - 7.3
   - 7.4
+  - 8.0
 
 env:
   - DRIVER=mysqli SEARCH_BUILD=SPHINX2 EXCLUDE_GROUP="--exclude-group=Manticore"

CHANGELOG.md

@@ -1,48 +1,47 @@
-#### 2.1.0
+#### 3.0.0
+* Added support for PHP 8
+* Renamed `Foolz\SphinxQL\Match` to `Foolz\SphinxQL\MatchBuilder` (BREAKING CHANGE)
 
-* added exception code and previous throwable to errors
-* added `setType` method to `SphinxQL` class
-* added support for `MATCH` to `DELETE` queries
-* updated MySQLi driver to silence internal warnings by default
+#### 2.1.0
+* Added exception code and previous throwable to errors
+* Added `setType` method to `SphinxQL` class
+* Added support for `MATCH` to `DELETE` queries
+* Updated MySQLi driver to silence internal warnings by default
 
 #### 2.0.0
-
-* added support for [Manticore](https://manticoresearch.com)
-* added `Percolate` class for `Manticore`
-* added `orPhrase` method to `Match` class
-* added `resetFacets` method to `SphinxQL` class
-* added support for multi-document snippet call
-* fixed `Connection` exception thrown
-* fixed incorrect property accessibility/visibility
-* refactored `ResultSet` and `MultiResultSet` classes to reduce duplicate code
-* removed `Connection` error suppression
-* removed `SphinxQL\Drivers\ResultSetAdapterInterface` constants
-* removed static `SphinxQL::create` method
-* removed deprecated `\Foolz\SphinxQL\Connection`
-* removed support for PHP 5.3 and HHVM
-* updated fetch type for drivers to use `boolean` to return assoc/indexed arrays
-* updated PHPDoc blocks
+* Added support for [Manticore](https://manticoresearch.com)
+* Added `Percolate` class for `Manticore`
+* Added `orPhrase` method to `Match` class
+* Added `resetFacets` method to `SphinxQL` class
+* Added support for multi-document snippet call
+* Fixed `Connection` exception thrown
+* Fixed incorrect property accessibility/visibility
+* Refactored `ResultSet` and `MultiResultSet` classes to reduce duplicate code
+* Removed `Connection` error suppression
+* Removed `SphinxQL\Drivers\ResultSetAdapterInterface` constants
+* Removed static `SphinxQL::create` method
+* Removed deprecated `\Foolz\SphinxQL\Connection`
+* Removed support for PHP 5.3 and HHVM
+* Updated fetch type for drivers to use `boolean` to return assoc/indexed arrays
+* Updated PHPDoc blocks
 
 Note: This release contains **breaking changes** around the instantiation of the `SphinxQL` class with the removal of static methods. Please refer to the README for any API changes.
 
 #### 1.2.0
-
-* added support for `GROUP N BY`
-* refactored `Connection`, `\Foolz\SphinxQL\Connection` is now deprecated.
-* refactored `ResultSet` and `MultiResultSet` to reduce duplicate code
+* Added support for `GROUP N BY`
+* Refactored `Connection`, `\Foolz\SphinxQL\Connection` is now deprecated.
+* Refactored `ResultSet` and `MultiResultSet` to reduce duplicate code
 
 Note: This release contains **breaking changes** with the introduction of `ResultSet` and `MultiResultSet` changes. Please refer to the README for any API changes.
 
 #### 0.9.7
-
-* added support for unix sockets
-* added `NOT IN` condition in `WHERE` statements
+* Added support for unix sockets
+* Added `NOT IN` condition in `WHERE` statements
 
 #### 0.9.6
-
-* added named integer lists support to `OPTION` with associative array (@alpha0010)
-* deprecated special case `OPTION` for `field_weights` and `index_weights`
-* forced `Connection` to use utf8 charset (@t1gor)
+* Added named integer lists support to `OPTION` with associative array (@alpha0010)
+* Deprecated special case `OPTION` for `field_weights` and `index_weights`
+* Forced `Connection` to use utf8 charset (@t1gor)
 
 #### 0.9.5
 * `Expression` support for `OPTION` value
@@ -53,58 +52,47 @@ Note: This release contains **breaking changes** with the introduction of `Resul
 * Added `ConnectionInterface`
 
 #### 0.9.3
-
 * HHVM support
 * Added escaping of new MATCH features by lowercasing the search string
 
 #### 0.9.2
-
-* created `Helper` class to contain non-query-builder query methods, all returning `SphinxQL` objects
-* deprecated all non-query-builder query methods in `SphinxQL` class
-* improved `$sq->enqueue()` in `SphinxQL` class to have a parameter to append any custom `SphinxQL` objects
-* added `$sq->query()` method to `SphinxQL` to allow setting SQL queries without executing them
+* Created `Helper` class to contain non-query-builder query methods, all returning `SphinxQL` objects
+* Deprecated all non-query-builder query methods in `SphinxQL` class
+* Improved `$sq->enqueue()` in `SphinxQL` class to have a parameter to append any custom `SphinxQL` objects
+* Added `$sq->query()` method to `SphinxQL` to allow setting SQL queries without executing them
 
 #### 0.9.1
-
-* deprecated SphinxQL::forge() with static Connection and implemented SphinxQL::create($conn)
-* added array and * support to MATCH columns (thanks to @FindTheBest)
-* added Expression support to MATCH value
+* Deprecated SphinxQL::forge() with static Connection and implemented SphinxQL::create($conn)
+* Added array and * support to MATCH columns (thanks to @FindTheBest)
+* Added Expression support to MATCH value
 
 #### 0.9.0
-
-* refactored to be fully OOP
-* changed code style to be PSR-2 compliant
-* removed all unnecessary `static` keywords
-* removed old bootstrap file for fuelphp
+* Refactored to be fully OOP
+* Changed code style to be PSR-2 compliant
+* Removed all unnecessary `static` keywords
+* Removed old bootstrap file for fuelphp
 
 #### 0.8.6
-
-* added Connection::ping()
-* added Connection::close()
-* fixed uncaught exception thrown by Connection::getConnection()
+* Added Connection::ping()
+* Added Connection::close()
+* Fixed uncaught exception thrown by Connection::getConnection()
 
 #### 0.8.5
-
-* removed Array typehints
-* removed unsupported charset argument
+* Removed Array typehints
+* Removed unsupported charset argument
 
 #### 0.8.4
-
-* fixed composer bootstrap
-* removed `Sphinxql` prefix on Connection and Expression classes
+* Fixed composer bootstrap
+* Removed `Sphinxql` prefix on Connection and Expression classes
 
 #### 0.8.3
-
-* added Queue support
+* Added Queue support
 
 #### 0.8.2
-
-* fixed composer bootstrap
+* Fixed composer bootstrap
 
 #### 0.8.1
-
-* improved phpunit tests
+* Improved phpunit tests
 
 #### 0.8.0
-
-* initial release
+* Initial release

README.md

@@ -10,7 +10,7 @@ Query Builder for SphinxQL
 
 This is a SphinxQL Query Builder used to work with SphinxQL, a SQL dialect used with the Sphinx search engine and it's fork Manticore. It maps most of the functions listed in the [SphinxQL reference](http://sphinxsearch.com/docs/current.html#SphinxQL-reference) and is generally [faster](http://sphinxsearch.com/blog/2010/04/25/sphinxapi-vs-SphinxQL-benchmark/) than the available Sphinx API.
 
-This Query Builder has no dependencies except PHP 5.6, `\MySQLi` extension, `PDO`, and [Sphinx](http://sphinxsearch.com)/[Manticore](https://manticoresearch.com).
+This Query Builder has no dependencies except PHP 7.1 or later, `\MySQLi` extension, `PDO`, and [Sphinx](http://sphinxsearch.com)/[Manticore](https://manticoresearch.com).
 
 ### Missing methods?
 

composer.json

@@ -12,10 +12,10 @@
         "irc": "irc://irc.irchighway.net/fooldriver"
     },
     "require": {
-        "php": "^5.6 || ^7.0"
+        "php": "^5.6 || ^7 || ^8"
     },
     "require-dev": {
-        "phpunit/phpunit": "^5.7 || 6.3.*"
+        "phpunit/phpunit": "^5 || ^6 || ^7 || ^8 || ^9"
     },
     "autoload": {
         "psr-4": {

src/Match.php renamed to src/MatchBuilder.php

@@ -5,7 +5,7 @@
 /**
  * Query Builder class for Match statements.
  */
-class Match
+class MatchBuilder
 {
     /**
      * The last compiled query.
@@ -51,12 +51,12 @@ public function __construct(SphinxQL $sphinxql)
      *    });
      *    // (a | b)
      *
-     *    $sub = new Match($sphinxql);
+     *    $sub = new MatchBuilder($sphinxql);
      *    $sub->match('a')->orMatch('b');
      *    $match->match($sub);
      *    // (a | b)
      *
-     * @param string|Match|\Closure $keywords The text or expression to match.
+     * @param string|MatchBuilder|\Closure $keywords The text or expression to match.
      *
      * @return $this
      */
@@ -79,7 +79,7 @@ public function match($keywords = null)
      *    $match->match('test')->orMatch('case');
      *    // test | case
      *
-     * @param string|Match|\Closure $keywords The text or expression to alternatively match.
+     * @param string|MatchBuilder|\Closure $keywords The text or expression to alternatively match.
      *
      * @return $this
      */
@@ -101,7 +101,7 @@ public function orMatch($keywords = null)
      *    $match->match('test')->maybe('case');
      *    // test MAYBE case
      *
-     * @param string|Match|\Closure $keywords The text or expression to optionally match.
+     * @param string|MatchBuilder|\Closure $keywords The text or expression to optionally match.
      *
      * @return $this
      */
@@ -500,7 +500,7 @@ public function compile()
             if (key($token) == 'MATCH') {
                 if ($token['MATCH'] instanceof Expression) {
                     $query .= $token['MATCH']->value().' ';
-                } elseif ($token['MATCH'] instanceof Match) {
+                } elseif ($token['MATCH'] instanceof MatchBuilder) {
                     $query .= '('.$token['MATCH']->compile()->getCompiled().') ';
                 } elseif ($token['MATCH'] instanceof \Closure) {
                     $sub = new static($this->sphinxql);

src/SphinxQL.php

@@ -470,10 +470,10 @@ public function compileMatch()
             foreach ($this->match as $match) {
                 $pre = '';
                 if ($match['column'] instanceof \Closure) {
-                    $sub = new Match($this);
+                    $sub = new MatchBuilder($this);
                     call_user_func($match['column'], $sub);
                     $pre .= $sub->compile()->getCompiled();
-                } elseif ($match['column'] instanceof Match) {
+                } elseif ($match['column'] instanceof MatchBuilder) {
                     $pre .= $match['column']->compile()->getCompiled();
                 } elseif (empty($match['column'])) {
                     $pre .= '';
@@ -980,7 +980,7 @@ public function from($array = null)
     /**
      * MATCH clause (Sphinx-specific)
      *
-     * @param mixed  $column The column name (can be array, string, Closure, or Match)
+     * @param mixed  $column The column name (can be array, string, Closure, or MatchBuilder)
      * @param string $value  The value
      * @param bool   $half   Exclude ", |, - control characters from being escaped
      *

tests/SphinxQL/ConnectionTest.php

@@ -11,13 +11,13 @@ class ConnectionTest extends \PHPUnit\Framework\TestCase
      */
     private $connection = null;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $this->connection = TestUtil::getConnectionDriver();
         $this->connection->setParams(array('host' => '127.0.0.1', 'port' => 9307));
     }
 
-    protected function tearDown()
+    protected function tearDown(): void
     {
         $this->connection = null;
     }
@@ -80,11 +80,9 @@ public function testGetConnection()
         $this->assertNotNull($this->connection->getConnection());
     }
 
-    /**
-     * @expectedException Foolz\SphinxQL\Exception\ConnectionException
-     */
     public function testGetConnectionThrowsException()
     {
+        $this->expectException(Foolz\SphinxQL\Exception\ConnectionException::class);
         $this->connection->getConnection();
     }
 
@@ -96,11 +94,9 @@ public function testConnect()
         $this->connection->connect();
     }
 
-    /**
-     * @expectedException Foolz\SphinxQL\Exception\ConnectionException
-     */
     public function testConnectThrowsException()
     {
+        $this->expectException(Foolz\SphinxQL\Exception\ConnectionException::class);
         $this->connection->setParam('port', 9308);
         $this->connection->connect();
     }
@@ -111,11 +107,9 @@ public function testPing()
         $this->assertTrue($this->connection->ping());
     }
 
-    /**
-     * @expectedException Foolz\SphinxQL\Exception\ConnectionException
-     */
     public function testClose()
     {
+        $this->expectException(Foolz\SphinxQL\Exception\ConnectionException::class);
         $encoding = mb_internal_encoding();
         $this->connection->connect();
 
@@ -150,29 +144,23 @@ public function testMultiQuery()
         ), $query->getNext()->fetchAllAssoc());
     }
 
-    /**
-     * @expectedException        Foolz\SphinxQL\Exception\SphinxQLException
-     * @expectedExceptionMessage The Queue is empty.
-     */
     public function testEmptyMultiQuery()
     {
+        $this->expectException(Foolz\SphinxQL\Exception\SphinxQLException::class);
+        $this->expectExceptionMessage('The Queue is empty.');
         $this->connection->connect();
         $this->connection->multiQuery(array());
     }
 
-    /**
-     * @expectedException Foolz\SphinxQL\Exception\DatabaseException
-     */
     public function testMultiQueryThrowsException()
     {
+        $this->expectException(Foolz\SphinxQL\Exception\DatabaseException::class);
         $this->connection->multiQuery(array('SHOW METAL'));
     }
 
-    /**
-     * @expectedException Foolz\SphinxQL\Exception\DatabaseException
-     */
     public function testQueryThrowsException()
     {
+        $this->expectException(Foolz\SphinxQL\Exception\DatabaseException::class);
         $this->connection->query('SHOW METAL');
     }
 
@@ -182,11 +170,9 @@ public function testEscape()
         $this->assertEquals('\'\\\' \\"\\" \\\'\\\' \'', $result);
     }
 
-    /**
-     * @expectedException Foolz\SphinxQL\Exception\ConnectionException
-     */
     public function testEscapeThrowsException()
     {
+        $this->expectException(Foolz\SphinxQL\Exception\ConnectionException::class);
         // or we get the wrong error popping up
         $this->connection->setParam('port', 9308);
         $this->connection->connect();
@@ -201,7 +187,7 @@ public function testQuote()
         $this->assertEquals(0, $this->connection->quote(false));
         $this->assertEquals("fo'o'bar", $this->connection->quote(new Expression("fo'o'bar")));
         $this->assertEquals(123, $this->connection->quote(123));
-        $this->assertEquals("12.3", $this->connection->quote(12.3));
+        $this->assertEquals("12.300000", $this->connection->quote(12.3));
         $this->assertEquals("'12.3'", $this->connection->quote('12.3'));
         $this->assertEquals("'12'", $this->connection->quote('12'));
     }
@@ -210,7 +196,7 @@ public function testQuoteArr()
     {
         $this->connection->connect();
         $this->assertEquals(
-            array('null', 1, 0, "fo'o'bar", 123, "12.3", "'12.3'", "'12'"),
+            array('null', 1, 0, "fo'o'bar", 123, "12.300000", "'12.3'", "'12'"),
             $this->connection->quoteArr(array(null, true, false, new Expression("fo'o'bar"), 123, 12.3, '12.3', '12'))
         );
     }

tests/SphinxQL/FacetTest.php

@@ -29,7 +29,7 @@ class FacetTest  extends \PHPUnit\Framework\TestCase
             'title' => 'what is there to do', 'content' => 'we need to create dummy data for tests'),
     );
 
-    public static function setUpBeforeClass()
+    public static function setUpBeforeClass(): void
     {
         $conn = TestUtil::getConnectionDriver();
         $conn->setParam('port', 9307);