Update documentation for conditional query operators and add :notlike

.gitignore

@@ -3,4 +3,9 @@ composer.phar
 composer.lock
 vendor
 tests/spot_test.sqlite
-.idea
+.idea
+/phpunit.phar
+/tests/.phpunit.result.cache
+/.phpunit.result.cache
+/error.log
+/rector.php

README.md

@@ -326,6 +326,22 @@ a single loaded entity object, or boolean `false`.
 
 ### Conditional Queries
 
+Conditional queries allow you to alter the way the database selects your data.
+Supported conditions are:
+
+* Less than `<`, `:lt`
+* Less than or equal `<=`, `:lte`
+* Greater than `>`, `:gt`
+* Greater than or equal `>=`, `:gte`
+* RegExp `~=`, `=~`, `:regex`
+* Like `:like`
+* Not Like `:notlike`
+* Full Text `:fulltext`
+* Full Text Boolean `:fulltext_boolean`
+* In `in`, `:in`
+* Not `<>`, `!=`, `:ne`, `:not`
+* Equals `=`, `:eq`
+
 ```php
 # All posts with a 'published' status, descending by date_created
 $posts = $mapper->all()
@@ -345,6 +361,12 @@ $posts = $mapper->all()
     ->where(['id' => [1, 2, 5, 12, 15]]);
 ```
 
+For custom query operators you may add your own operator. See `\Spot\Query\Operator\Like` for an simple example.
+
+```php
+\Spot\Query::addWhereOperator(':youroperator', YourOperator::class);
+```
+
 ### Joins
 
 Joins are currently not enabled by Spot's query builder. The Doctine DBAL query

composer.json

@@ -13,13 +13,14 @@
         }
     ],
     "require": {
-        "php": ">=5.4.0",
-        "vlucas/valitron": "~1.1",
-        "doctrine/dbal": "^2.5.4",
-        "sabre/event": "~2.0"
+        "php": ">= 8.1.11",
+        "vlucas/valitron": "^1.4",
+        "doctrine/dbal": "^2.13",
+        "sabre/event": "~3.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^4.8"
+        "phpunit/phpunit": "^9.5",
+        "rector/rector": "^0.14.5"
     },
     "autoload": {
         "psr-4": {

lib/Config.php

@@ -6,7 +6,7 @@
 /**
  * @package Spot
  */
-class Config implements \Serializable
+class Config
 {
     protected $_defaultConnection;
     protected $_connections = [];
@@ -273,16 +273,12 @@ public static function parseDsn($dsn)
         return $parsed;
     }
 
-    /**
-     * Default serialization behavior is to not attempt to serialize stored
-     * adapter connections at all (thanks @TheSavior re: Issue #7)
-     */
-    public function serialize()
+    public function __serialize(): array
     {
-        return serialize([]);
+        return [];
     }
 
-    public function unserialize($serialized)
+    public function __unserialize(array $serialized): void
     {
     }
 }

lib/Entity.php

@@ -610,7 +610,7 @@ public function entity()
      *
      * @inheritdoc
      */
-    public function jsonSerialize()
+    public function jsonSerialize(): mixed
     {
         return $this->toArray();
     }

lib/Entity/Collection.php

@@ -162,7 +162,7 @@ public function toArray($keyColumn = null, $valueColumn = null)
      *
      * @inheritdoc
      */
-    public function jsonSerialize()
+    public function jsonSerialize(): mixed
     {
         return $this->toArray();
     }
@@ -232,7 +232,7 @@ public function __toString()
      *
      * @inheritdoc
      */
-    public function count()
+    public function count(): int
     {
         return count($this->results);
     }
@@ -242,7 +242,7 @@ public function count()
      *
      * @inheritdoc
      */
-    public function current()
+    public function current(): mixed
     {
         return current($this->results);
     }
@@ -252,7 +252,7 @@ public function current()
      *
      * @inheritdoc
      */
-    public function key()
+    public function key(): mixed
     {
         return key($this->results);
     }
@@ -262,7 +262,7 @@ public function key()
      *
      * @inheritdoc
      */
-    public function next()
+    public function next(): void
     {
         next($this->results);
     }
@@ -272,7 +272,7 @@ public function next()
      *
      * @inheritdoc
      */
-    public function rewind()
+    public function rewind(): void
     {
         reset($this->results);
     }
@@ -282,7 +282,7 @@ public function rewind()
      *
      * @inheritdoc
      */
-    public function valid()
+    public function valid(): bool
     {
         return (current($this->results) !== false);
     }
@@ -292,32 +292,32 @@ public function valid()
      *
      * @inheritdoc
      */
-    public function offsetExists($key)
+    public function offsetExists(mixed $offset): bool
     {
-        return isset($this->results[$key]);
+        return isset($this->results[$offset]);
     }
 
     /**
      * SPL - ArrayAccess
      *
      * @inheritdoc
      */
-    public function offsetGet($key)
+    public function offsetGet(mixed $offset): mixed
     {
-        return $this->results[$key];
+        return $this->results[$offset];
     }
 
     /**
      * SPL - ArrayAccess
      *
      * @inheritdoc
      */
-    public function offsetSet($key, $value)
+    public function offsetSet(mixed $offset, mixed $value): void
     {
-        if ($key === null) {
-            return $this->results[] = $value;
+        if ($offset === null) {
+            $this->results[] = $value;
         } else {
-            return $this->results[$key] = $value;
+            $this->results[$offset] = $value;
         }
     }
 
@@ -326,12 +326,12 @@ public function offsetSet($key, $value)
      *
      * @inheritdoc
      */
-    public function offsetUnset($key)
+    public function offsetUnset(mixed $offset): void
     {
-        if (is_int($key)) {
-            array_splice($this->results, $key, 1);
+        if (is_int($offset)) {
+            array_splice($this->results, $offset, 1);
         } else {
-            unset($this->results[$key]);
+            unset($this->results[$offset]);
         }
     }
 }

lib/EntityInterface.php

@@ -154,7 +154,7 @@ public function primaryKey();
     /**
      * Return array for json_encode()
      */
-    public function jsonSerialize();
+    public function jsonSerialize(): mixed;
 
     /**
      * String representation of the class (JSON)

lib/Provider/Laravel.php

@@ -8,6 +8,7 @@
 class Laravel extends ServiceProvider
 {
     protected $config = [];
+    protected $app = [];
 
     public function __construct($app)
     {

lib/Query.php

@@ -76,6 +76,7 @@ class Query implements \Countable, \IteratorAggregate, \ArrayAccess, \JsonSerial
         '=~' => 'Spot\Query\Operator\RegExp',
         ':regex' => 'Spot\Query\Operator\RegExp',
         ':like' => 'Spot\Query\Operator\Like',
+        ':notlike' => 'Spot\Query\Operator\NotLike',
         ':fulltext' => 'Spot\Query\Operator\FullText',
         ':fulltext_boolean' => 'Spot\Query\Operator\FullTextBoolean',
         'in' => 'Spot\Query\Operator\In',
@@ -562,7 +563,7 @@ public function offset($offset)
      *
      * @return int
      */
-    public function count()
+    public function count(): int
     {
         $countCopy = clone $this->builder();
         $stmt = $countCopy->select('COUNT(*)')->resetQueryPart('orderBy')->execute();
@@ -576,7 +577,7 @@ public function count()
      *
      * @return \Spot\Entity\Collection
      */
-    public function getIterator()
+    public function getIterator(): \Traversable
     {
         // Execute query and return result set for iteration
         $result = $this->execute();
@@ -603,7 +604,7 @@ public function toArray($keyColumn = null, $valueColumn = null)
      *
      * @inheritdoc
      */
-    public function jsonSerialize()
+    public function jsonSerialize(): mixed
     {
         return $this->toArray();
     }
@@ -749,37 +750,37 @@ public function fieldWithAlias($field, $escaped = true)
      *
      * @inheritdoc
      */
-    public function offsetExists($key)
+    public function offsetExists(mixed $offset): bool
     {
         $results = $this->getIterator();
 
-        return isset($results[$key]);
+        return isset($results[$offset]);
     }
 
     /**
      * SPL - ArrayAccess
      *
      * @inheritdoc
      */
-    public function offsetGet($key)
+    public function offsetGet(mixed $offset): mixed
     {
         $results = $this->getIterator();
 
-        return $results[$key];
+        return $results[$offset];
     }
 
     /**
      * SPL - ArrayAccess
      *
      * @inheritdoc
      */
-    public function offsetSet($key, $value)
+    public function offsetSet(mixed $offset, mixed $value): void
     {
         $results = $this->getIterator();
-        if ($key === null) {
-            return $results[] = $value;
+        if ($offset === null) {
+            $results[] = $value;
         } else {
-            return $results[$key] = $value;
+            $results[$offset] = $value;
         }
     }
 
@@ -788,10 +789,10 @@ public function offsetSet($key, $value)
      *
      * @inheritdoc
      */
-    public function offsetUnset($key)
+    public function offsetUnset(mixed $offset): void
     {
         $results = $this->getIterator();
-        unset($results[$key]);
+        unset($results[$offset]);
     }
 
     /**

lib/Query/Operator/NotLike.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Spot\Query\Operator;
+
+use Doctrine\DBAL\Query\QueryBuilder;
+
+/**
+ * @package Spot\Query\Operator
+ */
+class NotLike
+{
+    /**
+     * @param QueryBuilder $builder
+     * @param $column
+     * @param $value
+     * @return string
+     */
+    public function __invoke(QueryBuilder $builder, $column, $value)
+    {
+        return $column . ' NOT LIKE ' . $builder->createPositionalParameter($value);
+    }
+}