Merge pull request #199 from lucasmichot/feature/docblocks-src

Add/fix many docblocks in src

Author: lucasmichot

src/Builders/FilterBuilder.php

@@ -8,37 +8,50 @@
 class FilterBuilder extends Builder
 {
     /**
+     * The condition array.
+     *
      * @var array
      */
     public $wheres = [
         'must' => [],
-        'must_not' => []
+        'must_not' => [],
     ];
 
     /**
+     * The with array.
+     *
      * @var array|string
      */
     public $with;
 
     /**
+     * The offset
+     *
      * @var int
      */
     public $offset;
 
     /**
+     * The collapse parameter.
+     *
      * @var string
      */
     public $collapse;
 
     /**
+     * The select array.
+     *
      * @var array
      */
     public $select = [];
 
     /**
-     * @param Model $model
+     * FilterBuilder constructor.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model
      * @param callable|null $callback
      * @param bool $softDelete
+     * @return void
      */
     public function __construct(Model $model, $callback = null, $softDelete = false)
     {
@@ -55,6 +68,8 @@ public function __construct(Model $model, $callback = null, $softDelete = false)
     }
 
     /**
+     * Add a where condition.
+     *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html Term query
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html Range query
      *
@@ -136,6 +151,8 @@ public function where($field, $value)
     }
 
     /**
+     * Add a whereIn condition.
+     *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html Terms query
      *
      * @param string $field
@@ -154,6 +171,8 @@ public function whereIn($field, array $value)
     }
 
     /**
+     * Add a whereNotIn condition.
+     *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html Terms query
      *
      * @param string $field
@@ -172,6 +191,8 @@ public function whereNotIn($field, array $value)
     }
 
     /**
+     * Add a whereBetween condition.
+     *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html Range query
      *
      * @param string $field
@@ -193,6 +214,8 @@ public function whereBetween($field, array $value)
     }
 
     /**
+     * Add a whereNotBetween condition.
+     *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html Range query
      *
      * @param string $field
@@ -214,6 +237,8 @@ public function whereNotBetween($field, array $value)
     }
 
     /**
+     * Add a whereExists condition.
+     *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html Exists query
      *
      * @param string $field
@@ -231,6 +256,8 @@ public function whereExists($field)
     }
 
     /**
+     * Add a whereNotExists condition
+     *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html Exists query
      *
      * @param string $field
@@ -248,6 +275,8 @@ public function whereNotExists($field)
     }
 
     /**
+     * Add a whereRegexp condition.
+     *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html Regexp query
      *
      * @param string $field
@@ -270,6 +299,8 @@ public function whereRegexp($field, $value, $flags = 'ALL')
     }
 
     /**
+     * Add a whereGeoDistance condition.
+     *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-query.html Geo distance query
      *
      * @param string $field
@@ -290,6 +321,8 @@ public function whereGeoDistance($field, $value, $distance)
     }
 
     /**
+     * Add a whereGeoBoundingBox condition.
+     *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-bounding-box-query.html Geo bounding box query
      *
      * @param string $field
@@ -308,6 +341,8 @@ public function whereGeoBoundingBox($field, array $value)
     }
 
     /**
+     * Add a whereGeoPolygon condition.
+     *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-polygon-query.html Geo polygon query
      *
      * @param string $field
@@ -326,8 +361,10 @@ public function whereGeoPolygon($field, array $points)
 
         return $this;
     }
-    
+
     /**
+     * Add a whereGeoShape condition.
+     *
      * @see https://www.elastic.co/guide/en/elasticsearch/guide/current/querying-geo-shapes.html Querying Geo Shapes
      *
      * @param string $field
@@ -346,8 +383,10 @@ public function whereGeoShape($field, array $shape)
 
         return $this;
     }
-    
+
     /**
+     * Add a orderBy clause.
+     *
      * @param string $field
      * @param string $direction
      * @return $this
@@ -362,6 +401,8 @@ public function orderBy($field, $direction = 'asc')
     }
 
     /**
+     * Explain the request.
+     *
      * @return array
      */
     public function explain()
@@ -372,6 +413,8 @@ public function explain()
     }
 
     /**
+     * Profile the request.
+     *
      * @return array
      */
     public function profile()
@@ -382,6 +425,8 @@ public function profile()
     }
 
     /**
+     * Build the payload.
+     *
      * @return array
      */
     public function buildPayload()
@@ -392,6 +437,8 @@ public function buildPayload()
     }
 
     /**
+     * Eager load some some relations.
+     *
      * @param array|string $relations
      * @return $this
      */
@@ -403,6 +450,8 @@ public function with($relations)
     }
 
     /**
+     * Set the query offset.
+     *
      * @param int $offset
      * @return $this
      */
@@ -444,6 +493,8 @@ public function paginate($perPage = null, $pageName = 'page', $page = null)
     }
 
     /**
+     * Collapse by a field.
+     *
      * @param string $field
      * @return $this
      */
@@ -455,6 +506,8 @@ public function collapse(string $field)
     }
 
     /**
+     * Select one or many fields.
+     *
      * @param mixed $fields
      * @return $this
      */
@@ -469,6 +522,8 @@ public function select($fields)
     }
 
     /**
+     * Get the count.
+     *
      * @return int
      */
     public function count()

src/Builders/SearchBuilder.php

@@ -7,15 +7,21 @@
 class SearchBuilder extends FilterBuilder
 {
     /**
+     * The rules array.
+     *
      * @var array
      */
     public $rules = [];
 
+
     /**
-     * @param Model $model
+     * SearchBuilder constructor.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model
      * @param string $query
      * @param callable|null $callback
      * @param bool $softDelete
+     * @return void
      */
     public function __construct(Model $model, $query, $callback = null, $softDelete = false)
     {
@@ -25,6 +31,8 @@ public function __construct(Model $model, $query, $callback = null, $softDelete
     }
 
     /**
+     * Add a rule.
+     *
      * @param string|callable $rule Search rule class name or function
      * @return $this
      */

src/Console/ElasticIndexCreateCommand.php

@@ -13,15 +13,20 @@ class ElasticIndexCreateCommand extends Command
     use RequiresIndexConfiguratorArgument;
 
     /**
-     * @var string
+     * {@inheritdoc}
      */
     protected $name = 'elastic:create-index';
 
     /**
-     * @var string
+     * {@inheritdoc}
      */
     protected $description = 'Create an Elasticsearch index';
 
+    /**
+     * Create an index.
+     *
+     * @return void
+     */
     protected function createIndex()
     {
         $configurator = $this->getIndexConfigurator();
@@ -40,6 +45,11 @@ protected function createIndex()
         ));
     }
 
+    /**
+     * Create an write alias.
+     *
+     * @return void
+     */
     protected function createWriteAlias()
     {
         $configurator = $this->getIndexConfigurator();
@@ -62,10 +72,15 @@ protected function createWriteAlias()
         ));
     }
 
+    /**
+     * Handle the command.
+     *
+     * @return void
+     */
     public function handle()
     {
         $this->createIndex();
 
         $this->createWriteAlias();
     }
-}
+}

src/Console/ElasticIndexDropCommand.php

@@ -12,15 +12,21 @@ class ElasticIndexDropCommand extends Command
     use RequiresIndexConfiguratorArgument;
 
     /**
-     * @var string
+     * {@inheritdoc}
      */
     protected $name = 'elastic:drop-index';
 
+
     /**
-     * @var string
+     * {@inheritdoc}
      */
     protected $description = 'Drop an Elasticsearch index';
 
+    /**
+     * Handle the command.
+     *
+     * @return void
+     */
     public function handle()
     {
         $configurator = $this->getIndexConfigurator();
@@ -36,4 +42,4 @@ public function handle()
             $configurator->getName()
         ));
     }
-}
+}