added search functions, implemented search for elasticsearch

Author: matthi4s

.gitignore

@@ -1,2 +1,3 @@
 vendor/
-.idea
+.idea
+test.php

src/Driver/Elasticsearch/Elasticsearch.php

@@ -4,9 +4,13 @@
 
 use Aternos\Model\Driver\Driver;
 use Aternos\Model\Driver\Features\CRUDAbleInterface;
+use Aternos\Model\Driver\Features\SearchableInterface;
 use Aternos\Model\ModelInterface;
+use Aternos\Model\Search\Search;
+use Aternos\Model\Search\SearchResult;
 use Elasticsearch\Client;
 use Elasticsearch\ClientBuilder;
+use Elasticsearch\Common\Exceptions\Missing404Exception;
 
 /**
  * Class Elasticsearch
@@ -17,7 +21,7 @@
  *
  * @package Aternos\Model\Driver\Search
  */
-class Elasticsearch extends Driver implements CRUDAbleInterface
+class Elasticsearch extends Driver implements CRUDAbleInterface, SearchableInterface
 {
     public const ID = "elasticsearch";
     protected string $id = self::ID;
@@ -47,7 +51,6 @@ public function save(ModelInterface $model): bool
     {
         $params = [
             "index" => $model::getName(),
-            "type" => "_doc",
             "id" => $model->getId(),
             "body" => get_object_vars($model)
         ];
@@ -58,14 +61,32 @@ public function save(ModelInterface $model): bool
     }
 
     /**
-     * Could be implemented, but should not be used
+     * Get the model
      *
      * @param ModelInterface $model
      * @return bool
      */
     public function get(ModelInterface $model): bool
     {
-        return false;
+        $params = [
+            'index' => $model::getName(),
+            'id' => $model->getId()
+        ];
+
+        $this->connect();
+        try {
+            $response = $this->client->getSource($params);
+        } catch (Missing404Exception $e) {
+            return false;
+        }
+        if (!is_array($response)) {
+            return false;
+        }
+
+        foreach ($response as $key => $value) {
+            $model->{$key} = $value;
+        }
+        return true;
     }
 
     /**
@@ -78,11 +99,44 @@ public function delete(ModelInterface $model): bool
     {
         $params = [
             "index" => $model::getName(),
-            "type" => "_doc",
             "id" => $model->getId()
         ];
 
         $this->client->delete($params);
         return true;
     }
+
+    /**
+     * @param Search $search
+     * @return SearchResult
+     */
+    public function search(Search $search): SearchResult
+    {
+        $modelClassName = $search->getModelClassName();
+        $params = [
+            'index' => $modelClassName::getName(),
+            'body' => $search->getSearchQuery()
+        ];
+
+        $this->connect();
+        $response = $this->client->search($params);
+        if (!is_array($response) || !isset($response["hits"]) || !is_array($response["hits"]) || !isset($response["hits"]["hits"]) || !is_array($response["hits"]["hits"])) {
+            return new SearchResult(false);
+        }
+
+        $result = new SearchResult(true);
+        foreach ($response["hits"]["hits"] as $resultDocument) {
+            if (!isset($resultDocument["_source"]) || !is_array($resultDocument["_source"])) {
+                continue;
+            }
+
+            /** @var ModelInterface $model */
+            $model = new $modelClassName();
+            foreach ($resultDocument["_source"] as $key => $value) {
+                $model->{$key} = $value;
+            }
+            $result->add($model);
+        }
+        return $result;
+    }
 }

src/Driver/Features/SearchableInterface.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Aternos\Model\Driver\Features;
+
+use Aternos\Model\Search\Search;
+use Aternos\Model\Search\SearchResult;
+
+/**
+ * Class SearchableInterface
+ * @package Aternos\Model\Driver\Features
+ */
+interface SearchableInterface
+{
+    /**
+     * Execute a search query
+     *
+     * @param Search $search
+     * @return SearchResult
+     */
+    public function search(Search $search): SearchResult;
+}

src/GenericModel.php

@@ -10,10 +10,13 @@
 use Aternos\Model\Driver\Features\GettableInterface;
 use Aternos\Model\Driver\Features\QueryableInterface;
 use Aternos\Model\Driver\Features\SavableInterface;
+use Aternos\Model\Driver\Features\SearchableInterface;
 use Aternos\Model\Driver\Features\SelectQueryableInterface;
 use Aternos\Model\Driver\Features\UpdateQueryableInterface;
 use Aternos\Model\Driver\Mysqli\Mysqli;
 use Aternos\Model\Driver\Redis\Redis;
+use Aternos\Model\Search\Search;
+use Aternos\Model\Search\SearchResult;
 use BadMethodCallException;
 use Aternos\Model\Query\{DeleteQuery,
     Limit,
@@ -188,6 +191,22 @@ protected static function getDeleteQueryableDrivers(): array
         return $drivers;
     }
 
+    /**
+     * Get all searchable drivers from static::$drivers
+     *
+     * @return array
+     */
+    protected static function getSearchableDrivers(): array
+    {
+        $drivers = [];
+        foreach (static::$drivers as $driver) {
+            if (static::getDriverRegistry()->isDriverInstanceOf($driver, SearchableInterface::class)) {
+                $drivers[] = $driver;
+            }
+        }
+        return $drivers;
+    }
+
     /**
      * Get a model by id
      *
@@ -421,4 +440,44 @@ public function getCacheTime(): int
     {
         return static::$cache ?: 0;
     }
+
+    /**
+     * Search the model
+     *
+     * @param Search $search
+     * @return SearchResult|static[]
+     */
+    public static function search(Search $search): SearchResult
+    {
+        $search->setModelClassName(static::class);
+
+        $result = false;
+        foreach (static::getSearchableDrivers() as $searchableDriver) {
+            /** @var SearchableInterface $driver */
+            $driver = static::getDriverRegistry()->getDriver($searchableDriver);
+            $result = $driver->search($search);
+
+            if ($result->wasSuccessful()) {
+                break;
+            }
+        }
+
+        if ($result === false) {
+            throw new BadMethodCallException("You can't search the model if no searchable driver is available.");
+        }
+
+        if (static::$registry) {
+            if ($result->wasSuccessful() && count($result) > 0) {
+                foreach ($result as $model) {
+                    if ($model->getId() === null) {
+                        continue;
+                    }
+                    ModelRegistry::getInstance()->save($model);
+                }
+            }
+        }
+
+        return $result;
+    }
+
 }

src/ModelCollectionResult.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Aternos\Model;
+
+/**
+ * Class ModelCollectionResult
+ * @package Aternos\Model
+ */
+class ModelCollectionResult extends ModelCollection
+{
+    /**
+     * Success state of the result
+     *
+     * @var bool
+     */
+    protected bool $success;
+
+    /**
+     * ModelCollectionResult constructor.
+     *
+     * @param bool $success
+     * @param array $result Containing models (ModelInterface)
+     */
+    public function __construct(bool $success, $result = [])
+    {
+        $this->success = $success;
+        if (is_array($result)) {
+            $this->models = $result;
+        }
+    }
+
+    /**
+     * Check if the query was successful
+     *
+     * @return bool
+     */
+    public function wasSuccessful(): bool
+    {
+        return (bool)$this->success;
+    }
+}

src/Query/QueryResult.php

@@ -2,23 +2,16 @@
 
 namespace Aternos\Model\Query;
 
-use Aternos\Model\ModelCollection;
+use Aternos\Model\ModelCollectionResult;
 
 /**
  * Class QueryResult
  *
  * @author Matthias Neid
  * @package Aternos\Model\Query
  */
-class QueryResult extends ModelCollection
+class QueryResult extends ModelCollectionResult
 {
-    /**
-     * Success state of the query
-     *
-     * @var bool
-     */
-    protected bool $success;
-
     /**
      * Raw query string that was executed
      *
@@ -37,21 +30,8 @@ class QueryResult extends ModelCollection
      */
     public function __construct(bool $success, $result = [], ?string $queryString = null)
     {
-        $this->success = $success;
+        parent::__construct($success, $result);
         $this->queryString = $queryString;
-        if (is_array($result)) {
-            $this->models = $result;
-        }
-    }
-
-    /**
-     * Check if the query was successful
-     *
-     * @return bool
-     */
-    public function wasSuccessful(): bool
-    {
-        return (bool)$this->success;
     }
 
     /**

src/Search/Search.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Aternos\Model\Search;
+
+/**
+ * Class Search
+ * @package Aternos\Model\Search
+ */
+class Search
+{
+    /**
+     * @var string|null
+     */
+    protected ?string $modelClassName = null;
+
+    /**
+     * @var array
+     */
+    protected array $searchQuery = [];
+
+    /**
+     * Search constructor.
+     * @param array $searchQuery
+     */
+    public function __construct(array $searchQuery = [])
+    {
+        $this->searchQuery = $searchQuery;
+    }
+
+    /**
+     * @return array
+     */
+    public function getSearchQuery(): array
+    {
+        return $this->searchQuery;
+    }
+
+    /**
+     * @param string|null $modelClassName
+     * @return Search
+     */
+    public function setModelClassName(?string $modelClassName): Search
+    {
+        $this->modelClassName = $modelClassName;
+        return $this;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getModelClassName(): ?string
+    {
+        return $this->modelClassName;
+    }
+}

src/Search/SearchResult.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Aternos\Model\Search;
+
+use Aternos\Model\ModelCollectionResult;
+
+/**
+ * Class SearchResult
+ * @package Aternos\Model\Search
+ */
+class SearchResult extends ModelCollectionResult
+{
+
+}