Remove superfluous phpdoc tags

Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com>
laravie · Nov 14, 2019 · ad084d9 · ad084d9
1 parent 76894d8
commit ad084d9
Show file tree

Hide file tree

Showing 9 changed files with 1 addition and 86 deletions.
diff --git a/src/Orderable.php b/src/Orderable.php
@@ -29,10 +29,6 @@ class Orderable
 
     /**
      * Construct a new Ordered Query.
-     *
-     * @param  string|null  $column
-     * @param  string  $direction
-     * @param  array  $config
      */
     public function __construct(?string $column, string $direction = 'asc', array $config = [])
     {
@@ -57,8 +53,6 @@ public function apply($query)
 
     /**
      * Validate requirement before applying to query.
-     *
-     * @return bool
      */
     protected function validate(): bool
     {
@@ -74,10 +68,6 @@ protected function validate(): bool
 
     /**
      * Sanitized column name.
-     *
-     * @param  string  $column
-     *
-     * @return string
      */
     protected function sanitizeColumnName(string $column): string
     {
@@ -88,10 +78,6 @@ protected function sanitizeColumnName(string $column): string
 
     /**
      * Sanitized ordered direction.
-     *
-     * @param  string  $direction
-     *
-     * @return string
      */
     protected function sanitizeDirection(string $direction): string
     {

diff --git a/src/Searchable.php b/src/Searchable.php
@@ -22,9 +22,6 @@ class Searchable
 
     /**
      * Construct a new Search Query.
-     *
-     * @param  string|null  $keyword
-     * @param  array  $columns
      */
     public function __construct(?string $keyword, array $columns = [])
     {
@@ -65,7 +62,6 @@ public function apply($query)
      *
      * @param  \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder  $query
      * @param  \Laravie\QueryFilter\Value\Field  $column
-     * @param  string  $likeOperator
      *
      * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder
      */
@@ -89,8 +85,6 @@ protected function queryOnColumn($query, Value\Field $column, string $likeOperat
      *
      * @param  \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder  $query
      * @param  \Laravie\QueryFilter\Value\Field  $column
-     * @param  string  $likeOperator
-     * @param  string  $whereOperator
      *
      * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder
      */
@@ -120,8 +114,6 @@ protected function queryOnColumnUsing(
      *
      * @param  \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder  $query
      * @param  \Laravie\QueryFilter\Value\Field  $column
-     * @param  string  $likeOperator
-     * @param  string  $whereOperator
      *
      * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder
      */

diff --git a/src/Taxonomy.php b/src/Taxonomy.php
@@ -30,10 +30,6 @@ class Taxonomy
 
     /**
      * Construct a new Matches Query.
-     *
-     * @param  string|null  $keyword
-     * @param  array  $rules
-     * @param  array  $columns
      */
     public function __construct(?string $keyword, array $rules = [], array $columns = [])
     {
@@ -62,8 +58,6 @@ public function apply($query)
      * Match basic conditions.
      *
      * @param  \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder  $query
-     *
-     * @return void
      */
     protected function matchBasicConditions($query): void
     {
@@ -76,15 +70,12 @@ protected function matchBasicConditions($query): void
      * Match tagged conditions.
      *
      * @param  \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder  $query
-     *
-     * @return void
      */
     protected function matchTaggedConditions($query): void
     {
         $tagged = $this->keywords->tagged();
 
         if (empty($tagged)) {
-
             return;
         }
 

diff --git a/src/Value/Column.php b/src/Value/Column.php
@@ -40,8 +40,6 @@ public function __construct($name)
 
     /**
      * Is an instance of Illuminate\Database\Query\Expression.
-     *
-     * @return bool
      */
     public function isExpression(): bool
     {
@@ -50,8 +48,6 @@ public function isExpression(): bool
 
     /**
      * Validate column.
-     *
-     * @return bool
      */
     public function validate(): bool
     {
@@ -66,11 +62,6 @@ public function validate(): bool
 
     /**
      * Get if column is acceptable for filter.
-     *
-     * @param  array  $only
-     * @param  array  $except
-     *
-     * @return bool
      */
     public function accepted(array $only = [], array $except = []): bool
     {
@@ -85,8 +76,6 @@ public function accepted(array $only = [], array $except = []): bool
 
     /**
      * Get expression value.
-     *
-     * @return string
      */
     public function getValue(): string
     {
@@ -95,10 +84,6 @@ public function getValue(): string
 
     /**
      * Validate column name.
-     *
-     * @param  string|null  $column
-     *
-     * @return bool
      */
     public static function validateColumnName(?string $column): bool
     {

diff --git a/src/Value/Field.php b/src/Value/Field.php
@@ -8,8 +8,6 @@ class Field extends Column
 {
     /**
      * Validate column.
-     *
-     * @return bool
      */
     public function validate(): bool
     {
@@ -22,8 +20,6 @@ public function validate(): bool
 
     /**
      * Is relation selector.
-     *
-     * @return bool
      */
     public function isRelationSelector(): bool
     {
@@ -32,8 +28,6 @@ public function isRelationSelector(): bool
 
     /**
      * Is JSON path selector.
-     *
-     * @return bool
      */
     public function isJsonPathSelector(): bool
     {
@@ -42,8 +36,6 @@ public function isJsonPathSelector(): bool
 
     /**
      * Wrap relation and field.
-     *
-     * @return array
      */
     public function wrapRelationNameAndField(): array
     {
@@ -57,8 +49,6 @@ public function wrapRelationNameAndField(): array
 
     /**
      * Split the given JSON selector into the field and the optional path and wrap them separately.
-     *
-     * @return array
      */
     public function wrapJsonFieldAndPath(): array
     {

diff --git a/src/Value/Keyword.php b/src/Value/Keyword.php
@@ -15,8 +15,6 @@ class Keyword
 
     /**
      * Construct a new Keyword value object.
-     *
-     * @param  string  $value
      */
     public function __construct(string $value)
     {
@@ -25,8 +23,6 @@ public function __construct(string $value)
 
     /**
      * Validate keyword value.
-     *
-     * @return bool
      */
     public function validate(): bool
     {
@@ -35,10 +31,6 @@ public function validate(): bool
 
     /**
      * Get searchable strings as lowercased.
-     *
-     * @param  string $wildcard
-     * @param  string $replacement
-     * @return array
      */
     public function allLowerCased(string $wildcard = '*', string $replacement = '%'): array
     {
@@ -47,10 +39,6 @@ public function allLowerCased(string $wildcard = '*', string $replacement = '%')
 
     /**
      * Get searchable strings.
-     *
-     * @param  string $wildcard
-     * @param  string $replacement
-     * @return array
      */
     public function all(string $wildcard = '*', string $replacement = '%'): array
     {
@@ -59,12 +47,6 @@ public function all(string $wildcard = '*', string $replacement = '%'): array
 
     /**
      * Convert basic string to searchable result.
-     *
-     * @param  string  $text
-     * @param  string  $wildcard
-     * @param  string  $replacement
-     *
-     * @return array
      */
     public static function searchable(string $text, string $wildcard = '*', string $replacement = '%'): array
     {

diff --git a/src/Value/Keywords.php b/src/Value/Keywords.php
@@ -22,9 +22,6 @@ class Keywords
 
     /**
      * Construct a new Condition value object.
-     *
-     * @param  string $basic
-     * @param  array  $tagged
      */
     public function __construct(string $basic, array $tagged)
     {
@@ -35,9 +32,6 @@ public function __construct(string $basic, array $tagged)
     /**
      * Parse rules from keyword.
      *
-     * @param  string  $keyword
-     * @param  array  $rules
-     *
      * @return array
      */
     public static function parse(string $keyword, array $rules)
@@ -69,8 +63,6 @@ public static function parse(string $keyword, array $rules)
 
     /**
      * Get basic conditions.
-     *
-     * @return string
      */
     public function basic(): string
     {
@@ -79,8 +71,6 @@ public function basic(): string
 
     /**
      * Get tagged conditions.
-     *
-     * @return array
      */
     public function tagged(): array
     {

diff --git a/tests/Unit/SearchableTest.php b/tests/Unit/SearchableTest.php
@@ -101,7 +101,6 @@ public function it_ignores_build_search_query_when_keyword_is_empty()
         $this->assertEquals($query, $stub->apply($query));
     }
 
-
     /** @test */
     public function it_can_build_search_query_with_expression_value()
     {

diff --git a/tests/Unit/TaxonomyTest.php b/tests/Unit/TaxonomyTest.php
@@ -21,7 +21,7 @@ public function it_can_build_match_query()
                 })
             ->shouldReceive('when')->once()->with(true, m::type('Closure'))
                 ->andReturnUsing(static function ($b, $c) use ($query) {
-                    if (!! $b) {
+                    if ((bool) $b) {
                         return $c($query);
                     }
                 })