Merge pull request #64 from Humpty-Dumpty/master

Minor changes to improve code navigation and documentation

Author: basemkhirat

src/Connection.php

@@ -2,7 +2,9 @@
 
 namespace Basemkhirat\Elasticsearch;
 
+use Elasticsearch\Client;
 use Elasticsearch\ClientBuilder;
+use Symfony\Component\HttpKernel\Exception\HttpException as HttpException;
 
 /**
  * Class Connection
@@ -13,7 +15,7 @@ class Connection
 
     /**
      * Laravel app instance
-     * @var \Illuminate\Foundation\Application|mixed
+     * @var \Illuminate\contracts\Foundation\Application|mixed
      */
     protected $app;
 
@@ -25,13 +27,13 @@ class Connection
 
     /**
      * The current connection
-     * @var
+     * @var Client
      */
     protected $connection;
 
     /**
      * all available connections
-     * @var array
+     * @var Client[]
      */
     protected $connections = [];
 
@@ -77,11 +79,11 @@ public static function create($config)
     /**
      * Create a connection for laravel or lumen frameworks
      * @param $name
+     * @throws HttpException
      * @return Query
      */
     function connection($name)
     {
-
         // Check if connection is already loaded.
 
         if ($this->isLoaded($name)) {
@@ -121,6 +123,16 @@ function connection($name)
     }
 
 
+    /**
+     * @param string $name
+     * @throws HttpException
+     * @return Query
+     */
+    function connectionByName($name = 'default') {
+        return $this->connection($this->config[$name]);
+    }
+
+
     /**
      * route the request to the query class
      * @param $connection
@@ -148,35 +160,22 @@ function newQuery($connection)
     function isLoaded($name)
     {
 
-        if (array_key_exists($name, $this->connections)) {
-            return true;
-        }
-
-        return false;
+        return array_key_exists($name, $this->connections);
     }
 
 
     /**
      * Set the default connection
      * @param $name
      * @param $arguments
+     * @throws HttpException
      * @return mixed
      */
     function __call($name, $arguments)
     {
-        if (method_exists($this, $name)) {
-
-            return call_user_func_array([$this, $name], $arguments);
-
-        } else {
 
-            // if no connection, use default.
+        $query = $this->connectionByName('default');
 
-            $query = $this->connection($this->config["default"]);
-
-            return call_user_func_array([$query, $name], $arguments);
-
-        }
+        return call_user_func_array([$query, $name], $arguments);
     }
-
 }

src/Model.php

@@ -3,7 +3,6 @@
 namespace Basemkhirat\Elasticsearch;
 
 use ArrayAccess;
-use Illuminate\Support\Collection;
 
 /**
  * Elasticsearch data model
@@ -100,6 +99,7 @@ public function getConnection()
 
     /**
      * Set current connection
+     * @param $connection
      * @return void
      */
     public function setConnection($connection)
@@ -119,7 +119,7 @@ public function getIndex()
 
     /**
      * Set index name
-     *
+     * @param $index
      * @return void
      */
     public function setIndex($index)
@@ -138,6 +138,7 @@ public function getType()
 
     /**
      * Set type name
+     * @param $type
      * @return void
      */
     public function setType($type)
@@ -271,11 +272,11 @@ public function __set($name, $value)
 
     /**
      * Create a new model query
-     * @return mixed
+     * @return Query
      */
     protected function newQuery()
     {
-        $query = app("es")->setModel($this);
+        $query = app("es")->connectionByName()->setModel($this);
 
         $query->connection($this->getConnection());
 
@@ -292,6 +293,7 @@ protected function newQuery()
 
     /**
      * Get all model records
+     * @throws \Exception
      * @return mixed
      */
     public static function all()
@@ -306,6 +308,7 @@ public static function all()
     /**
      * Get model by key
      * @param $key
+     * @throws \Exception
      * @return mixed
      */
     public static function find($key)

src/Query.php

@@ -4,7 +4,8 @@
 
 use Basemkhirat\Elasticsearch\Classes\Bulk;
 use Basemkhirat\Elasticsearch\Classes\Search;
-use Basemkhirat\Elasticsearch\Collection;
+use Elasticsearch\Client;
+use Elasticsearch\Common\Exceptions\BadMethodCallException;
 
 
 /**
@@ -16,13 +17,13 @@ class Query
 
     /**
      * Native elasticsearch connection instance
-     * @var Connection
+     * @var Client
      */
     public $connection;
 
     /**
      * Ignored HTTP errors
-     * @var array
+     * @var string[]
      */
     public $ignores = [];
 
@@ -157,14 +158,14 @@ class Query
 
     /**
      * Elastic model instance
-     * @var \Basemkhirat\Elasticsearch\Model
+     * @var Model
      */
     public $model;
 
 
     /**
      * Query constructor.
-     * @param $connection
+     * @param Client|NULL $connection
      */
     function __construct($connection = NULL)
     {
@@ -196,7 +197,7 @@ public function getIndex()
     /**
      * Set the type name
      * @param $type
-     * @return $this
+     * @return Query $this
      */
     public function type($type)
     {
@@ -256,7 +257,7 @@ public function searchType($type)
 
     /**
      * get the query search type
-     * @return $this
+     * @return int
      */
     public function getSearchType()
     {
@@ -265,7 +266,7 @@ public function getSearchType()
 
     /**
      * Get the query scroll
-     * @return $this
+     * @return string
      */
     public function getScroll()
     {
@@ -362,11 +363,7 @@ public function orderBy($field, $direction = "asc")
     protected function isOperator($string)
     {
 
-        if (in_array($string, $this->operators)) {
-            return true;
-        }
-
-        return false;
+        return in_array($string, $this->operators);
     }
 
     /**
@@ -656,6 +653,7 @@ public function distance($name, $value, $distance)
     /**
      * Search the entire document fields
      * @param null $q
+     * @param NULL $settings
      * @return $this
      */
     public function search($q = NULL, $settings = NULL)
@@ -788,7 +786,8 @@ public function clear($scroll_id = NULL)
 
     /**
      * Get the collection of results
-     * @return array|Collection
+     * @throws \Exception
+     * @return Collection
      */
     public function get()
     {
@@ -801,6 +800,7 @@ public function get()
     /**
      * Get the first object of results
      * @param string $scroll_id
+     * @throws \Exception
      * @return object
      */
     public function first($scroll_id = NULL)
@@ -816,6 +816,7 @@ public function first($scroll_id = NULL)
     /**
      * Get query result
      * @param $scroll_id
+     * @throws \Exception
      * @return mixed
      */
     protected function getResult($scroll_id)
@@ -839,7 +840,8 @@ protected function getResult($scroll_id)
     /**
      * Get non cached results
      * @param null $scroll_id
-     * @return mixed
+     * @throws \Exception
+     * @return array
      */
     public function response($scroll_id = NULL)
     {
@@ -902,7 +904,7 @@ function setModel($model)
     /**
      * Retrieve all records
      * @param array $result
-     * @return array|Collection
+     * @return Collection
      */
     protected function getAll($result = [])
     {
@@ -981,6 +983,7 @@ protected function getFirst($result = [])
      * @param int $per_page
      * @param      $page_name
      * @param null $page
+     * @throws \Exception
      * @return Pagination
      */
     public function paginate($per_page = 10, $page_name = "page", $page = null)
@@ -1001,7 +1004,7 @@ public function paginate($per_page = 10, $page_name = "page", $page = null)
      * Insert a document
      * @param      $data
      * @param null $_id
-     * @return object
+     * @return array
      */
     public function insert($data, $_id = NULL)
     {
@@ -1027,12 +1030,12 @@ public function insert($data, $_id = NULL)
             $parameters["id"] = $this->_id;
         }
 
-        return (object)$this->connection->index($parameters);
+        return $this->connection->index($parameters);
     }
 
     /**
      * Insert a bulk of documents
-     * @param $data multidimensional array of [id => data] pairs
+     * @param $data callable|array : multidimensional array of [id => data] pairs
      * @return object
      */
     public function bulk($data)
@@ -1309,7 +1312,6 @@ public function CachePrefix($prefix)
 
     /**
      * Get a unique cache key for the complete query.
-     *
      * @return string
      */
     public function getCacheKey()
@@ -1345,7 +1347,7 @@ public function remember($minutes, $key = null)
     /**
      * Indicate that the query results should be cached forever.
      * @param  string $key
-     * @return \Illuminate\Database\Query\Builder|static
+     * @return $this
      */
     public function rememberForever($key = null)
     {
@@ -1360,20 +1362,14 @@ public function rememberForever($key = null)
     function __call($method, $parameters)
     {
 
-        if (method_exists($this, $method)) {
-            return $this->$method(...$parameters);
-        } else {
-
-            // Check for model scopes
-
-            $method = "scope" . ucfirst($method);
+        $method = "scope" . ucfirst($method);
 
-            if (method_exists($this->model, $method)) {
-                $parameters = array_merge([$this], $parameters);
-                $this->model->$method(...$parameters);
-                return $this;
-            }
+        if (method_exists($this->model, $method)) {
+            $parameters = array_merge([$this], $parameters);
+            $this->model->$method(...$parameters);
+            return $this;
         }
 
+        throw new BadMethodCallException("Method $method does not exist.");
     }
 }