Skip to content
This repository was archived by the owner on Nov 4, 2021. It is now read-only.

Commit 2cd14d7

Browse files
lucasmichotlucasmichot
authored
Enforce Laravel param spacing. (#319)
1 parent 2821233 commit 2cd14d7

18 files changed

+91
-92
lines changed

‎src/Builders/FilterBuilder.php

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ class FilterBuilder extends Builder
4949
/**
5050
* FilterBuilder constructor.
5151
*
52-
* @param \Illuminate\Database\Eloquent\Model $model
53-
* @param callable|null $callback
54-
* @param bool $softDelete
52+
* @param \Illuminate\Database\Eloquent\Model $model
53+
* @param callable|null $callback
54+
* @param bool $softDelete
5555
* @return void
5656
*/
5757
public function __construct(Model $model, $callback = null, $softDelete = false)
@@ -75,8 +75,8 @@ public function __construct(Model $model, $callback = null, $softDelete = false)
7575
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html Range query
7676
*
7777
* Supported operators are =, >, <, >=, <=, <>
78-
* @param string $field Field name
79-
* @param mixed $value Scalar value or an array
78+
* @param string $field Field name
79+
* @param mixed $value Scalar value or an array
8080
* @return $this
8181
*/
8282
public function where($field, $value)
@@ -156,8 +156,8 @@ public function where($field, $value)
156156
*
157157
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html Terms query
158158
*
159-
* @param string $field
160-
* @param array $value
159+
* @param string $field
160+
* @param array $value
161161
* @return $this
162162
*/
163163
public function whereIn($field, array $value)
@@ -176,8 +176,8 @@ public function whereIn($field, array $value)
176176
*
177177
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html Terms query
178178
*
179-
* @param string $field
180-
* @param array $value
179+
* @param string $field
180+
* @param array $value
181181
* @return $this
182182
*/
183183
public function whereNotIn($field, array $value)
@@ -196,8 +196,8 @@ public function whereNotIn($field, array $value)
196196
*
197197
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html Range query
198198
*
199-
* @param string $field
200-
* @param array $value
199+
* @param string $field
200+
* @param array $value
201201
* @return $this
202202
*/
203203
public function whereBetween($field, array $value)
@@ -219,8 +219,8 @@ public function whereBetween($field, array $value)
219219
*
220220
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html Range query
221221
*
222-
* @param string $field
223-
* @param array $value
222+
* @param string $field
223+
* @param array $value
224224
* @return $this
225225
*/
226226
public function whereNotBetween($field, array $value)
@@ -242,7 +242,7 @@ public function whereNotBetween($field, array $value)
242242
*
243243
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html Exists query
244244
*
245-
* @param string $field
245+
* @param string $field
246246
* @return $this
247247
*/
248248
public function whereExists($field)
@@ -261,7 +261,7 @@ public function whereExists($field)
261261
*
262262
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html Exists query
263263
*
264-
* @param string $field
264+
* @param string $field
265265
* @return $this
266266
*/
267267
public function whereNotExists($field)
@@ -280,9 +280,9 @@ public function whereNotExists($field)
280280
*
281281
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html Regexp query
282282
*
283-
* @param string $field
284-
* @param string $value
285-
* @param string $flags
283+
* @param string $field
284+
* @param string $value
285+
* @param string $flags
286286
* @return $this
287287
*/
288288
public function whereRegexp($field, $value, $flags = 'ALL')
@@ -304,9 +304,9 @@ public function whereRegexp($field, $value, $flags = 'ALL')
304304
*
305305
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-query.html Geo distance query
306306
*
307-
* @param string $field
308-
* @param string|array $value
309-
* @param int|string $distance
307+
* @param string $field
308+
* @param string|array $value
309+
* @param int|string $distance
310310
* @return $this
311311
*/
312312
public function whereGeoDistance($field, $value, $distance)
@@ -326,8 +326,8 @@ public function whereGeoDistance($field, $value, $distance)
326326
*
327327
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-bounding-box-query.html Geo bounding box query
328328
*
329-
* @param string $field
330-
* @param array $value
329+
* @param string $field
330+
* @param array $value
331331
* @return $this
332332
*/
333333
public function whereGeoBoundingBox($field, array $value)
@@ -346,8 +346,8 @@ public function whereGeoBoundingBox($field, array $value)
346346
*
347347
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-polygon-query.html Geo polygon query
348348
*
349-
* @param string $field
350-
* @param array $points
349+
* @param string $field
350+
* @param array $points
351351
* @return $this
352352
*/
353353
public function whereGeoPolygon($field, array $points)
@@ -368,9 +368,9 @@ public function whereGeoPolygon($field, array $points)
368368
*
369369
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-shape-query.html Querying Geo Shapes
370370
*
371-
* @param string $field
372-
* @param array $shape
373-
* @param string $relation
371+
* @param string $field
372+
* @param array $shape
373+
* @param string $relation
374374
* @return $this
375375
*/
376376
public function whereGeoShape($field, array $shape, $relation = 'INTERSECTS')
@@ -390,8 +390,8 @@ public function whereGeoShape($field, array $shape, $relation = 'INTERSECTS')
390390
/**
391391
* Add a orderBy clause.
392392
*
393-
* @param string $field
394-
* @param string $direction
393+
* @param string $field
394+
* @param string $direction
395395
* @return $this
396396
*/
397397
public function orderBy($field, $direction = 'asc')
@@ -442,7 +442,7 @@ public function buildPayload()
442442
/**
443443
* Eager load some some relations.
444444
*
445-
* @param array|string $relations
445+
* @param array|string $relations
446446
* @return $this
447447
*/
448448
public function with($relations)
@@ -455,7 +455,7 @@ public function with($relations)
455455
/**
456456
* Set the query offset.
457457
*
458-
* @param int $offset
458+
* @param int $offset
459459
* @return $this
460460
*/
461461
public function from($offset)
@@ -498,7 +498,7 @@ public function paginate($perPage = null, $pageName = 'page', $page = null)
498498
/**
499499
* Collapse by a field.
500500
*
501-
* @param string $field
501+
* @param string $field
502502
* @return $this
503503
*/
504504
public function collapse(string $field)
@@ -511,7 +511,7 @@ public function collapse(string $field)
511511
/**
512512
* Select one or many fields.
513513
*
514-
* @param mixed $fields
514+
* @param mixed $fields
515515
* @return $this
516516
*/
517517
public function select($fields)

‎src/Builders/SearchBuilder.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ class SearchBuilder extends FilterBuilder
1616
/**
1717
* SearchBuilder constructor.
1818
*
19-
* @param \Illuminate\Database\Eloquent\Model $model
20-
* @param string $query
21-
* @param callable|null $callback
22-
* @param bool $softDelete
19+
* @param \Illuminate\Database\Eloquent\Model $model
20+
* @param string $query
21+
* @param callable|null $callback
22+
* @param bool $softDelete
2323
* @return void
2424
*/
2525
public function __construct(Model $model, $query, $callback = null, $softDelete = false)
@@ -32,7 +32,7 @@ public function __construct(Model $model, $query, $callback = null, $softDelete
3232
/**
3333
* Add a rule.
3434
*
35-
* @param string|callable $rule Search rule class name or function
35+
* @param string|callable $rule Search rule class name or function
3636
* @return $this
3737
*/
3838
public function rule($rule)

‎src/Console/ElasticIndexDropCommand.php

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
use Illuminate\Console\Command;
66
use ScoutElastic\Console\Features\RequiresIndexConfiguratorArgument;
77
use ScoutElastic\Facades\ElasticClient;
8-
use ScoutElastic\IndexConfigurator;
98
use ScoutElastic\Migratable;
109
use ScoutElastic\Payloads\RawPayload;
1110

@@ -47,7 +46,7 @@ public function handle()
4746
}
4847

4948
/**
50-
* @param IndexConfigurator $configurator
49+
* @param \ScoutElastic\IndexConfigurator $configurator
5150
* @return string
5251
*/
5352
protected function resolveIndexName($configurator)

‎src/Console/ElasticMigrateCommand.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ protected function updateTargetIndexMapping()
174174
/**
175175
* Check if an alias exists.
176176
*
177-
* @param string $name
177+
* @param string $name
178178
* @return bool
179179
*/
180180
protected function isAliasExists($name)
@@ -190,7 +190,7 @@ protected function isAliasExists($name)
190190
/**
191191
* Get an alias.
192192
*
193-
* @param string $name
193+
* @param string $name
194194
* @return array
195195
*/
196196
protected function getAlias($name)
@@ -206,7 +206,7 @@ protected function getAlias($name)
206206
/**
207207
* Delete an alias.
208208
*
209-
* @param string $name
209+
* @param string $name
210210
* @return void
211211
*/
212212
protected function deleteAlias($name)
@@ -237,7 +237,7 @@ protected function deleteAlias($name)
237237
/**
238238
* Create an alias for the target index.
239239
*
240-
* @param string $name
240+
* @param string $name
241241
* @return void
242242
*/
243243
protected function createAliasForTargetIndex($name)

‎src/Console/SearchableModelMakeCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ protected function getSearchRule()
7272
/**
7373
* Build the class.
7474
*
75-
* @param string $name
75+
* @param string $name
7676
* @return string
7777
*/
7878
protected function buildClass($name)

‎src/ElasticEngine.php

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ class ElasticEngine extends Engine
4040
/**
4141
* ElasticEngine constructor.
4242
*
43-
* @param \ScoutElastic\Indexers\IndexerInterface $indexer
44-
* @param bool $updateMapping
43+
* @param \ScoutElastic\Indexers\IndexerInterface $indexer
44+
* @param bool $updateMapping
4545
* @return void
4646
*/
4747
public function __construct(IndexerInterface $indexer, $updateMapping)
@@ -91,8 +91,8 @@ public function delete($models)
9191
/**
9292
* Build the payload collection.
9393
*
94-
* @param \Laravel\Scout\Builder $builder
95-
* @param array $options
94+
* @param \Laravel\Scout\Builder $builder
95+
* @param array $options
9696
* @return \Illuminate\Support\Collection
9797
*/
9898
public function buildSearchQueryPayloadCollection(Builder $builder, array $options = [])
@@ -159,8 +159,8 @@ public function buildSearchQueryPayloadCollection(Builder $builder, array $optio
159159
/**
160160
* Perform the search.
161161
*
162-
* @param \Laravel\Scout\Builder $builder
163-
* @param array $options
162+
* @param \Laravel\Scout\Builder $builder
163+
* @param array $options
164164
* @return array|mixed
165165
*/
166166
protected function performSearch(Builder $builder, array $options = [])
@@ -214,7 +214,7 @@ public function paginate(Builder $builder, $perPage, $page)
214214
/**
215215
* Explain the search.
216216
*
217-
* @param \Laravel\Scout\Builder $builder
217+
* @param \Laravel\Scout\Builder $builder
218218
* @return array|mixed
219219
*/
220220
public function explain(Builder $builder)
@@ -227,7 +227,7 @@ public function explain(Builder $builder)
227227
/**
228228
* Profile the search.
229229
*
230-
* @param \Laravel\Scout\Builder $builder
230+
* @param \Laravel\Scout\Builder $builder
231231
* @return array|mixed
232232
*/
233233
public function profile(Builder $builder)
@@ -240,7 +240,7 @@ public function profile(Builder $builder)
240240
/**
241241
* Return the number of documents found.
242242
*
243-
* @param \Laravel\Scout\Builder $builder
243+
* @param \Laravel\Scout\Builder $builder
244244
* @return int
245245
*/
246246
public function count(Builder $builder)
@@ -265,8 +265,8 @@ public function count(Builder $builder)
265265
/**
266266
* Make a raw search.
267267
*
268-
* @param \Illuminate\Database\Eloquent\Model $model
269-
* @param array $query
268+
* @param \Illuminate\Database\Eloquent\Model $model
269+
* @param array $query
270270
* @return mixed
271271
*/
272272
public function searchRaw(Model $model, $query)

‎src/Highlight.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ class Highlight
1414
/**
1515
* Highlight constructor.
1616
*
17-
* @param array $highlight
17+
* @param array $highlight
1818
* @return void
1919
*/
2020
public function __construct(array $highlight)
@@ -25,7 +25,7 @@ public function __construct(array $highlight)
2525
/**
2626
* Get a value.
2727
*
28-
* @param string $key
28+
* @param string $key
2929
* @return mixed|string|null
3030
*/
3131
public function __get($key)

‎src/Indexers/IndexerInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ interface IndexerInterface
99
/**
1010
* Update documents.
1111
*
12-
* @param \Illuminate\Database\Eloquent\Collection $models
12+
* @param \Illuminate\Database\Eloquent\Collection $models
1313
* @return array
1414
*/
1515
public function update(Collection $models);
1616

1717
/**
1818
* Delete documents.
1919
*
20-
* @param \Illuminate\Database\Eloquent\Collection $models
20+
* @param \Illuminate\Database\Eloquent\Collection $models
2121
* @return array
2222
*/
2323
public function delete(Collection $models);

‎src/Payloads/DocumentPayload.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ class DocumentPayload extends TypePayload
1010
/**
1111
* DocumentPayload constructor.
1212
*
13-
* @param \Illuminate\Database\Eloquent\Model $model
13+
* @param \Illuminate\Database\Eloquent\Model $model
1414
* @throws \Exception
1515
* @return void
1616
*/

0 commit comments

Comments
 (0)