diff --git a/src/Builders/FilterBuilder.php b/src/Builders/FilterBuilder.php index 0a6c033..5b006f1 100644 --- a/src/Builders/FilterBuilder.php +++ b/src/Builders/FilterBuilder.php @@ -49,9 +49,9 @@ class FilterBuilder extends Builder /** * FilterBuilder constructor. * - * @param \Illuminate\Database\Eloquent\Model $model - * @param callable|null $callback - * @param bool $softDelete + * @param \Illuminate\Database\Eloquent\Model $model + * @param callable|null $callback + * @param bool $softDelete * @return void */ public function __construct(Model $model, $callback = null, $softDelete = false) @@ -75,8 +75,8 @@ public function __construct(Model $model, $callback = null, $softDelete = false) * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html Range query * * Supported operators are =, >, <, >=, <=, <> - * @param string $field Field name - * @param mixed $value Scalar value or an array + * @param string $field Field name + * @param mixed $value Scalar value or an array * @return $this */ public function where($field, $value) @@ -156,8 +156,8 @@ public function where($field, $value) * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html Terms query * - * @param string $field - * @param array $value + * @param string $field + * @param array $value * @return $this */ public function whereIn($field, array $value) @@ -176,8 +176,8 @@ public function whereIn($field, array $value) * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html Terms query * - * @param string $field - * @param array $value + * @param string $field + * @param array $value * @return $this */ public function whereNotIn($field, array $value) @@ -196,8 +196,8 @@ public function whereNotIn($field, array $value) * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html Range query * - * @param string $field - * @param array $value + * @param string $field + * @param array $value * @return $this */ public function whereBetween($field, array $value) @@ -219,8 +219,8 @@ public function whereBetween($field, array $value) * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html Range query * - * @param string $field - * @param array $value + * @param string $field + * @param array $value * @return $this */ public function whereNotBetween($field, array $value) @@ -242,7 +242,7 @@ public function whereNotBetween($field, array $value) * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html Exists query * - * @param string $field + * @param string $field * @return $this */ public function whereExists($field) @@ -261,7 +261,7 @@ public function whereExists($field) * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html Exists query * - * @param string $field + * @param string $field * @return $this */ public function whereNotExists($field) @@ -280,9 +280,9 @@ public function whereNotExists($field) * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html Regexp query * - * @param string $field - * @param string $value - * @param string $flags + * @param string $field + * @param string $value + * @param string $flags * @return $this */ public function whereRegexp($field, $value, $flags = 'ALL') @@ -304,9 +304,9 @@ public function whereRegexp($field, $value, $flags = 'ALL') * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-query.html Geo distance query * - * @param string $field - * @param string|array $value - * @param int|string $distance + * @param string $field + * @param string|array $value + * @param int|string $distance * @return $this */ public function whereGeoDistance($field, $value, $distance) @@ -326,8 +326,8 @@ public function whereGeoDistance($field, $value, $distance) * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-bounding-box-query.html Geo bounding box query * - * @param string $field - * @param array $value + * @param string $field + * @param array $value * @return $this */ public function whereGeoBoundingBox($field, array $value) @@ -346,8 +346,8 @@ public function whereGeoBoundingBox($field, array $value) * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-polygon-query.html Geo polygon query * - * @param string $field - * @param array $points + * @param string $field + * @param array $points * @return $this */ public function whereGeoPolygon($field, array $points) @@ -368,9 +368,9 @@ public function whereGeoPolygon($field, array $points) * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-shape-query.html Querying Geo Shapes * - * @param string $field - * @param array $shape - * @param string $relation + * @param string $field + * @param array $shape + * @param string $relation * @return $this */ public function whereGeoShape($field, array $shape, $relation = 'INTERSECTS') @@ -390,8 +390,8 @@ public function whereGeoShape($field, array $shape, $relation = 'INTERSECTS') /** * Add a orderBy clause. * - * @param string $field - * @param string $direction + * @param string $field + * @param string $direction * @return $this */ public function orderBy($field, $direction = 'asc') @@ -442,7 +442,7 @@ public function buildPayload() /** * Eager load some some relations. * - * @param array|string $relations + * @param array|string $relations * @return $this */ public function with($relations) @@ -455,7 +455,7 @@ public function with($relations) /** * Set the query offset. * - * @param int $offset + * @param int $offset * @return $this */ public function from($offset) @@ -498,7 +498,7 @@ public function paginate($perPage = null, $pageName = 'page', $page = null) /** * Collapse by a field. * - * @param string $field + * @param string $field * @return $this */ public function collapse(string $field) @@ -511,7 +511,7 @@ public function collapse(string $field) /** * Select one or many fields. * - * @param mixed $fields + * @param mixed $fields * @return $this */ public function select($fields) diff --git a/src/Builders/SearchBuilder.php b/src/Builders/SearchBuilder.php index b6e6053..e56c681 100644 --- a/src/Builders/SearchBuilder.php +++ b/src/Builders/SearchBuilder.php @@ -16,10 +16,10 @@ class SearchBuilder extends FilterBuilder /** * SearchBuilder constructor. * - * @param \Illuminate\Database\Eloquent\Model $model - * @param string $query - * @param callable|null $callback - * @param bool $softDelete + * @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) @@ -32,7 +32,7 @@ public function __construct(Model $model, $query, $callback = null, $softDelete /** * Add a rule. * - * @param string|callable $rule Search rule class name or function + * @param string|callable $rule Search rule class name or function * @return $this */ public function rule($rule) diff --git a/src/Console/ElasticIndexDropCommand.php b/src/Console/ElasticIndexDropCommand.php index a1e2369..a0f1289 100644 --- a/src/Console/ElasticIndexDropCommand.php +++ b/src/Console/ElasticIndexDropCommand.php @@ -5,7 +5,6 @@ use Illuminate\Console\Command; use ScoutElastic\Console\Features\RequiresIndexConfiguratorArgument; use ScoutElastic\Facades\ElasticClient; -use ScoutElastic\IndexConfigurator; use ScoutElastic\Migratable; use ScoutElastic\Payloads\RawPayload; @@ -47,7 +46,7 @@ public function handle() } /** - * @param IndexConfigurator $configurator + * @param \ScoutElastic\IndexConfigurator $configurator * @return string */ protected function resolveIndexName($configurator) diff --git a/src/Console/ElasticMigrateCommand.php b/src/Console/ElasticMigrateCommand.php index d6bedef..252b387 100644 --- a/src/Console/ElasticMigrateCommand.php +++ b/src/Console/ElasticMigrateCommand.php @@ -174,7 +174,7 @@ protected function updateTargetIndexMapping() /** * Check if an alias exists. * - * @param string $name + * @param string $name * @return bool */ protected function isAliasExists($name) @@ -190,7 +190,7 @@ protected function isAliasExists($name) /** * Get an alias. * - * @param string $name + * @param string $name * @return array */ protected function getAlias($name) @@ -206,7 +206,7 @@ protected function getAlias($name) /** * Delete an alias. * - * @param string $name + * @param string $name * @return void */ protected function deleteAlias($name) @@ -237,7 +237,7 @@ protected function deleteAlias($name) /** * Create an alias for the target index. * - * @param string $name + * @param string $name * @return void */ protected function createAliasForTargetIndex($name) diff --git a/src/Console/SearchableModelMakeCommand.php b/src/Console/SearchableModelMakeCommand.php index 4e0bebc..39016a8 100644 --- a/src/Console/SearchableModelMakeCommand.php +++ b/src/Console/SearchableModelMakeCommand.php @@ -72,7 +72,7 @@ protected function getSearchRule() /** * Build the class. * - * @param string $name + * @param string $name * @return string */ protected function buildClass($name) diff --git a/src/ElasticEngine.php b/src/ElasticEngine.php index 5678e13..626638e 100644 --- a/src/ElasticEngine.php +++ b/src/ElasticEngine.php @@ -40,8 +40,8 @@ class ElasticEngine extends Engine /** * ElasticEngine constructor. * - * @param \ScoutElastic\Indexers\IndexerInterface $indexer - * @param bool $updateMapping + * @param \ScoutElastic\Indexers\IndexerInterface $indexer + * @param bool $updateMapping * @return void */ public function __construct(IndexerInterface $indexer, $updateMapping) @@ -91,8 +91,8 @@ public function delete($models) /** * Build the payload collection. * - * @param \Laravel\Scout\Builder $builder - * @param array $options + * @param \Laravel\Scout\Builder $builder + * @param array $options * @return \Illuminate\Support\Collection */ public function buildSearchQueryPayloadCollection(Builder $builder, array $options = []) @@ -159,8 +159,8 @@ public function buildSearchQueryPayloadCollection(Builder $builder, array $optio /** * Perform the search. * - * @param \Laravel\Scout\Builder $builder - * @param array $options + * @param \Laravel\Scout\Builder $builder + * @param array $options * @return array|mixed */ protected function performSearch(Builder $builder, array $options = []) @@ -214,7 +214,7 @@ public function paginate(Builder $builder, $perPage, $page) /** * Explain the search. * - * @param \Laravel\Scout\Builder $builder + * @param \Laravel\Scout\Builder $builder * @return array|mixed */ public function explain(Builder $builder) @@ -227,7 +227,7 @@ public function explain(Builder $builder) /** * Profile the search. * - * @param \Laravel\Scout\Builder $builder + * @param \Laravel\Scout\Builder $builder * @return array|mixed */ public function profile(Builder $builder) @@ -240,7 +240,7 @@ public function profile(Builder $builder) /** * Return the number of documents found. * - * @param \Laravel\Scout\Builder $builder + * @param \Laravel\Scout\Builder $builder * @return int */ public function count(Builder $builder) @@ -265,8 +265,8 @@ public function count(Builder $builder) /** * Make a raw search. * - * @param \Illuminate\Database\Eloquent\Model $model - * @param array $query + * @param \Illuminate\Database\Eloquent\Model $model + * @param array $query * @return mixed */ public function searchRaw(Model $model, $query) diff --git a/src/Highlight.php b/src/Highlight.php index ce6dd8f..22b5bc8 100644 --- a/src/Highlight.php +++ b/src/Highlight.php @@ -14,7 +14,7 @@ class Highlight /** * Highlight constructor. * - * @param array $highlight + * @param array $highlight * @return void */ public function __construct(array $highlight) @@ -25,7 +25,7 @@ public function __construct(array $highlight) /** * Get a value. * - * @param string $key + * @param string $key * @return mixed|string|null */ public function __get($key) diff --git a/src/Indexers/IndexerInterface.php b/src/Indexers/IndexerInterface.php index e8c47cf..9735798 100644 --- a/src/Indexers/IndexerInterface.php +++ b/src/Indexers/IndexerInterface.php @@ -9,7 +9,7 @@ interface IndexerInterface /** * Update documents. * - * @param \Illuminate\Database\Eloquent\Collection $models + * @param \Illuminate\Database\Eloquent\Collection $models * @return array */ public function update(Collection $models); @@ -17,7 +17,7 @@ public function update(Collection $models); /** * Delete documents. * - * @param \Illuminate\Database\Eloquent\Collection $models + * @param \Illuminate\Database\Eloquent\Collection $models * @return array */ public function delete(Collection $models); diff --git a/src/Payloads/DocumentPayload.php b/src/Payloads/DocumentPayload.php index e28c65f..91a418a 100644 --- a/src/Payloads/DocumentPayload.php +++ b/src/Payloads/DocumentPayload.php @@ -10,7 +10,7 @@ class DocumentPayload extends TypePayload /** * DocumentPayload constructor. * - * @param \Illuminate\Database\Eloquent\Model $model + * @param \Illuminate\Database\Eloquent\Model $model * @throws \Exception * @return void */ diff --git a/src/Payloads/IndexPayload.php b/src/Payloads/IndexPayload.php index c61b361..a7a5130 100644 --- a/src/Payloads/IndexPayload.php +++ b/src/Payloads/IndexPayload.php @@ -29,7 +29,7 @@ class IndexPayload extends RawPayload /** * IndexPayload constructor. * - * @param \ScoutElastic\IndexConfigurator $indexConfigurator + * @param \ScoutElastic\IndexConfigurator $indexConfigurator * @return void */ public function __construct(IndexConfigurator $indexConfigurator) @@ -42,7 +42,7 @@ public function __construct(IndexConfigurator $indexConfigurator) /** * Use an alias. * - * @param string $alias + * @param string $alias * @return $this * @throws \Exception */ diff --git a/src/Payloads/RawPayload.php b/src/Payloads/RawPayload.php index 9111754..39b33d2 100644 --- a/src/Payloads/RawPayload.php +++ b/src/Payloads/RawPayload.php @@ -16,8 +16,8 @@ class RawPayload /** * Set a value. * - * @param string $key - * @param mixed $value + * @param string $key + * @param mixed $value * @return $this */ public function set($key, $value) @@ -32,8 +32,8 @@ public function set($key, $value) /** * Set a value if it's not empty. * - * @param string $key - * @param mixed $value + * @param string $key + * @param mixed $value * @return $this */ public function setIfNotEmpty($key, $value) @@ -48,8 +48,8 @@ public function setIfNotEmpty($key, $value) /** * Set a value if it's not null. * - * @param string $key - * @param mixed $value + * @param string $key + * @param mixed $value * @return $this */ public function setIfNotNull($key, $value) @@ -64,7 +64,7 @@ public function setIfNotNull($key, $value) /** * Checks that the payload key has a value. * - * @param string $key + * @param string $key * @return bool */ public function has($key) @@ -75,8 +75,8 @@ public function has($key) /** * Add a value. * - * @param string $key - * @param mixed $value + * @param string $key + * @param mixed $value * @return $this */ public function add($key, $value) @@ -99,8 +99,8 @@ public function add($key, $value) /** * Add a value if it's not empty. * - * @param string $key - * @param mixed $value + * @param string $key + * @param mixed $value * @return $this */ public function addIfNotEmpty($key, $value) @@ -115,8 +115,8 @@ public function addIfNotEmpty($key, $value) /** * Get value. * - * @param string|null $key - * @param mixed|null $default + * @param string|null $key + * @param mixed|null $default * @return mixed */ public function get($key = null, $default = null) diff --git a/src/Payloads/TypePayload.php b/src/Payloads/TypePayload.php index 0ed1f6b..f9bc501 100644 --- a/src/Payloads/TypePayload.php +++ b/src/Payloads/TypePayload.php @@ -18,7 +18,7 @@ class TypePayload extends IndexPayload /** * TypePayload constructor. * - * @param \Illuminate\Database\Eloquent\Model $model + * @param \Illuminate\Database\Eloquent\Model $model * @throws \Exception * @return void */ diff --git a/src/SearchRule.php b/src/SearchRule.php index 4ecae26..3a6c1b9 100644 --- a/src/SearchRule.php +++ b/src/SearchRule.php @@ -16,7 +16,7 @@ class SearchRule /** * SearchRule constructor. * - * @param \ScoutElastic\Builders\SearchBuilder $builder + * @param \ScoutElastic\Builders\SearchBuilder $builder * @return void */ public function __construct(SearchBuilder $builder) diff --git a/src/Searchable.php b/src/Searchable.php index 2d3fcca..47020dd 100644 --- a/src/Searchable.php +++ b/src/Searchable.php @@ -76,8 +76,8 @@ public function getSearchRules() /** * Execute the search. * - * @param string $query - * @param callable|null $callback + * @param string $query + * @param callable|null $callback * @return \ScoutElastic\Builders\FilterBuilder|\ScoutElastic\Builders\SearchBuilder */ public static function search($query, $callback = null) @@ -94,7 +94,7 @@ public static function search($query, $callback = null) /** * Execute a raw search. * - * @param array $query + * @param array $query * @return array */ public static function searchRaw(array $query) @@ -108,7 +108,7 @@ public static function searchRaw(array $query) /** * Set the highlight attribute. * - * @param \ScoutElastic\Highlight $value + * @param \ScoutElastic\Highlight $value * @return void */ public function setHighlightAttribute(Highlight $value) diff --git a/tests/Config.php b/tests/Config.php index 623199f..67c7aa0 100644 --- a/tests/Config.php +++ b/tests/Config.php @@ -12,8 +12,8 @@ class Config private static $values = []; /** - * @param string $key - * @param mixed $value + * @param string $key + * @param mixed $value */ public static function set($key, $value) { @@ -21,8 +21,8 @@ public static function set($key, $value) } /** - * @param string|null $key - * @param mixed|null $default + * @param string|null $key + * @param mixed|null $default * @return mixed */ public static function get($key = null, $default = null) @@ -31,7 +31,7 @@ public static function get($key = null, $default = null) } /** - * @param array $values + * @param array $values */ public static function reset(array $values = []) { diff --git a/tests/Dependencies/IndexConfigurator.php b/tests/Dependencies/IndexConfigurator.php index b2836f1..d1ec9e3 100644 --- a/tests/Dependencies/IndexConfigurator.php +++ b/tests/Dependencies/IndexConfigurator.php @@ -7,7 +7,7 @@ trait IndexConfigurator { /** - * @param array $params Available parameters: name, settings, default_mapping, methods. + * @param array $params Available parameters: name, settings, default_mapping, methods. * @return ElasticIndexConfigurator */ public function mockIndexConfigurator(array $params = []) diff --git a/tests/Dependencies/Model.php b/tests/Dependencies/Model.php index 60f8503..5f5c630 100644 --- a/tests/Dependencies/Model.php +++ b/tests/Dependencies/Model.php @@ -10,7 +10,7 @@ trait Model use IndexConfigurator; /** - * @param array $params Available parameters: key, searchable_as, searchable_array, index_configurator, methods. + * @param array $params Available parameters: key, searchable_as, searchable_array, index_configurator, methods. * @return Searchable */ public function mockModel(array $params = []) diff --git a/tests/bootstrap.php b/tests/bootstrap.php index 661d98d..a7d3419 100644 --- a/tests/bootstrap.php +++ b/tests/bootstrap.php @@ -4,8 +4,8 @@ if (! function_exists('config')) { /** - * @param string|null $key - * @param mixed|null $default + * @param string|null $key + * @param mixed|null $default * @return mixed */ function config($key = null, $default = null)