register drivers with interface class name, updated readme

Author: matthi4s

README.md

@@ -63,7 +63,10 @@ After that you have to register the class in the [DriverFactory](src/Driver/Driv
 ```php
 <?php
 
-\Aternos\Model\Driver\DriverFactory::getInstance()->registerDriver('Relational', '\\MyModel\\Mysqli');
+\Aternos\Model\Driver\DriverFactory::getInstance()->registerDriver(
+    \Aternos\Model\Driver\Relational\RelationalDriverInterface::class, 
+    \MyModel\Mysqli::class
+);
 ```
 
 ### Model
@@ -140,6 +143,76 @@ $user->save();
 $user->delete();
 ```
 
+### Query
+You can query the model using a [Query](src/Query/Query.php) object, e.g. [SelectQuery](src/Query/SelectQuery.php).
+It allows different syntax possibilities such as simple array/string/int values directly passed to the constructor or
+building all parameters as objects based on the [Query/...](src/Query) classes. All queries return a [QueryResult](src/Query/QueryResult.php)
+object, which is iterable and countable.
+
+```php
+<?php
+
+// the following lines are all the same
+User::select(["email" => "[email protected]"]); // ::select() is only a helper function of GenericModel
+User::query(new \Aternos\Model\Query\SelectQuery(["email" => "[email protected]"]));
+User::query((new \Aternos\Model\Query\SelectQuery())->where(["email" => "[email protected]"]));
+User::query(new \Aternos\Model\Query\SelectQuery(
+    new \Aternos\Model\Query\WhereCondition("email", "[email protected]")
+));
+User::query(new \Aternos\Model\Query\SelectQuery(
+    new \Aternos\Model\Query\WhereGroup([
+        new \Aternos\Model\Query\WhereCondition("email", "[email protected]")
+    ])
+));
+
+// use the result
+$userQueryResult = User::select(["email" => "[email protected]"]);
+
+if (!$userQueryResult->wasSuccessful()) {
+    echo "Query failed";
+}
+
+echo "Found " . count($userQueryResult) . " users";
+
+foreach($userQueryResult as $user) {
+    /** @var User $user */
+    echo $user->username;
+}
+
+// another query example
+User::select(
+    ["field" => "value", "hello" => "world", "foo" => "bar"],
+    ["field" => "ASC", "hello" => "DESC", "foo" => "ASC"],
+    ["field", "hello", "foo"],
+    [100, 10]
+);
+// can also be written as
+User::query((new \Aternos\Model\Query\SelectQuery)
+    ->where(["field" => "value", "hello" => "world", "foo" => "bar"])
+    ->orderBy(["field" => "ASC", "hello" => "DESC", "foo" => "ASC"])
+    ->fields(["field", "hello", "foo"])
+    ->limit([100, 10])
+); 
+
+// a more complex query with nested where groups using the query parameter classes
+User::query(new \Aternos\Model\Query\SelectQuery(
+    new \Aternos\Model\Query\WhereGroup([
+        new \Aternos\Model\Query\WhereCondition("field", "value", "<>"),
+        new \Aternos\Model\Query\WhereGroup([
+            new \Aternos\Model\Query\WhereCondition("hello", "world"),
+            new \Aternos\Model\Query\WhereCondition("foo", "bar")
+        ], \Aternos\Model\Query\WhereGroup:: OR)
+    ]),
+    [
+        new \Aternos\Model\Query\OrderField("field", \Aternos\Model\Query\OrderField::DESCENDING),
+        new \Aternos\Model\Query\OrderField("hello", \Aternos\Model\Query\OrderField::ASCENDING),
+        new \Aternos\Model\Query\OrderField("foo", \Aternos\Model\Query\OrderField::DESCENDING)
+    ],
+    ["field", "hello", "foo"],
+    new \Aternos\Model\Query\Limit(10, 100)
+));
+```
+
 ## Advanced usage
 *More information about more advanced usage, such as writing your own drivers, driver factory or models
 will be added in the future, in the meantime just take a look at the source code.*

src/Driver/DriverFactory.php

@@ -3,8 +3,12 @@
 namespace Aternos\Model\Driver;
 
 use Aternos\Model\Driver\Cache\CacheDriverInterface;
+use Aternos\Model\Driver\Cache\Redis;
+use Aternos\Model\Driver\NoSQL\Cassandra;
 use Aternos\Model\Driver\NoSQL\NoSQLDriverInterface;
+use Aternos\Model\Driver\Relational\Mysqli;
 use Aternos\Model\Driver\Relational\RelationalDriverInterface;
+use Aternos\Model\Driver\Search\Elasticsearch;
 use Aternos\Model\Driver\Search\SearchDriverInterface;
 
 /**
@@ -20,10 +24,10 @@ class DriverFactory implements DriverFactoryInterface
      * @var array
      */
     protected $drivers = [
-        "Cache" => "\\Aternos\\Model\\Driver\\Cache\\Redis",
-        "NoSQL" => "\\Aternos\\Model\\Driver\\NoSQL\\Cassandra",
-        "Relational" => "\\Aternos\\Model\\Driver\\Relational\\Mysqli",
-        "Search" => "\\Aternos\\Model\\Driver\\Search\\Elasticsearch"
+        CacheDriverInterface::class => Redis::class,
+        NoSQLDriverInterface::class => Cassandra::class,
+        RelationalDriverInterface::class => Mysqli::class,
+        SearchDriverInterface::class => Elasticsearch::class
     ];
 
     /**
@@ -70,7 +74,7 @@ public function assembleCacheDriver(): CacheDriverInterface
         /**
          * @var CacheDriverInterface $cacheDriver
          */
-        $cacheDriver = $this->assembleDriver("Cache");
+        $cacheDriver = $this->assembleDriver(CacheDriverInterface::class);
 
         return $cacheDriver;
     }
@@ -85,7 +89,7 @@ public function assembleNoSQLDriver(): NoSQLDriverInterface
         /**
          * @var NoSQLDriverInterface $nosqlDriver
          */
-        $nosqlDriver = $this->assembleDriver("NoSQL");
+        $nosqlDriver = $this->assembleDriver(NoSQLDriverInterface::class);
 
         return $nosqlDriver;
     }
@@ -100,7 +104,7 @@ public function assembleRelationalDriver(): RelationalDriverInterface
         /**
          * @var RelationalDriverInterface $relationalDriver
          */
-        $relationalDriver = $this->assembleDriver("Relational");
+        $relationalDriver = $this->assembleDriver(RelationalDriverInterface::class);
 
         return $relationalDriver;
     }
@@ -115,7 +119,7 @@ public function assembleSearchDriver(): SearchDriverInterface
         /**
          * @var SearchDriverInterface $searchDriver
          */
-        $searchDriver = $this->assembleDriver("Search");
+        $searchDriver = $this->assembleDriver(SearchDriverInterface::class);
 
         return $searchDriver;
     }