Fix styling

LaravelFreelancerNL · Dec 4, 2023 · 22ec5ca · 22ec5ca
1 parent 009da65
commit 22ec5ca
Show file tree

Hide file tree

Showing 29 changed files with 26 additions and 133 deletions.
diff --git a/src/AQL/HasArangoSearchFunctions.php b/src/AQL/HasArangoSearchFunctions.php
@@ -110,14 +110,10 @@ public function tfidf(
      * Match documents where the attribute at path is present and is of the specified data type.
      *
      * https://www.arangodb.com/docs/stable/aql/functions-arangosearch.html#exists
-     *
-     * @param  Expression|QueryBuilder|string  $path
-     * @param  Expression|QueryBuilder|null|string  $type
-     * @return FunctionExpression
      */
     public function exists(
         Expression|QueryBuilder|string $path,
-        Expression|null|string|QueryBuilder $type = null
+        Expression|string|QueryBuilder $type = null
     ): FunctionExpression {
         $arguments = [
             $path,
@@ -132,13 +128,6 @@ public function exists(
      * Match documents where the attribute at path is present and is of the specified data type.
      *
      * https://www.arangodb.com/docs/stable/aql/functions-arangosearch.html#in_range
-     *
-     * @param  string|Expression  $path
-     * @param  int|float|string|Expression|QueryBuilder  $low
-     * @param  int|float|string|Expression|QueryBuilder  $high
-     * @param  bool|Expression|QueryBuilder|null  $includeLow
-     * @param  bool|Expression|QueryBuilder|null  $includeHigh
-     * @return FunctionExpression
      */
     public function inRange(
         string|Expression $path,
@@ -171,7 +160,6 @@ public function inRange(
      * @param  null|bool|object  $transpositions
      * @param  null|int|object  $maxTerms
      * @param  null|string|object  $prefix
-     * @return FunctionExpression
      */
     public function levenshteinMatch(
         mixed $path,
@@ -221,7 +209,6 @@ public function like(
      * @param  string|object  $target
      * @param  null|int|float|object  $threshold
      * @param  null|string|object  $analyzer
-     * @return FunctionExpression
      */
     public function nGramMatch(
         mixed $path,

diff --git a/src/AQL/HasArrayFunctions.php b/src/AQL/HasArrayFunctions.php
@@ -21,9 +21,6 @@ trait HasArrayFunctions
      * @link https://www.arangodb.com/docs/stable/aql/functions-array.html#append
      *
      * @param  array<mixed>|object  $array
-     * @param  mixed  $values
-     * @param  bool|null  $unique
-     * @return FunctionExpression
      */
     public function append(mixed $array, mixed $values, bool $unique = null): FunctionExpression
     {
@@ -44,7 +41,6 @@ public function append(mixed $array, mixed $values, bool $unique = null): Functi
      * @link https://www.arangodb.com/docs/stable/aql/functions-array.html#length
      *
      * @param  mixed  $value
-     * @return FunctionExpression
      */
     public function count($value): FunctionExpression
     {
@@ -57,7 +53,6 @@ public function count($value): FunctionExpression
      * @link https://www.arangodb.com/docs/stable/aql/functions-array.html#count_distinct
      *
      * @param  mixed  $value
-     * @return FunctionExpression
      */
     public function countDistinct($value): FunctionExpression
     {
@@ -70,7 +65,6 @@ public function countDistinct($value): FunctionExpression
      * @link https://www.arangodb.com/docs/stable/aql/functions-array.html#first
      *
      * @param  mixed  $value
-     * @return FunctionExpression
      */
     public function first($value): FunctionExpression
     {
@@ -84,7 +78,6 @@ public function first($value): FunctionExpression
      *
      * @param  array<mixed>|object  $array
      * @param  int|object  $depth
-     * @return FunctionExpression
      */
     public function flatten(mixed $array, mixed $depth = 1): FunctionExpression
     {
@@ -102,7 +95,6 @@ public function flatten(mixed $array, mixed $depth = 1): FunctionExpression
      * @link https://www.arangodb.com/docs/stable/aql/functions-array.html#intersection
      *
      * @param  array<mixed>  ...$arrays
-     * @return FunctionExpression
      */
     public function intersection(array ...$arrays): FunctionExpression
     {
@@ -115,7 +107,6 @@ public function intersection(array ...$arrays): FunctionExpression
      * @link https://www.arangodb.com/docs/stable/aql/functions-array.html#last
      *
      * @param  mixed  $value
-     * @return FunctionExpression
      */
     public function last($value): FunctionExpression
     {
@@ -124,9 +115,6 @@ public function last($value): FunctionExpression
 
     /**
      * @link https://www.arangodb.com/docs/stable/aql/functions-array.html#length
-     *
-     * @param  mixed  $value
-     * @return FunctionExpression
      */
     public function length(mixed $value): FunctionExpression
     {
@@ -139,7 +127,6 @@ public function length(mixed $value): FunctionExpression
      * @link https://www.arangodb.com/docs/stable/aql/functions-array.html#shift
      *
      * @param  array<mixed>|object  $array
-     * @return FunctionExpression
      */
     public function shift(mixed $array): FunctionExpression
     {
@@ -152,7 +139,6 @@ public function shift(mixed $array): FunctionExpression
      * @link https://www.arangodb.com/docs/stable/aql/functions-array.html#union
      *
      * @param  array<mixed>|Expression|QueryBuilder  $arrays
-     * @return FunctionExpression
      */
     public function union(
         array|Expression|QueryBuilder ...$arrays
@@ -166,7 +152,6 @@ public function union(
      * @link https://www.arangodb.com/docs/stable/aql/functions-array.html#union_distinct
      *
      * @param  array<mixed>|Expression|QueryBuilder  $arrays
-     * @return FunctionExpression
      */
     public function unionDistinct(
         array|Expression|QueryBuilder ...$arrays
@@ -180,7 +165,6 @@ public function unionDistinct(
      * @link https://www.arangodb.com/docs/stable/aql/functions-array.html#unique
      *
      * @param  array<mixed>|object  $array
-     * @return FunctionExpression
      */
     public function unique(mixed $array): FunctionExpression
     {

diff --git a/src/AQL/HasDateFunctions.php b/src/AQL/HasDateFunctions.php
@@ -202,7 +202,7 @@ public function dateRound(
     public function dateUtcToLocal(
         int|string|object $date,
         string|object $timezone,
-        null|array|object $zoneInfo = null
+        array|object $zoneInfo = null
     ): FunctionExpression {
         $arguments = [
             'date' => $date,
@@ -225,7 +225,7 @@ public function dateUtcToLocal(
     public function dateLocalToUtc(
         int|string|object $date,
         string|object $timezone,
-        null|array|object $zoneInfo = null
+        array|object $zoneInfo = null
     ): FunctionExpression {
         $arguments = [
             'date' => $date,

diff --git a/src/AQL/HasDocumentFunctions.php b/src/AQL/HasDocumentFunctions.php
@@ -68,8 +68,6 @@ public function keepAttributes(
      *
      * @param  array<mixed>|object  $document
      * @param  array<mixed>|object  $examples
-     * @param  bool|QueryBuilder|Expression  $returnIndex
-     * @return FunctionExpression
      */
     public function matches(
         array|object $document,
@@ -91,7 +89,6 @@ public function matches(
      * @link https://www.arangodb.com/docs/stable/aql/functions-document.html#merge
      *
      * @param  array<mixed>|string|Expression  $documents
-     * @return FunctionExpression
      */
     public function merge(string|array|Expression ...$documents): FunctionExpression
     {
@@ -104,7 +101,6 @@ public function merge(string|array|Expression ...$documents): FunctionExpression
      * @link https://www.arangodb.com/docs/stable/aql/functions-document.html#parse_identifier
      *
      * @param  string|object  $documentHandle
-     * @return FunctionExpression
      */
     public function parseIdentifier(mixed $documentHandle): FunctionExpression
     {

diff --git a/src/AQL/HasGeoFunctions.php b/src/AQL/HasGeoFunctions.php
@@ -24,7 +24,6 @@ trait HasGeoFunctions
      * @param  mixed  $longitude1
      * @param  mixed  $latitude2
      * @param  mixed  $longitude2
-     * @return FunctionExpression
      */
     public function distance($latitude1, $longitude1, $latitude2, $longitude2): FunctionExpression
     {
@@ -83,7 +82,6 @@ public function geoDistance(
      *
      * @param  string|array<mixed>|object  $geoJsonA
      * @param  string|array<mixed>|object  $geoJsonB
-     * @return FunctionExpression
      */
     public function geoEquals(
         string|array|object $geoJsonA,
@@ -99,7 +97,6 @@ public function geoEquals(
      *
      * @param  string|array<mixed>|object|object  $geoJsonA
      * @param  string|array<mixed>|object|object  $geoJsonB
-     * @return FunctionExpression
      */
     public function geoIntersects(mixed $geoJsonA, mixed $geoJsonB): FunctionExpression
     {
@@ -142,7 +139,6 @@ public function geoInRange(
      * @link https://www.arangodb.com/docs/stable/aql/functions-geo.html#geo_linestring
      *
      * @param  array<mixed>|object  $points
-     * @return FunctionExpression
      */
     public function geoLineString(mixed $points): FunctionExpression
     {
@@ -156,7 +152,6 @@ public function geoLineString(mixed $points): FunctionExpression
      * @link https://www.arangodb.com/docs/stable/aql/functions-geo.html#geo_multilinestring
      *
      * @param  array<mixed>|object  $points
-     * @return FunctionExpression
      */
     public function geoMultiLineString(mixed $points): FunctionExpression
     {
@@ -181,7 +176,6 @@ public function geoPoint(
      * @link https://www.arangodb.com/docs/stable/aql/functions-geo.html#geo_multipoint
      *
      * @param  array<mixed>|object  $points
-     * @return FunctionExpression
      */
     public function geoMultiPoint(mixed $points): FunctionExpression
     {
@@ -194,7 +188,6 @@ public function geoMultiPoint(mixed $points): FunctionExpression
      * @link https://www.arangodb.com/docs/stable/aql/functions-geo.html#geo_polygon
      *
      * @param  array<mixed>|object  $points
-     * @return FunctionExpression
      */
     public function geoPolygon(mixed $points): FunctionExpression
     {
@@ -207,7 +200,6 @@ public function geoPolygon(mixed $points): FunctionExpression
      * @link https://www.arangodb.com/docs/stable/aql/functions-geo.html#geo_polygon
      *
      * @param  array<mixed>|object  $points
-     * @return FunctionExpression
      */
     public function geoMultiPolygon(mixed $points): FunctionExpression
     {

diff --git a/src/AQL/HasGraphClauses.php b/src/AQL/HasGraphClauses.php
@@ -142,7 +142,7 @@ public function edgeCollections(): self
     public function prune(
         object|array|string|int|float|bool|null $leftOperand,
         string|QueryBuilder|Expression $comparisonOperator = null,
-        object|array|string|int|float|bool|null $rightOperand = null,
+        object|array|string|int|float|bool $rightOperand = null,
         string|QueryBuilder|Expression $logicalOperator = null,
         string $pruneVariable = null
     ): self {

diff --git a/src/AQL/HasQueryClauses.php b/src/AQL/HasQueryClauses.php
@@ -60,7 +60,7 @@ public function for(
     public function filter(
         object|array|string|int|float|bool|null $leftOperand,
         string $comparisonOperator = null,
-        object|array|string|int|float|bool|null $rightOperand = null,
+        object|array|string|int|float|bool $rightOperand = null,
         string $logicalOperator = null
     ): self {
         $predicates = $leftOperand;
@@ -84,7 +84,7 @@ public function filter(
     public function search(
         object|array|string|int|float|bool|null $leftOperand,
         string $comparisonOperator = null,
-        object|array|string|int|float|bool|null $rightOperand = null,
+        object|array|string|int|float|bool $rightOperand = null,
         string $logicalOperator = null
     ): self {
         $predicates = $leftOperand;

diff --git a/src/AQL/HasStringFunctions.php b/src/AQL/HasStringFunctions.php
@@ -31,9 +31,7 @@ public function concat(
      *
      * @link https://www.arangodb.com/docs/stable/aql/functions-string.html#concat_separator
      *
-     * @param  string|Expression|QueryBuilder  $separator
      * @param  array<int, string|array<string>|Expression|QueryBuilder>  ...$values
-     * @return FunctionExpression
      */
     public function concatSeparator(
         string|Expression|QueryBuilder $separator,
@@ -139,7 +137,7 @@ public function lower(
      */
     public function ltrim(
         string|object $value,
-        null|string|object $char = null
+        string|object $char = null
     ): FunctionExpression {
         $arguments = [
             'value' => $value,
@@ -227,7 +225,7 @@ public function regexTest(
      */
     public function rtrim(
         string|object $value,
-        null|string|object $char = null
+        string|object $char = null
     ): FunctionExpression {
         $arguments = [
             'value' => $value,
@@ -339,7 +337,7 @@ public function tokens(
      */
     public function trim(
         string|object $value,
-        null|string|int|object $type = null
+        string|int|object $type = null
     ): FunctionExpression {
         $arguments = [
             'value' => $value,

diff --git a/src/Clauses/PruneClause.php b/src/Clauses/PruneClause.php
@@ -38,6 +38,6 @@ public function compile(QueryBuilder $queryBuilder): string
 
         $compiledPredicates = $queryBuilder->compilePredicates($this->predicates);
 
-        return  $aql.rtrim($compiledPredicates);
+        return $aql.rtrim($compiledPredicates);
     }
 }
diff --git a/src/Clauses/TraverseClause.php b/src/Clauses/TraverseClause.php
@@ -53,8 +53,6 @@ public function compile(QueryBuilder $queryBuilder): string
 
     /**
      * Default path type
-     *
-     * @return string
      */
     protected function traverseType(): string
     {

diff --git a/src/Clauses/UpdateClause.php b/src/Clauses/UpdateClause.php
@@ -19,15 +19,11 @@ class UpdateClause extends Clause
      */
     protected array|object|string $with;
 
-    /**
-     * @var string|QueryBuilder|Expression
-     */
     protected string|QueryBuilder|Expression $collection;
 
     /**
      * @param  array<mixed>|object|string  $document
      * @param  array<mixed>|object|string  $with
-     * @param  string|QueryBuilder|Expression  $collection
      */
     public function __construct(
         array|object|string $document,

diff --git a/src/Clauses/WindowClause.php b/src/Clauses/WindowClause.php
@@ -24,7 +24,7 @@ class WindowClause extends Clause
      */
     public function __construct(
         array|object $offsets,
-        null|string|QueryBuilder|Expression $rangeValue = null
+        string|QueryBuilder|Expression $rangeValue = null
     ) {
         parent::__construct();
 

diff --git a/src/Expressions/ArithmeticExpression.php b/src/Expressions/ArithmeticExpression.php
@@ -16,10 +16,6 @@ class ArithmeticExpression extends Expression implements ExpressionInterface
 
     /**
      * Create predicate expression.
-     *
-     * @param  int|float|null|Expression|QueryBuilder  $leftOperand
-     * @param  string  $operator
-     * @param  int|float|null|Expression|QueryBuilder  $rightOperand
      */
     public function __construct(
         int|float|null|Expression|QueryBuilder $leftOperand,
@@ -32,8 +28,6 @@ public function __construct(
     /**
      * Compile calculation.
      *
-     * @param  QueryBuilder  $queryBuilder
-     * @return string
      *
      * @throws \Exception
      */
@@ -58,7 +52,6 @@ public function compile(QueryBuilder $queryBuilder): string
     }
 
     /**
-     * @param  QueryBuilder  $queryBuilder
      * @param  array<int|float|string|null|Expression|QueryBuilder>  $calculation
      * @return array<mixed>
      *

diff --git a/src/Expressions/BindExpression.php b/src/Expressions/BindExpression.php
@@ -24,9 +24,6 @@ public function __construct(string $bindVariable, mixed $data = null)
 
     /**
      * Compile expression output.
-     *
-     * @param  QueryBuilder  $queryBuilder
-     * @return string
      */
     public function compile(QueryBuilder $queryBuilder): string
     {
-Original file line number
+Diff line change
@@ Expand Up / @@ -53,8 +53,6 @@ public function compile(QueryBuilder $queryBuilder): string @@
         /**
          * Default path type
-         *
-         * @return string
          */
         protected function traverseType(): string
         {
@@ Expand Down @@