From 0e32e0385b96e10f26eee9b60f5bc616520f7017 Mon Sep 17 00:00:00 2001 From: Malvika Chauhan Date: Mon, 28 Feb 2022 20:54:32 +0100 Subject: [PATCH 01/15] Adding latest php 8 versions --- .github/workflows/tests.yaml | 2 ++ composer.json | 6 +++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml index 6aa8f46..ce4b88a 100644 --- a/.github/workflows/tests.yaml +++ b/.github/workflows/tests.yaml @@ -16,6 +16,8 @@ jobs: - 7.2 - 7.3 - 7.4 + - 8.0 + - 8.1 steps: - name: Checkout diff --git a/composer.json b/composer.json index eaecfbe..5a31d04 100644 --- a/composer.json +++ b/composer.json @@ -30,14 +30,14 @@ } ], "require": { - "php": "~7.1", + "php": ">=7.1.3", "lstrojny/functional-php": "~0.1|~1.0", "internations/solr-utils": "~0.8" }, "require-dev": { "internations/testing-component": "dev-master", - "internations/kodierungsregelwerksammlung": "^0.35.0", - "phpunit/phpunit": "~6" + "internations/kodierungsregelwerksammlung": "~0.35", + "phpunit/phpunit": "~7 || ~8 || ~9" }, "autoload": { "psr-0": { From 144ecb3741d66461d5b9b9673d1ad668c01f0a51 Mon Sep 17 00:00:00 2001 From: Malvika Chauhan Date: Mon, 28 Feb 2022 20:57:12 +0100 Subject: [PATCH 02/15] Removing PCOV --- .github/workflows/tests.yaml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml index ce4b88a..00a823a 100644 --- a/.github/workflows/tests.yaml +++ b/.github/workflows/tests.yaml @@ -35,11 +35,6 @@ jobs: with: composer-options: --prefer-dist - - name: Setup PCOV - run: | - composer require pcov/clobber - vendor/bin/pcov clobber - - name: Run Tests run: composer tests From 42969ccf3d7c4e799e77c9a992ed2413844c4d82 Mon Sep 17 00:00:00 2001 From: Malvika Chauhan Date: Mon, 28 Feb 2022 21:11:15 +0100 Subject: [PATCH 03/15] Removing for now, not sure we might need it --- phpunit.xml.dist | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 3daf7f2..c40d338 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -3,9 +3,7 @@ convertErrorsToExceptions="true" convertWarningsToExceptions="true" convertNoticesToExceptions="true" - mapTestClassNameToCoveredClassName="true" bootstrap="vendor/autoload.php" - strict="true" verbose="true" colors="true" timeoutForLargeTests="100"> @@ -16,21 +14,6 @@ - - - - - - - - - vendor/ - tests/ - - - From 4e806c03e054062266fb3d78eb5e919ee7eaac65 Mon Sep 17 00:00:00 2001 From: Lars Strojny Date: Wed, 9 Mar 2022 12:59:47 +0100 Subject: [PATCH 04/15] Remove testing component dependency --- composer.json | 1 - .../Solr/Tests/Expression/ExpressionBuilderTest.php | 5 ++--- .../Component/Solr/Tests/Expression/ExpressionTest.php | 4 ++-- .../Component/Solr/Tests/Expression/PerformanceTest.php | 4 ++-- 4 files changed, 6 insertions(+), 8 deletions(-) diff --git a/composer.json b/composer.json index 5a31d04..303c363 100644 --- a/composer.json +++ b/composer.json @@ -35,7 +35,6 @@ "internations/solr-utils": "~0.8" }, "require-dev": { - "internations/testing-component": "dev-master", "internations/kodierungsregelwerksammlung": "~0.35", "phpunit/phpunit": "~7 || ~8 || ~9" }, diff --git a/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php b/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php index 887ff17..970ba42 100644 --- a/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php +++ b/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php @@ -4,12 +4,11 @@ use InterNations\Component\Solr\Expression\CompositeExpression; use InterNations\Component\Solr\Expression\ExpressionBuilder; use InterNations\Component\Solr\Expression\GroupExpression; -use InterNations\Component\Solr\Expression\ParameterExpression; -use InterNations\Component\Testing\AbstractTestCase; use DateTime; use DateTimeZone; +use PHPUnit\Framework\TestCase; -class ExpressionBuilderTest extends AbstractTestCase +class ExpressionBuilderTest extends TestCase { /** * @var ExpressionBuilder diff --git a/tests/InterNations/Component/Solr/Tests/Expression/ExpressionTest.php b/tests/InterNations/Component/Solr/Tests/Expression/ExpressionTest.php index 0723f5a..8442fd4 100644 --- a/tests/InterNations/Component/Solr/Tests/Expression/ExpressionTest.php +++ b/tests/InterNations/Component/Solr/Tests/Expression/ExpressionTest.php @@ -5,7 +5,6 @@ use InterNations\Component\Solr\Expression\GeolocationExpression; use InterNations\Component\Solr\Expression\LocalParamsExpression; use InterNations\Component\Solr\Expression\ParameterExpression; -use InterNations\Component\Testing\AbstractTestCase; use InterNations\Component\Solr\Expression\DateTimeExpression; use InterNations\Component\Solr\Expression\PhraseExpression; use InterNations\Component\Solr\Expression\WildcardExpression; @@ -18,8 +17,9 @@ use InterNations\Component\Solr\Expression\BooleanExpression; use DateTime; use DateTimeZone; +use PHPUnit\Framework\TestCase; -class ExpressionTest extends AbstractTestCase +class ExpressionTest extends TestCase { public function testPhraseExpression() { diff --git a/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php b/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php index c887b88..7108c32 100644 --- a/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php +++ b/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php @@ -1,14 +1,14 @@ Date: Wed, 9 Mar 2022 13:01:17 +0100 Subject: [PATCH 05/15] Revert "Remove testing component dependency" This reverts commit 4e806c03e054062266fb3d78eb5e919ee7eaac65. --- composer.json | 1 + .../Solr/Tests/Expression/ExpressionBuilderTest.php | 5 +++-- .../Component/Solr/Tests/Expression/ExpressionTest.php | 4 ++-- .../Component/Solr/Tests/Expression/PerformanceTest.php | 4 ++-- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/composer.json b/composer.json index 303c363..5a31d04 100644 --- a/composer.json +++ b/composer.json @@ -35,6 +35,7 @@ "internations/solr-utils": "~0.8" }, "require-dev": { + "internations/testing-component": "dev-master", "internations/kodierungsregelwerksammlung": "~0.35", "phpunit/phpunit": "~7 || ~8 || ~9" }, diff --git a/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php b/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php index 970ba42..887ff17 100644 --- a/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php +++ b/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php @@ -4,11 +4,12 @@ use InterNations\Component\Solr\Expression\CompositeExpression; use InterNations\Component\Solr\Expression\ExpressionBuilder; use InterNations\Component\Solr\Expression\GroupExpression; +use InterNations\Component\Solr\Expression\ParameterExpression; +use InterNations\Component\Testing\AbstractTestCase; use DateTime; use DateTimeZone; -use PHPUnit\Framework\TestCase; -class ExpressionBuilderTest extends TestCase +class ExpressionBuilderTest extends AbstractTestCase { /** * @var ExpressionBuilder diff --git a/tests/InterNations/Component/Solr/Tests/Expression/ExpressionTest.php b/tests/InterNations/Component/Solr/Tests/Expression/ExpressionTest.php index 8442fd4..0723f5a 100644 --- a/tests/InterNations/Component/Solr/Tests/Expression/ExpressionTest.php +++ b/tests/InterNations/Component/Solr/Tests/Expression/ExpressionTest.php @@ -5,6 +5,7 @@ use InterNations\Component\Solr\Expression\GeolocationExpression; use InterNations\Component\Solr\Expression\LocalParamsExpression; use InterNations\Component\Solr\Expression\ParameterExpression; +use InterNations\Component\Testing\AbstractTestCase; use InterNations\Component\Solr\Expression\DateTimeExpression; use InterNations\Component\Solr\Expression\PhraseExpression; use InterNations\Component\Solr\Expression\WildcardExpression; @@ -17,9 +18,8 @@ use InterNations\Component\Solr\Expression\BooleanExpression; use DateTime; use DateTimeZone; -use PHPUnit\Framework\TestCase; -class ExpressionTest extends TestCase +class ExpressionTest extends AbstractTestCase { public function testPhraseExpression() { diff --git a/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php b/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php index 7108c32..c887b88 100644 --- a/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php +++ b/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php @@ -1,14 +1,14 @@ Date: Wed, 9 Mar 2022 13:01:26 +0100 Subject: [PATCH 06/15] Revert "Revert "Remove testing component dependency"" This reverts commit c4bd9af00eb656a0f70bbb16ea71b16e7d0af09c. --- composer.json | 1 - .../Solr/Tests/Expression/ExpressionBuilderTest.php | 5 ++--- .../Component/Solr/Tests/Expression/ExpressionTest.php | 4 ++-- .../Component/Solr/Tests/Expression/PerformanceTest.php | 4 ++-- 4 files changed, 6 insertions(+), 8 deletions(-) diff --git a/composer.json b/composer.json index 5a31d04..303c363 100644 --- a/composer.json +++ b/composer.json @@ -35,7 +35,6 @@ "internations/solr-utils": "~0.8" }, "require-dev": { - "internations/testing-component": "dev-master", "internations/kodierungsregelwerksammlung": "~0.35", "phpunit/phpunit": "~7 || ~8 || ~9" }, diff --git a/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php b/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php index 887ff17..970ba42 100644 --- a/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php +++ b/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php @@ -4,12 +4,11 @@ use InterNations\Component\Solr\Expression\CompositeExpression; use InterNations\Component\Solr\Expression\ExpressionBuilder; use InterNations\Component\Solr\Expression\GroupExpression; -use InterNations\Component\Solr\Expression\ParameterExpression; -use InterNations\Component\Testing\AbstractTestCase; use DateTime; use DateTimeZone; +use PHPUnit\Framework\TestCase; -class ExpressionBuilderTest extends AbstractTestCase +class ExpressionBuilderTest extends TestCase { /** * @var ExpressionBuilder diff --git a/tests/InterNations/Component/Solr/Tests/Expression/ExpressionTest.php b/tests/InterNations/Component/Solr/Tests/Expression/ExpressionTest.php index 0723f5a..8442fd4 100644 --- a/tests/InterNations/Component/Solr/Tests/Expression/ExpressionTest.php +++ b/tests/InterNations/Component/Solr/Tests/Expression/ExpressionTest.php @@ -5,7 +5,6 @@ use InterNations\Component\Solr\Expression\GeolocationExpression; use InterNations\Component\Solr\Expression\LocalParamsExpression; use InterNations\Component\Solr\Expression\ParameterExpression; -use InterNations\Component\Testing\AbstractTestCase; use InterNations\Component\Solr\Expression\DateTimeExpression; use InterNations\Component\Solr\Expression\PhraseExpression; use InterNations\Component\Solr\Expression\WildcardExpression; @@ -18,8 +17,9 @@ use InterNations\Component\Solr\Expression\BooleanExpression; use DateTime; use DateTimeZone; +use PHPUnit\Framework\TestCase; -class ExpressionTest extends AbstractTestCase +class ExpressionTest extends TestCase { public function testPhraseExpression() { diff --git a/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php b/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php index c887b88..7108c32 100644 --- a/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php +++ b/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php @@ -1,14 +1,14 @@ Date: Wed, 9 Mar 2022 13:02:50 +0100 Subject: [PATCH 07/15] Inline timing assertion --- .../Solr/Tests/Expression/PerformanceTest.php | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php b/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php index 7108c32..70d637d 100644 --- a/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php +++ b/tests/InterNations/Component/Solr/Tests/Expression/PerformanceTest.php @@ -2,16 +2,14 @@ namespace InterNations\Component\Solr\Tests\Expression; use InterNations\Component\Solr\Expression\GroupExpression; -use InterNations\Component\Testing\TimingTrait; use PHPUnit\Framework\TestCase; +use function microtime; /** * @group performance */ class PerformanceTest extends TestCase { - use TimingTrait; - public function setUp(): void { if (extension_loaded('xdebug')) { @@ -63,4 +61,18 @@ function () use ($list) { } ); } + + private static function assertTiming(float $maxDurationInMs, callable $callable, int $iterations = 20): void + { + $duration = 0; + + for ($a = 0; $a < $iterations; ++$a) { + $start = microtime(true); + $callable(); + $end = microtime(true); + $duration += ($end - $start); + } + + self::assertLessThanOrEqual($maxDurationInMs, ($duration / $iterations) * 1000); + } } From d852fec41b331e0aa293cc55af8dbdd271a3583f Mon Sep 17 00:00:00 2001 From: Lars Strojny Date: Wed, 9 Mar 2022 13:04:16 +0100 Subject: [PATCH 08/15] Another trace --- .../Component/Solr/Tests/Query/QueryStringTest.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/InterNations/Component/Solr/Tests/Query/QueryStringTest.php b/tests/InterNations/Component/Solr/Tests/Query/QueryStringTest.php index 4833289..573a17f 100644 --- a/tests/InterNations/Component/Solr/Tests/Query/QueryStringTest.php +++ b/tests/InterNations/Component/Solr/Tests/Query/QueryStringTest.php @@ -2,13 +2,13 @@ namespace InterNations\Component\Solr\Tests\Query; use InterNations\Component\Solr\Expression\RangeExpression; -use InterNations\Component\Testing\AbstractTestCase; use InterNations\Component\Solr\Query\QueryString; use InterNations\Component\Solr\Expression\GroupExpression; use DateTime; use DateTimeZone; +use PHPUnit\Framework\TestCase; -class QueryStringTest extends AbstractTestCase +class QueryStringTest extends TestCase { public function testSimpleQuery() { From a85f3311a6c680299503f961d75027bcc5b70c36 Mon Sep 17 00:00:00 2001 From: Lars Strojny Date: Wed, 9 Mar 2022 13:07:56 +0100 Subject: [PATCH 09/15] Strange leftover --- .../Component/Solr/Expression/BoostExpression.php | 2 +- .../Component/Solr/Tests/Expression/ExpressionBuilderTest.php | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/src/InterNations/Component/Solr/Expression/BoostExpression.php b/src/InterNations/Component/Solr/Expression/BoostExpression.php index 189d871..c118ddd 100644 --- a/src/InterNations/Component/Solr/Expression/BoostExpression.php +++ b/src/InterNations/Component/Solr/Expression/BoostExpression.php @@ -23,7 +23,7 @@ class BoostExpression extends Expression */ public function __construct(float $boost, $expr) { - $this->boost = is_int($boost) ? $boost : (float) $boost; + $this->boost = $boost; parent::__construct($expr); } diff --git a/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php b/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php index 970ba42..e03a58c 100644 --- a/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php +++ b/tests/InterNations/Component/Solr/Tests/Expression/ExpressionBuilderTest.php @@ -61,6 +61,10 @@ public function testBoost() $this->assertInstanceOf('InterNations\Component\Solr\Expression\BoostExpression', $b); $this->assertSame('"foo bar"^10', (string) $b); + $b = $this->eb->boost($this->eb->phrase('foo bar'), 10.1); + $this->assertInstanceOf('InterNations\Component\Solr\Expression\BoostExpression', $b); + $this->assertSame('"foo bar"^10.1', (string) $b); + $b = $this->eb->field('field', $this->eb->boost($this->eb->phrase('foo bar'), 10)); $this->assertInstanceOf('InterNations\Component\Solr\Expression\FieldExpression', $b); $this->assertSame('field:"foo bar"^10', (string) $b); From 5b9bd55e9eedf72b6d1c0a4e7ebb224bfc6a88e6 Mon Sep 17 00:00:00 2001 From: Lars Strojny Date: Wed, 9 Mar 2022 13:15:45 +0100 Subject: [PATCH 10/15] next --- .../Component/Solr/Expression/BooleanExpression.php | 2 +- .../Component/Solr/Expression/WildcardExpression.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/InterNations/Component/Solr/Expression/BooleanExpression.php b/src/InterNations/Component/Solr/Expression/BooleanExpression.php index ddae845..2157dce 100644 --- a/src/InterNations/Component/Solr/Expression/BooleanExpression.php +++ b/src/InterNations/Component/Solr/Expression/BooleanExpression.php @@ -34,7 +34,7 @@ class BooleanExpression extends Expression * @param ExpressionInterface|string $expr * @param bool $useNotNotation use the NOT notation: (*:* NOT ), e.g. (*:* NOT fieldName:*) */ - public function __construct(string $operator, $expr, bool$useNotNotation = false) + public function __construct(string $operator, $expr, bool $useNotNotation = false) { $this->operator = $operator; $this->useNotNotation = $useNotNotation; diff --git a/src/InterNations/Component/Solr/Expression/WildcardExpression.php b/src/InterNations/Component/Solr/Expression/WildcardExpression.php index 04a178d..a048428 100644 --- a/src/InterNations/Component/Solr/Expression/WildcardExpression.php +++ b/src/InterNations/Component/Solr/Expression/WildcardExpression.php @@ -38,7 +38,7 @@ class WildcardExpression extends Expression * @param string|Expression $prefix * @param string|Expression $suffix */ - public function __construct(string $wildcard, $prefix = '', $suffix = null) + public function __construct(string $wildcard, $prefix = '', $suffix = '') { $this->wildcard = $wildcard === '*' ? '*' : '?'; $this->prefix = $prefix; From 40bc490ca1e94937c27a09b2189e000c32fde19d Mon Sep 17 00:00:00 2001 From: Lars Strojny Date: Wed, 9 Mar 2022 13:26:59 +0100 Subject: [PATCH 11/15] next --- .../Solr/Expression/CompositeExpression.php | 2 +- .../Component/Solr/Expression/Expression.php | 6 +++--- .../Solr/Expression/ExpressionBuilder.php | 20 +++++++++---------- .../Solr/Expression/FieldExpression.php | 5 +++-- .../Solr/Expression/FunctionExpression.php | 2 +- .../Solr/Expression/FuzzyExpression.php | 5 +++-- .../Solr/Expression/GeofiltExpression.php | 2 +- .../Solr/Expression/GeolocationExpression.php | 6 +++--- .../Solr/Expression/LocalParamsExpression.php | 7 ++++--- .../Solr/Expression/ParameterExpression.php | 2 +- .../Solr/Expression/ProximityExpression.php | 4 ++-- .../Solr/Expression/RangeExpression.php | 2 +- .../Solr/Expression/WildcardExpression.php | 11 +++++----- 13 files changed, 38 insertions(+), 36 deletions(-) diff --git a/src/InterNations/Component/Solr/Expression/CompositeExpression.php b/src/InterNations/Component/Solr/Expression/CompositeExpression.php index c96e071..36b740b 100644 --- a/src/InterNations/Component/Solr/Expression/CompositeExpression.php +++ b/src/InterNations/Component/Solr/Expression/CompositeExpression.php @@ -19,7 +19,7 @@ class CompositeExpression extends Expression * * @var array */ - private $expressions = []; + private $expressions; /** * @var string diff --git a/src/InterNations/Component/Solr/Expression/Expression.php b/src/InterNations/Component/Solr/Expression/Expression.php index a10bda9..25081b0 100644 --- a/src/InterNations/Component/Solr/Expression/Expression.php +++ b/src/InterNations/Component/Solr/Expression/Expression.php @@ -14,14 +14,14 @@ class Expression implements ExpressionInterface /** * Expression object or string * - * @var Expression|string + * @var ExpressionInterface|string */ protected $expr; /** * Create new expression object * - * @param Expression|string $expr + * @param ExpressionInterface|string $expr */ public function __construct($expr) { @@ -30,7 +30,7 @@ public function __construct($expr) public function isEqual(string $expr): bool { - return (string) $expr === (string) $this; + return $expr === (string) $this; } public function __toString(): string diff --git a/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php b/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php index 44e7a21..282e63d 100644 --- a/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php +++ b/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php @@ -172,7 +172,7 @@ public function wild($prefix, ?string $wildcard = '?', $suffix = null): ?Express * @param ExpressionInterface|string|null $expr * @return ExpressionInterface|null */ - public function req($expr) + public function req($expr): ?ExpressionInterface { if ($this->ignore($expr)) { return null; @@ -220,11 +220,9 @@ public function not($expr) * null => neutral () * * @param ExpressionInterface|string|null $expr - * @param bool|null $operator @codingStandardsIgnoreLine - * @return ExpressionInterface|null + * @return ExpressionInterface|string|null */ - public function bool($expr, $operator) // @codingStandardsIgnoreLine - + public function bool($expr, ?bool $operator = null) { if ($operator === null) { return $expr; @@ -281,7 +279,7 @@ public function andX(...$args): ?ExpressionInterface return null; } - return new GroupExpression($args, GroupExpression::TYPE_AND); + return new GroupExpression($args, CompositeExpression::TYPE_AND); } /** @@ -297,7 +295,7 @@ public function orX(...$args): ?ExpressionInterface return null; } - return new GroupExpression($args, GroupExpression::TYPE_OR); + return new GroupExpression($args, CompositeExpression::TYPE_OR); } /** @@ -407,7 +405,7 @@ public function dateRange( * * You can either pass an array of parameters, a single parameter or a ParameterExpression * - * @param array|ParameterExpressionInterface|string|null $parameters + * @param array|ExpressionInterface|string|null $parameters */ public function func(string $function, $parameters = null): ExpressionInterface { @@ -484,7 +482,7 @@ public function latLong(float $latitude, float $longitude, int $precision = 12): return new GeolocationExpression($latitude, $longitude, $precision); } - /** @param string|ExpressionInterface|null $expr */ + /** @param ExpressionInterface|string|null $expr */ public function noCache($expr = null): ?ExpressionInterface { if ($this->ignore($expr)) { @@ -494,7 +492,7 @@ public function noCache($expr = null): ?ExpressionInterface return $this->comp([$this->shortLocalParams('cache', false), $expr], null); } - /** @param string|ExpressionInterface|null $expr */ + /** @param ExpressionInterface|string|null $expr */ public function tag(string $tagName, $expr = null): ?ExpressionInterface { if ($this->ignore($expr)) { @@ -504,7 +502,7 @@ public function tag(string $tagName, $expr = null): ?ExpressionInterface return $this->comp([$this->shortLocalParams('tag', $tagName), $expr], null); } - /** @param string|ExpressionInterface|null $expr */ + /** @param ExpressionInterface|string|null $expr */ public function excludeTag(string $tagName, $expr = null): ?ExpressionInterface { if ($this->ignore($expr)) { diff --git a/src/InterNations/Component/Solr/Expression/FieldExpression.php b/src/InterNations/Component/Solr/Expression/FieldExpression.php index f8991bb..e801b98 100644 --- a/src/InterNations/Component/Solr/Expression/FieldExpression.php +++ b/src/InterNations/Component/Solr/Expression/FieldExpression.php @@ -1,6 +1,7 @@ similarity = (float) $similarity; + $this->similarity = $similarity; } } diff --git a/src/InterNations/Component/Solr/Expression/GeofiltExpression.php b/src/InterNations/Component/Solr/Expression/GeofiltExpression.php index 067fe68..ff4c91e 100644 --- a/src/InterNations/Component/Solr/Expression/GeofiltExpression.php +++ b/src/InterNations/Component/Solr/Expression/GeofiltExpression.php @@ -18,7 +18,7 @@ public function __construct( array $additionalParams = [] ) { - $this->field = (string) $field; + $this->field = $field; $this->geolocation = $geolocation; $this->distance = (int) $distance; $this->additionalParams = $additionalParams; diff --git a/src/InterNations/Component/Solr/Expression/GeolocationExpression.php b/src/InterNations/Component/Solr/Expression/GeolocationExpression.php index c64ba5c..359c1a1 100644 --- a/src/InterNations/Component/Solr/Expression/GeolocationExpression.php +++ b/src/InterNations/Component/Solr/Expression/GeolocationExpression.php @@ -9,9 +9,9 @@ class GeolocationExpression extends Expression public function __construct(float $latitude, float $longitude, int $precision) { - $this->latitude = (float) $latitude; - $this->longitude = (float) $longitude; - $this->precision = (int) $precision; + $this->latitude = $latitude; + $this->longitude = $longitude; + $this->precision = $precision; } public function __toString(): string diff --git a/src/InterNations/Component/Solr/Expression/LocalParamsExpression.php b/src/InterNations/Component/Solr/Expression/LocalParamsExpression.php index 2a49984..f2ca258 100644 --- a/src/InterNations/Component/Solr/Expression/LocalParamsExpression.php +++ b/src/InterNations/Component/Solr/Expression/LocalParamsExpression.php @@ -1,12 +1,13 @@ words = $words; - $this->proximity = (int) $proximity; + $this->proximity = $proximity; } public function __toString(): string diff --git a/src/InterNations/Component/Solr/Expression/RangeExpression.php b/src/InterNations/Component/Solr/Expression/RangeExpression.php index 754a3e2..1ff45da 100644 --- a/src/InterNations/Component/Solr/Expression/RangeExpression.php +++ b/src/InterNations/Component/Solr/Expression/RangeExpression.php @@ -42,7 +42,7 @@ public function __construct($start = null, $end = null, bool $inclusive = true) { $this->start = $start; $this->end = $end; - $this->inclusive = (bool) $inclusive; + $this->inclusive = $inclusive; } public function __toString(): string diff --git a/src/InterNations/Component/Solr/Expression/WildcardExpression.php b/src/InterNations/Component/Solr/Expression/WildcardExpression.php index a048428..c55e07d 100644 --- a/src/InterNations/Component/Solr/Expression/WildcardExpression.php +++ b/src/InterNations/Component/Solr/Expression/WildcardExpression.php @@ -1,6 +1,7 @@ Date: Wed, 9 Mar 2022 14:50:44 +0100 Subject: [PATCH 12/15] Next --- src/InterNations/Component/Solr/Expression/ExpressionBuilder.php | 1 - 1 file changed, 1 deletion(-) diff --git a/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php b/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php index 282e63d..86f7a23 100644 --- a/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php +++ b/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php @@ -170,7 +170,6 @@ public function wild($prefix, ?string $wildcard = '?', $suffix = null): ?Express * Create bool, required expression: + * * @param ExpressionInterface|string|null $expr - * @return ExpressionInterface|null */ public function req($expr): ?ExpressionInterface { From e128e57a8e943b7fae8164632b5d068e42b8a2d0 Mon Sep 17 00:00:00 2001 From: Malvika Chauhan Date: Thu, 10 Mar 2022 09:47:22 +0100 Subject: [PATCH 13/15] No named arguments for PHP >=8.0 --- .../Solr/Expression/BooleanExpression.php | 1 + .../Solr/Expression/BoostExpression.php | 1 + .../Solr/Expression/CompositeExpression.php | 6 +- .../Solr/Expression/DateTimeExpression.php | 17 ++--- .../Exception/InvalidArgumentException.php | 11 ++- .../Component/Solr/Expression/Expression.php | 2 + .../Solr/Expression/ExpressionBuilder.php | 69 ++++++++++++++++--- .../Solr/Expression/FieldExpression.php | 1 + .../Solr/Expression/FunctionExpression.php | 9 +-- .../Solr/Expression/FuzzyExpression.php | 1 + .../Solr/Expression/GeofiltExpression.php | 1 + .../Solr/Expression/GeolocationExpression.php | 1 + .../Solr/Expression/LocalParamsExpression.php | 13 ++-- .../Solr/Expression/ParameterExpression.php | 10 +-- .../Solr/Expression/ProximityExpression.php | 5 +- .../Solr/Expression/RangeExpression.php | 2 + .../Solr/Expression/WildcardExpression.php | 1 + .../Component/Solr/Query/QueryString.php | 11 ++- 18 files changed, 107 insertions(+), 55 deletions(-) diff --git a/src/InterNations/Component/Solr/Expression/BooleanExpression.php b/src/InterNations/Component/Solr/Expression/BooleanExpression.php index 2157dce..9718edc 100644 --- a/src/InterNations/Component/Solr/Expression/BooleanExpression.php +++ b/src/InterNations/Component/Solr/Expression/BooleanExpression.php @@ -33,6 +33,7 @@ class BooleanExpression extends Expression * * @param ExpressionInterface|string $expr * @param bool $useNotNotation use the NOT notation: (*:* NOT ), e.g. (*:* NOT fieldName:*) + * @no-named-arguments */ public function __construct(string $operator, $expr, bool $useNotNotation = false) { diff --git a/src/InterNations/Component/Solr/Expression/BoostExpression.php b/src/InterNations/Component/Solr/Expression/BoostExpression.php index c118ddd..5e863d4 100644 --- a/src/InterNations/Component/Solr/Expression/BoostExpression.php +++ b/src/InterNations/Component/Solr/Expression/BoostExpression.php @@ -20,6 +20,7 @@ class BoostExpression extends Expression /** * @param ExpressionInterface|string|null $expr + * @no-named-arguments */ public function __construct(float $boost, $expr) { diff --git a/src/InterNations/Component/Solr/Expression/CompositeExpression.php b/src/InterNations/Component/Solr/Expression/CompositeExpression.php index 36b740b..ab90029 100644 --- a/src/InterNations/Component/Solr/Expression/CompositeExpression.php +++ b/src/InterNations/Component/Solr/Expression/CompositeExpression.php @@ -21,15 +21,14 @@ class CompositeExpression extends Expression */ private $expressions; - /** - * @var string - */ + /** @var string */ private $type; /** * Create new group of expression * * @param mixed[] $expressions + * @no-named-arguments */ public function __construct(array $expressions, ?string $type = self::TYPE_SPACE) { @@ -62,6 +61,7 @@ public function __toString(): string return implode($glue, array_filter($parts)); } + /** @no-named-arguments */ public static function isValidType(?string $type): bool { return $type === static::TYPE_OR diff --git a/src/InterNations/Component/Solr/Expression/DateTimeExpression.php b/src/InterNations/Component/Solr/Expression/DateTimeExpression.php index 9c04de5..21d9905 100644 --- a/src/InterNations/Component/Solr/Expression/DateTimeExpression.php +++ b/src/InterNations/Component/Solr/Expression/DateTimeExpression.php @@ -10,28 +10,21 @@ class DateTimeExpression extends Expression public const FORMAT_START_OF_DAY = 'Y-m-d\T00:00:00\Z'; public const FORMAT_END_OF_DAY = 'Y-m-d\T23:59:59\Z'; - /** - * @var DateTimeZone - */ + /** @var DateTimeZone */ private static $utcTimezone; - /** - * @var DateTime - */ + /** @var DateTime */ private $date; - /** - * @var string|DateTimeZone - */ + /** @var string|DateTimeZone */ private $timezone; - /** - * @var string - */ + /** @var string */ private $format; /** * @param string|DateTimeZone $timezone + * @no-named-arguments */ public function __construct(DateTime $date, ?string $format = null, $timezone = 'UTC') { diff --git a/src/InterNations/Component/Solr/Expression/Exception/InvalidArgumentException.php b/src/InterNations/Component/Solr/Expression/Exception/InvalidArgumentException.php index 755685f..3a0dfbf 100644 --- a/src/InterNations/Component/Solr/Expression/Exception/InvalidArgumentException.php +++ b/src/InterNations/Component/Solr/Expression/Exception/InvalidArgumentException.php @@ -8,6 +8,7 @@ class InvalidArgumentException extends BaseInvalidArgumentException implements E /** * @param string|array $expectation * @param mixed $actual + * @no-named-arguments */ public static function invalidArgument(int $position, string $name, $expectation, $actual): self { @@ -24,7 +25,10 @@ public static function invalidArgument(int $position, string $name, $expectation ); } - /** @param string[] $expectations */ + /** + * @param string[] $expectations + * @no-named-arguments + */ private static function formatExpectations(array $expectations): string { $last = array_pop($expectations); @@ -36,7 +40,10 @@ private static function formatExpectations(array $expectations): string return implode(', ', $expectations) . ' or ' . $last; } - /** @param mixed $actual */ + /** + * @param mixed $actual + * @no-named-arguments + */ private static function getType($actual): string { return is_object($actual) ? get_class($actual) : gettype($actual); diff --git a/src/InterNations/Component/Solr/Expression/Expression.php b/src/InterNations/Component/Solr/Expression/Expression.php index 25081b0..6206794 100644 --- a/src/InterNations/Component/Solr/Expression/Expression.php +++ b/src/InterNations/Component/Solr/Expression/Expression.php @@ -22,12 +22,14 @@ class Expression implements ExpressionInterface * Create new expression object * * @param ExpressionInterface|string $expr + * @no-named-arguments */ public function __construct($expr) { $this->expr = $expr; } + /** @no-named-arguments */ public function isEqual(string $expr): bool { return $expr === (string) $this; diff --git a/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php b/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php index 86f7a23..1e56e74 100644 --- a/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php +++ b/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php @@ -9,9 +9,7 @@ class ExpressionBuilder { - /** - * @var string|DateTimeZone - */ + /** @var string|DateTimeZone */ private $defaultTimezone = 'UTC'; /** @@ -22,6 +20,7 @@ class ExpressionBuilder * * @param DateTimeZone|string $timezone * @throws InvalidArgumentException + * @no-named-arguments */ public function setDefaultTimezone($timezone): void { @@ -36,6 +35,7 @@ public function setDefaultTimezone($timezone): void * Create term expression: * * @param ExpressionInterface|string|null $expr + * @no-named-arguments */ public function eq($expr): ?ExpressionInterface { @@ -56,6 +56,7 @@ public function eq($expr): ?ExpressionInterface * * @param ExpressionInterface|string $field * @param ExpressionInterface|string|array $expr + * @no-named-arguments */ public function field($field, $expr): ?ExpressionInterface { @@ -70,6 +71,7 @@ public function field($field, $expr): ?ExpressionInterface /** * Create phrase expression: "term1 term2" + * @no-named-arguments */ public function phrase(?string $str): ?ExpressionInterface { @@ -84,6 +86,7 @@ public function phrase(?string $str): ?ExpressionInterface * Create boost expression: ^ * * @param ExpressionInterface|string|null $expr + * @no-named-arguments */ public function boost($expr, ?float $boost): ?ExpressionInterface { @@ -99,6 +102,7 @@ public function boost($expr, ?float $boost): ?ExpressionInterface * * @param ExpressionInterface|string $word * @param int|mixed $proximity + * @no-named-arguments */ public function prx($word = null, $proximity = null): ?ExpressionInterface { @@ -119,6 +123,7 @@ public function prx($word = null, $proximity = null): ?ExpressionInterface * * @param ExpressionInterface|string|null $expr * @param float $similarity Similarity between 0.0 und 1.0 + * @no-named-arguments */ public function fzz($expr, ?float $similarity = null): ?ExpressionInterface { @@ -134,6 +139,7 @@ public function fzz($expr, ?float $similarity = null): ?ExpressionInterface * * @param string|int|float|ExpressionInterface $start * @param string|int|float|ExpressionInterface $end + * @no-named-arguments */ public function range($start = null, $end = null, bool $inclusive = true): ExpressionInterface { @@ -145,6 +151,7 @@ public function range($start = null, $end = null, bool $inclusive = true): Expre * * @param string|int|float|ExpressionInterface $start * @param string|int|float|ExpressionInterface $end + * @no-named-arguments */ public function btwnRange($start = null, $end = null): ExpressionInterface { @@ -156,6 +163,7 @@ public function btwnRange($start = null, $end = null): ExpressionInterface * * @param ExpressionInterface|string $prefix * @param ExpressionInterface|string $suffix + * @no-named-arguments */ public function wild($prefix, ?string $wildcard = '?', $suffix = null): ?ExpressionInterface { @@ -170,6 +178,7 @@ public function wild($prefix, ?string $wildcard = '?', $suffix = null): ?Express * Create bool, required expression: + * * @param ExpressionInterface|string|null $expr + * @no-named-arguments */ public function req($expr): ?ExpressionInterface { @@ -185,6 +194,7 @@ public function req($expr): ?ExpressionInterface * * @param ExpressionInterface|string|null $expr * @return ExpressionInterface|null + * @no-named-arguments */ public function prhb($expr) { @@ -201,6 +211,7 @@ public function prhb($expr) * * @param ExpressionInterface|string|null $expr * @return ExpressionInterface|null + * @no-named-arguments */ public function not($expr) { @@ -220,6 +231,7 @@ public function not($expr) * * @param ExpressionInterface|string|null $expr * @return ExpressionInterface|string|null + * @no-named-arguments */ public function bool($expr, ?bool $operator = null) { @@ -238,6 +250,7 @@ public function bool($expr, ?bool $operator = null) * Return string treated as literal (unescaped, unquoted) * * @param ExpressionInterface|string|null $expr + * @no-named-arguments */ public function lit($expr): ?ExpressionInterface { @@ -253,6 +266,7 @@ public function lit($expr): ?ExpressionInterface * * @param ExpressionInterface|string|null $expr * @param string|mixed $type + * @no-named-arguments */ public function grp($expr = null, $type = CompositeExpression::TYPE_SPACE): ?ExpressionInterface { @@ -269,6 +283,7 @@ public function grp($expr = null, $type = CompositeExpression::TYPE_SPACE): ?Exp * Create AND grouped expression: ( AND AND ) * * @param ExpressionInterface[]|string[] $args + * @no-named-arguments */ public function andX(...$args): ?ExpressionInterface { @@ -285,6 +300,7 @@ public function andX(...$args): ?ExpressionInterface * Create OR grouped expression: ( OR OR ) * * @param ExpressionInterface[]|string[] $args + * @no-named-arguments */ public function orX(...$args): ?ExpressionInterface { @@ -302,6 +318,7 @@ public function orX(...$args): ?ExpressionInterface * * @param ExpressionInterface|string|null $expr * @return ExpressionInterface|mixed + * @no-named-arguments */ public function all($expr = null) { @@ -316,6 +333,7 @@ public function all($expr = null) * Create a date expression for a specific day * * @param DateTime|mixed $date + * @no-named-arguments */ public function day($date = null): ?ExpressionInterface { @@ -330,6 +348,7 @@ public function day($date = null): ?ExpressionInterface * Expression for the start of the given date * * @param bool|string $timezone + * @no-named-arguments */ public function startOfDay(?DateTime $date = null, $timezone = false): ?ExpressionInterface { @@ -348,6 +367,7 @@ public function startOfDay(?DateTime $date = null, $timezone = false): ?Expressi * Expression for the end of the given date * * @param bool|string $timezone + * @no-named-arguments */ public function endOfDay(?DateTime $date = null, $timezone = false): ?ExpressionInterface { @@ -362,7 +382,10 @@ public function endOfDay(?DateTime $date = null, $timezone = false): ?Expression ); } - /** @param bool|string $timezone */ + /** + * @param bool|string $timezone + * @no-named-arguments + */ public function date(?DateTime $date = null, $timezone = false): ExpressionInterface { if ($date === null) { @@ -380,6 +403,7 @@ public function date(?DateTime $date = null, $timezone = false): ExpressionInter * Create a range between two dates (one side may be unlimited which is indicated by passing null) * * @param bool|string $timezone + * @no-named-arguments */ public function dateRange( ?DateTime $from = null, @@ -405,6 +429,7 @@ public function dateRange( * You can either pass an array of parameters, a single parameter or a ParameterExpression * * @param array|ExpressionInterface|string|null $parameters + * @no-named-arguments */ public function func(string $function, $parameters = null): ExpressionInterface { @@ -415,6 +440,7 @@ public function func(string $function, $parameters = null): ExpressionInterface * Create a function parameters expression * * @param mixed $parameters + * @no-named-arguments */ public function params(...$parameters): ExpressionInterface { @@ -426,6 +452,7 @@ public function params(...$parameters): ExpressionInterface /** * @param mixed[]|mixed $params * @param bool|mixed $shortForm + * @no-named-arguments */ public function localParams(string $type, $params = [], $shortForm = true): ?ExpressionInterface { @@ -446,7 +473,10 @@ public function localParams(string $type, $params = [], $shortForm = true): ?Exp return new LocalParamsExpression($type, $params, $shortForm); } - /** @param mixed[] $additionalParams */ + /** + * @param mixed[] $additionalParams + * @no-named-arguments + */ public function geofilt( string $field, ?GeolocationExpression $geolocation = null, @@ -461,6 +491,7 @@ public function geofilt( * Create composite expression: * * @param ExpressionInterface|string|null $expr + * @no-named-arguments */ public function comp($expr = null, ?string $type = CompositeExpression::TYPE_SPACE): ?ExpressionInterface { @@ -475,13 +506,17 @@ public function comp($expr = null, ?string $type = CompositeExpression::TYPE_SPA /** * Create a geo location expression: "," using the given precision + * @no-named-arguments */ public function latLong(float $latitude, float $longitude, int $precision = 12): ExpressionInterface { return new GeolocationExpression($latitude, $longitude, $precision); } - /** @param ExpressionInterface|string|null $expr */ + /** + * @param ExpressionInterface|string|null $expr + * @no-named-arguments + */ public function noCache($expr = null): ?ExpressionInterface { if ($this->ignore($expr)) { @@ -491,7 +526,10 @@ public function noCache($expr = null): ?ExpressionInterface return $this->comp([$this->shortLocalParams('cache', false), $expr], null); } - /** @param ExpressionInterface|string|null $expr */ + /** + * @param ExpressionInterface|string|null $expr + * @no-named-arguments + */ public function tag(string $tagName, $expr = null): ?ExpressionInterface { if ($this->ignore($expr)) { @@ -501,7 +539,10 @@ public function tag(string $tagName, $expr = null): ?ExpressionInterface return $this->comp([$this->shortLocalParams('tag', $tagName), $expr], null); } - /** @param ExpressionInterface|string|null $expr */ + /** + * @param ExpressionInterface|string|null $expr + * @no-named-arguments + */ public function excludeTag(string $tagName, $expr = null): ?ExpressionInterface { if ($this->ignore($expr)) { @@ -514,6 +555,7 @@ public function excludeTag(string $tagName, $expr = null): ?ExpressionInterface /** * @param ExpressionInterface|string $tag * @param mixed $value + * @no-named-arguments */ private function shortLocalParams($tag, $value): LocalParamsExpression { @@ -523,6 +565,7 @@ private function shortLocalParams($tag, $value): LocalParamsExpression /** * @param mixed[] $args * @return mixed[] + * @no-named-arguments */ private function parseCompositeArgs(array $args): array { @@ -542,13 +585,19 @@ private function parseCompositeArgs(array $args): array return [$args, $type]; } - /** @param mixed $expr */ + /** + * @param mixed $expr + * @no-named-arguments + */ private function ignore($expr): bool { return $expr === null || (is_string($expr) && trim($expr) === ''); } - /** @param mixed $expr */ + /** + * @param mixed $expr + * @no-named-arguments + */ private function permit($expr): bool { return !$this->ignore($expr); diff --git a/src/InterNations/Component/Solr/Expression/FieldExpression.php b/src/InterNations/Component/Solr/Expression/FieldExpression.php index e801b98..4997351 100644 --- a/src/InterNations/Component/Solr/Expression/FieldExpression.php +++ b/src/InterNations/Component/Solr/Expression/FieldExpression.php @@ -23,6 +23,7 @@ class FieldExpression extends Expression * * @param ExpressionInterface|string $field * @param ExpressionInterface|string $expr + * @no-named-arguments */ public function __construct($field, $expr) { diff --git a/src/InterNations/Component/Solr/Expression/FunctionExpression.php b/src/InterNations/Component/Solr/Expression/FunctionExpression.php index db628dd..466952a 100644 --- a/src/InterNations/Component/Solr/Expression/FunctionExpression.php +++ b/src/InterNations/Component/Solr/Expression/FunctionExpression.php @@ -5,19 +5,16 @@ class FunctionExpression extends Expression { - /** - * @var string - */ + /** @var string */ private $function; - /** - * @var array - */ + /** @var array */ private $parameters; /** * @param ExpressionInterface|string $function * @param ExpressionInterface|array|null $parameters + * @no-named-arguments */ public function __construct($function, $parameters = null) { diff --git a/src/InterNations/Component/Solr/Expression/FuzzyExpression.php b/src/InterNations/Component/Solr/Expression/FuzzyExpression.php index 230027e..f3cbd95 100644 --- a/src/InterNations/Component/Solr/Expression/FuzzyExpression.php +++ b/src/InterNations/Component/Solr/Expression/FuzzyExpression.php @@ -20,6 +20,7 @@ class FuzzyExpression extends Expression * Create new fuzzy query object * * @param ExpressionInterface|string $expr + * @no-named-arguments */ public function __construct($expr, ?float $similarity = null) { diff --git a/src/InterNations/Component/Solr/Expression/GeofiltExpression.php b/src/InterNations/Component/Solr/Expression/GeofiltExpression.php index ff4c91e..a624577 100644 --- a/src/InterNations/Component/Solr/Expression/GeofiltExpression.php +++ b/src/InterNations/Component/Solr/Expression/GeofiltExpression.php @@ -10,6 +10,7 @@ class GeofiltExpression extends Expression /** * @param mixed[] $additionalParams + * @no-named-arguments */ public function __construct( string $field, diff --git a/src/InterNations/Component/Solr/Expression/GeolocationExpression.php b/src/InterNations/Component/Solr/Expression/GeolocationExpression.php index 359c1a1..c626766 100644 --- a/src/InterNations/Component/Solr/Expression/GeolocationExpression.php +++ b/src/InterNations/Component/Solr/Expression/GeolocationExpression.php @@ -7,6 +7,7 @@ class GeolocationExpression extends Expression private $longitude; private $precision; + /** @no-named-arguments */ public function __construct(float $latitude, float $longitude, int $precision) { $this->latitude = $latitude; diff --git a/src/InterNations/Component/Solr/Expression/LocalParamsExpression.php b/src/InterNations/Component/Solr/Expression/LocalParamsExpression.php index f2ca258..b86b8c5 100644 --- a/src/InterNations/Component/Solr/Expression/LocalParamsExpression.php +++ b/src/InterNations/Component/Solr/Expression/LocalParamsExpression.php @@ -6,24 +6,19 @@ class LocalParamsExpression extends Expression { - /** - * @var ExpressionInterface|string - */ + /** @var ExpressionInterface|string */ private $type; - /** - * @var array - */ + /** @var array */ private $params; - /** - * @var bool - */ + /** @var bool */ private $shortForm; /** * @param ExpressionInterface|string $type * @param mixed[] $params + * @no-named-arguments */ public function __construct($type, array $params = [], bool $shortForm = true) { diff --git a/src/InterNations/Component/Solr/Expression/ParameterExpression.php b/src/InterNations/Component/Solr/Expression/ParameterExpression.php index e6ca89d..e43c674 100644 --- a/src/InterNations/Component/Solr/Expression/ParameterExpression.php +++ b/src/InterNations/Component/Solr/Expression/ParameterExpression.php @@ -5,12 +5,13 @@ class ParameterExpression extends Expression { - /** - * @var array - */ + /** @var array */ private $parameters; - /** @param mixed[] $parameters */ + /** + * @param mixed[] $parameters + * @no-named-arguments + */ public function __construct(array $parameters) { $this->parameters = $parameters; @@ -26,6 +27,7 @@ public function __toString(): string /** * @param mixed $value * @return PhraseExpression|mixed + * @no-named-arguments */ private function replaceNull($value) { diff --git a/src/InterNations/Component/Solr/Expression/ProximityExpression.php b/src/InterNations/Component/Solr/Expression/ProximityExpression.php index 7089a5b..bff69e3 100644 --- a/src/InterNations/Component/Solr/Expression/ProximityExpression.php +++ b/src/InterNations/Component/Solr/Expression/ProximityExpression.php @@ -10,9 +10,7 @@ */ class ProximityExpression extends Expression { - /** - * @var array - */ + /** @var array */ private $words; /** @@ -26,6 +24,7 @@ class ProximityExpression extends Expression * Create new proximity query object * * @param string[] $words + * @no-named-arguments */ public function __construct(array $words, int $proximity) { diff --git a/src/InterNations/Component/Solr/Expression/RangeExpression.php b/src/InterNations/Component/Solr/Expression/RangeExpression.php index 1ff45da..f941f27 100644 --- a/src/InterNations/Component/Solr/Expression/RangeExpression.php +++ b/src/InterNations/Component/Solr/Expression/RangeExpression.php @@ -37,6 +37,7 @@ class RangeExpression extends Expression * * @param string|int|Expression $start * @param string|int|Expression $end + * @no-named-arguments */ public function __construct($start = null, $end = null, bool $inclusive = true) { @@ -59,6 +60,7 @@ public function __toString(): string /** * @param ExpressionInterface|string|null $value * @return ExpressionInterface|string + * @no-named-arguments */ private function cast($value) { diff --git a/src/InterNations/Component/Solr/Expression/WildcardExpression.php b/src/InterNations/Component/Solr/Expression/WildcardExpression.php index c55e07d..6839bf1 100644 --- a/src/InterNations/Component/Solr/Expression/WildcardExpression.php +++ b/src/InterNations/Component/Solr/Expression/WildcardExpression.php @@ -38,6 +38,7 @@ class WildcardExpression extends Expression * * @param ExpressionInterface|string $prefix * @param ExpressionInterface|string $suffix + * @no-named-arguments */ public function __construct(string $wildcard, $prefix = '', $suffix = '') { diff --git a/src/InterNations/Component/Solr/Query/QueryString.php b/src/InterNations/Component/Solr/Query/QueryString.php index 634a951..214b0de 100644 --- a/src/InterNations/Component/Solr/Query/QueryString.php +++ b/src/InterNations/Component/Solr/Query/QueryString.php @@ -8,16 +8,13 @@ class QueryString { - /** - * @var string - */ + /** @var string */ private $query; - /** - * @var array - */ + /** @var array */ private $placeholders = []; + /** @no-named-arguments */ public function __construct(string $query) { $this->query = $query; @@ -27,6 +24,7 @@ public function __construct(string $query) * Add a value for a placeholder * * @param mixed $value + * @no-named-arguments */ public function setPlaceholder(string $placeholder, $value): self { @@ -39,6 +37,7 @@ public function setPlaceholder(string $placeholder, $value): self * Add values for several placeholders as key => value pairs * * @param mixed[] $placeholders + * @no-named-arguments */ public function setPlaceholders(array $placeholders): self { From ec964fcaa0baa0502c44adcdc096bcc0e5faa373 Mon Sep 17 00:00:00 2001 From: Malvika Chauhan Date: Thu, 10 Mar 2022 09:54:42 +0100 Subject: [PATCH 14/15] Fixing coding style --- .../Solr/Expression/BooleanExpression.php | 2 +- .../Solr/Expression/BoostExpression.php | 2 +- .../Solr/Expression/CompositeExpression.php | 4 +- .../Solr/Expression/DateTimeExpression.php | 2 +- .../Exception/InvalidArgumentException.php | 14 +-- .../Component/Solr/Expression/Expression.php | 4 +- .../Solr/Expression/ExpressionBuilder.php | 102 +++++++++--------- .../Solr/Expression/FieldExpression.php | 2 +- .../Solr/Expression/FunctionExpression.php | 2 +- .../Solr/Expression/FuzzyExpression.php | 2 +- .../Solr/Expression/GeofiltExpression.php | 2 +- .../Solr/Expression/GeolocationExpression.php | 2 +- .../Solr/Expression/LocalParamsExpression.php | 2 +- .../Solr/Expression/ParameterExpression.php | 8 +- .../Solr/Expression/ProximityExpression.php | 2 +- .../Solr/Expression/RangeExpression.php | 4 +- .../Solr/Expression/WildcardExpression.php | 2 +- .../Component/Solr/Query/QueryString.php | 6 +- 18 files changed, 82 insertions(+), 82 deletions(-) diff --git a/src/InterNations/Component/Solr/Expression/BooleanExpression.php b/src/InterNations/Component/Solr/Expression/BooleanExpression.php index 9718edc..6291f43 100644 --- a/src/InterNations/Component/Solr/Expression/BooleanExpression.php +++ b/src/InterNations/Component/Solr/Expression/BooleanExpression.php @@ -33,7 +33,7 @@ class BooleanExpression extends Expression * * @param ExpressionInterface|string $expr * @param bool $useNotNotation use the NOT notation: (*:* NOT ), e.g. (*:* NOT fieldName:*) - * @no-named-arguments + * @no-named-arguments */ public function __construct(string $operator, $expr, bool $useNotNotation = false) { diff --git a/src/InterNations/Component/Solr/Expression/BoostExpression.php b/src/InterNations/Component/Solr/Expression/BoostExpression.php index 5e863d4..3a5c39d 100644 --- a/src/InterNations/Component/Solr/Expression/BoostExpression.php +++ b/src/InterNations/Component/Solr/Expression/BoostExpression.php @@ -20,7 +20,7 @@ class BoostExpression extends Expression /** * @param ExpressionInterface|string|null $expr - * @no-named-arguments + * @no-named-arguments */ public function __construct(float $boost, $expr) { diff --git a/src/InterNations/Component/Solr/Expression/CompositeExpression.php b/src/InterNations/Component/Solr/Expression/CompositeExpression.php index ab90029..cb15ab1 100644 --- a/src/InterNations/Component/Solr/Expression/CompositeExpression.php +++ b/src/InterNations/Component/Solr/Expression/CompositeExpression.php @@ -28,7 +28,7 @@ class CompositeExpression extends Expression * Create new group of expression * * @param mixed[] $expressions - * @no-named-arguments + * @no-named-arguments */ public function __construct(array $expressions, ?string $type = self::TYPE_SPACE) { @@ -61,7 +61,7 @@ public function __toString(): string return implode($glue, array_filter($parts)); } - /** @no-named-arguments */ + /** @no-named-arguments */ public static function isValidType(?string $type): bool { return $type === static::TYPE_OR diff --git a/src/InterNations/Component/Solr/Expression/DateTimeExpression.php b/src/InterNations/Component/Solr/Expression/DateTimeExpression.php index 21d9905..500b8da 100644 --- a/src/InterNations/Component/Solr/Expression/DateTimeExpression.php +++ b/src/InterNations/Component/Solr/Expression/DateTimeExpression.php @@ -24,7 +24,7 @@ class DateTimeExpression extends Expression /** * @param string|DateTimeZone $timezone - * @no-named-arguments + * @no-named-arguments */ public function __construct(DateTime $date, ?string $format = null, $timezone = 'UTC') { diff --git a/src/InterNations/Component/Solr/Expression/Exception/InvalidArgumentException.php b/src/InterNations/Component/Solr/Expression/Exception/InvalidArgumentException.php index 3a0dfbf..79872ea 100644 --- a/src/InterNations/Component/Solr/Expression/Exception/InvalidArgumentException.php +++ b/src/InterNations/Component/Solr/Expression/Exception/InvalidArgumentException.php @@ -8,7 +8,7 @@ class InvalidArgumentException extends BaseInvalidArgumentException implements E /** * @param string|array $expectation * @param mixed $actual - * @no-named-arguments + * @no-named-arguments */ public static function invalidArgument(int $position, string $name, $expectation, $actual): self { @@ -26,9 +26,9 @@ public static function invalidArgument(int $position, string $name, $expectation } /** - * @param string[] $expectations - * @no-named-arguments - */ + * @param string[] $expectations + * @no-named-arguments + */ private static function formatExpectations(array $expectations): string { $last = array_pop($expectations); @@ -41,9 +41,9 @@ private static function formatExpectations(array $expectations): string } /** - * @param mixed $actual - * @no-named-arguments - */ + * @param mixed $actual + * @no-named-arguments + */ private static function getType($actual): string { return is_object($actual) ? get_class($actual) : gettype($actual); diff --git a/src/InterNations/Component/Solr/Expression/Expression.php b/src/InterNations/Component/Solr/Expression/Expression.php index 6206794..f1cc121 100644 --- a/src/InterNations/Component/Solr/Expression/Expression.php +++ b/src/InterNations/Component/Solr/Expression/Expression.php @@ -22,14 +22,14 @@ class Expression implements ExpressionInterface * Create new expression object * * @param ExpressionInterface|string $expr - * @no-named-arguments + * @no-named-arguments */ public function __construct($expr) { $this->expr = $expr; } - /** @no-named-arguments */ + /** @no-named-arguments */ public function isEqual(string $expr): bool { return $expr === (string) $this; diff --git a/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php b/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php index 1e56e74..66f8efe 100644 --- a/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php +++ b/src/InterNations/Component/Solr/Expression/ExpressionBuilder.php @@ -20,7 +20,7 @@ class ExpressionBuilder * * @param DateTimeZone|string $timezone * @throws InvalidArgumentException - * @no-named-arguments + * @no-named-arguments */ public function setDefaultTimezone($timezone): void { @@ -35,7 +35,7 @@ public function setDefaultTimezone($timezone): void * Create term expression: * * @param ExpressionInterface|string|null $expr - * @no-named-arguments + * @no-named-arguments */ public function eq($expr): ?ExpressionInterface { @@ -56,7 +56,7 @@ public function eq($expr): ?ExpressionInterface * * @param ExpressionInterface|string $field * @param ExpressionInterface|string|array $expr - * @no-named-arguments + * @no-named-arguments */ public function field($field, $expr): ?ExpressionInterface { @@ -71,7 +71,7 @@ public function field($field, $expr): ?ExpressionInterface /** * Create phrase expression: "term1 term2" - * @no-named-arguments + * @no-named-arguments */ public function phrase(?string $str): ?ExpressionInterface { @@ -86,7 +86,7 @@ public function phrase(?string $str): ?ExpressionInterface * Create boost expression: ^ * * @param ExpressionInterface|string|null $expr - * @no-named-arguments + * @no-named-arguments */ public function boost($expr, ?float $boost): ?ExpressionInterface { @@ -102,7 +102,7 @@ public function boost($expr, ?float $boost): ?ExpressionInterface * * @param ExpressionInterface|string $word * @param int|mixed $proximity - * @no-named-arguments + * @no-named-arguments */ public function prx($word = null, $proximity = null): ?ExpressionInterface { @@ -123,7 +123,7 @@ public function prx($word = null, $proximity = null): ?ExpressionInterface * * @param ExpressionInterface|string|null $expr * @param float $similarity Similarity between 0.0 und 1.0 - * @no-named-arguments + * @no-named-arguments */ public function fzz($expr, ?float $similarity = null): ?ExpressionInterface { @@ -139,7 +139,7 @@ public function fzz($expr, ?float $similarity = null): ?ExpressionInterface * * @param string|int|float|ExpressionInterface $start * @param string|int|float|ExpressionInterface $end - * @no-named-arguments + * @no-named-arguments */ public function range($start = null, $end = null, bool $inclusive = true): ExpressionInterface { @@ -151,7 +151,7 @@ public function range($start = null, $end = null, bool $inclusive = true): Expre * * @param string|int|float|ExpressionInterface $start * @param string|int|float|ExpressionInterface $end - * @no-named-arguments + * @no-named-arguments */ public function btwnRange($start = null, $end = null): ExpressionInterface { @@ -163,7 +163,7 @@ public function btwnRange($start = null, $end = null): ExpressionInterface * * @param ExpressionInterface|string $prefix * @param ExpressionInterface|string $suffix - * @no-named-arguments + * @no-named-arguments */ public function wild($prefix, ?string $wildcard = '?', $suffix = null): ?ExpressionInterface { @@ -178,7 +178,7 @@ public function wild($prefix, ?string $wildcard = '?', $suffix = null): ?Express * Create bool, required expression: + * * @param ExpressionInterface|string|null $expr - * @no-named-arguments + * @no-named-arguments */ public function req($expr): ?ExpressionInterface { @@ -194,7 +194,7 @@ public function req($expr): ?ExpressionInterface * * @param ExpressionInterface|string|null $expr * @return ExpressionInterface|null - * @no-named-arguments + * @no-named-arguments */ public function prhb($expr) { @@ -211,7 +211,7 @@ public function prhb($expr) * * @param ExpressionInterface|string|null $expr * @return ExpressionInterface|null - * @no-named-arguments + * @no-named-arguments */ public function not($expr) { @@ -231,7 +231,7 @@ public function not($expr) * * @param ExpressionInterface|string|null $expr * @return ExpressionInterface|string|null - * @no-named-arguments + * @no-named-arguments */ public function bool($expr, ?bool $operator = null) { @@ -250,7 +250,7 @@ public function bool($expr, ?bool $operator = null) * Return string treated as literal (unescaped, unquoted) * * @param ExpressionInterface|string|null $expr - * @no-named-arguments + * @no-named-arguments */ public function lit($expr): ?ExpressionInterface { @@ -266,7 +266,7 @@ public function lit($expr): ?ExpressionInterface * * @param ExpressionInterface|string|null $expr * @param string|mixed $type - * @no-named-arguments + * @no-named-arguments */ public function grp($expr = null, $type = CompositeExpression::TYPE_SPACE): ?ExpressionInterface { @@ -283,7 +283,7 @@ public function grp($expr = null, $type = CompositeExpression::TYPE_SPACE): ?Exp * Create AND grouped expression: ( AND AND ) * * @param ExpressionInterface[]|string[] $args - * @no-named-arguments + * @no-named-arguments */ public function andX(...$args): ?ExpressionInterface { @@ -300,7 +300,7 @@ public function andX(...$args): ?ExpressionInterface * Create OR grouped expression: ( OR OR ) * * @param ExpressionInterface[]|string[] $args - * @no-named-arguments + * @no-named-arguments */ public function orX(...$args): ?ExpressionInterface { @@ -318,7 +318,7 @@ public function orX(...$args): ?ExpressionInterface * * @param ExpressionInterface|string|null $expr * @return ExpressionInterface|mixed - * @no-named-arguments + * @no-named-arguments */ public function all($expr = null) { @@ -333,7 +333,7 @@ public function all($expr = null) * Create a date expression for a specific day * * @param DateTime|mixed $date - * @no-named-arguments + * @no-named-arguments */ public function day($date = null): ?ExpressionInterface { @@ -348,7 +348,7 @@ public function day($date = null): ?ExpressionInterface * Expression for the start of the given date * * @param bool|string $timezone - * @no-named-arguments + * @no-named-arguments */ public function startOfDay(?DateTime $date = null, $timezone = false): ?ExpressionInterface { @@ -367,7 +367,7 @@ public function startOfDay(?DateTime $date = null, $timezone = false): ?Expressi * Expression for the end of the given date * * @param bool|string $timezone - * @no-named-arguments + * @no-named-arguments */ public function endOfDay(?DateTime $date = null, $timezone = false): ?ExpressionInterface { @@ -383,9 +383,9 @@ public function endOfDay(?DateTime $date = null, $timezone = false): ?Expression } /** - * @param bool|string $timezone - * @no-named-arguments - */ + * @param bool|string $timezone + * @no-named-arguments + */ public function date(?DateTime $date = null, $timezone = false): ExpressionInterface { if ($date === null) { @@ -403,7 +403,7 @@ public function date(?DateTime $date = null, $timezone = false): ExpressionInter * Create a range between two dates (one side may be unlimited which is indicated by passing null) * * @param bool|string $timezone - * @no-named-arguments + * @no-named-arguments */ public function dateRange( ?DateTime $from = null, @@ -429,7 +429,7 @@ public function dateRange( * You can either pass an array of parameters, a single parameter or a ParameterExpression * * @param array|ExpressionInterface|string|null $parameters - * @no-named-arguments + * @no-named-arguments */ public function func(string $function, $parameters = null): ExpressionInterface { @@ -440,7 +440,7 @@ public function func(string $function, $parameters = null): ExpressionInterface * Create a function parameters expression * * @param mixed $parameters - * @no-named-arguments + * @no-named-arguments */ public function params(...$parameters): ExpressionInterface { @@ -452,7 +452,7 @@ public function params(...$parameters): ExpressionInterface /** * @param mixed[]|mixed $params * @param bool|mixed $shortForm - * @no-named-arguments + * @no-named-arguments */ public function localParams(string $type, $params = [], $shortForm = true): ?ExpressionInterface { @@ -474,9 +474,9 @@ public function localParams(string $type, $params = [], $shortForm = true): ?Exp } /** - * @param mixed[] $additionalParams - * @no-named-arguments - */ + * @param mixed[] $additionalParams + * @no-named-arguments + */ public function geofilt( string $field, ?GeolocationExpression $geolocation = null, @@ -491,7 +491,7 @@ public function geofilt( * Create composite expression: * * @param ExpressionInterface|string|null $expr - * @no-named-arguments + * @no-named-arguments */ public function comp($expr = null, ?string $type = CompositeExpression::TYPE_SPACE): ?ExpressionInterface { @@ -506,7 +506,7 @@ public function comp($expr = null, ?string $type = CompositeExpression::TYPE_SPA /** * Create a geo location expression: "," using the given precision - * @no-named-arguments + * @no-named-arguments */ public function latLong(float $latitude, float $longitude, int $precision = 12): ExpressionInterface { @@ -514,9 +514,9 @@ public function latLong(float $latitude, float $longitude, int $precision = 12): } /** - * @param ExpressionInterface|string|null $expr - * @no-named-arguments - */ + * @param ExpressionInterface|string|null $expr + * @no-named-arguments + */ public function noCache($expr = null): ?ExpressionInterface { if ($this->ignore($expr)) { @@ -527,9 +527,9 @@ public function noCache($expr = null): ?ExpressionInterface } /** - * @param ExpressionInterface|string|null $expr - * @no-named-arguments - */ + * @param ExpressionInterface|string|null $expr + * @no-named-arguments + */ public function tag(string $tagName, $expr = null): ?ExpressionInterface { if ($this->ignore($expr)) { @@ -540,9 +540,9 @@ public function tag(string $tagName, $expr = null): ?ExpressionInterface } /** - * @param ExpressionInterface|string|null $expr - * @no-named-arguments - */ + * @param ExpressionInterface|string|null $expr + * @no-named-arguments + */ public function excludeTag(string $tagName, $expr = null): ?ExpressionInterface { if ($this->ignore($expr)) { @@ -555,7 +555,7 @@ public function excludeTag(string $tagName, $expr = null): ?ExpressionInterface /** * @param ExpressionInterface|string $tag * @param mixed $value - * @no-named-arguments + * @no-named-arguments */ private function shortLocalParams($tag, $value): LocalParamsExpression { @@ -565,7 +565,7 @@ private function shortLocalParams($tag, $value): LocalParamsExpression /** * @param mixed[] $args * @return mixed[] - * @no-named-arguments + * @no-named-arguments */ private function parseCompositeArgs(array $args): array { @@ -586,18 +586,18 @@ private function parseCompositeArgs(array $args): array } /** - * @param mixed $expr - * @no-named-arguments - */ + * @param mixed $expr + * @no-named-arguments + */ private function ignore($expr): bool { return $expr === null || (is_string($expr) && trim($expr) === ''); } /** - * @param mixed $expr - * @no-named-arguments - */ + * @param mixed $expr + * @no-named-arguments + */ private function permit($expr): bool { return !$this->ignore($expr); diff --git a/src/InterNations/Component/Solr/Expression/FieldExpression.php b/src/InterNations/Component/Solr/Expression/FieldExpression.php index 4997351..3a4b8b1 100644 --- a/src/InterNations/Component/Solr/Expression/FieldExpression.php +++ b/src/InterNations/Component/Solr/Expression/FieldExpression.php @@ -23,7 +23,7 @@ class FieldExpression extends Expression * * @param ExpressionInterface|string $field * @param ExpressionInterface|string $expr - * @no-named-arguments + * @no-named-arguments */ public function __construct($field, $expr) { diff --git a/src/InterNations/Component/Solr/Expression/FunctionExpression.php b/src/InterNations/Component/Solr/Expression/FunctionExpression.php index 466952a..0e34f15 100644 --- a/src/InterNations/Component/Solr/Expression/FunctionExpression.php +++ b/src/InterNations/Component/Solr/Expression/FunctionExpression.php @@ -14,7 +14,7 @@ class FunctionExpression extends Expression /** * @param ExpressionInterface|string $function * @param ExpressionInterface|array|null $parameters - * @no-named-arguments + * @no-named-arguments */ public function __construct($function, $parameters = null) { diff --git a/src/InterNations/Component/Solr/Expression/FuzzyExpression.php b/src/InterNations/Component/Solr/Expression/FuzzyExpression.php index f3cbd95..58bdcc0 100644 --- a/src/InterNations/Component/Solr/Expression/FuzzyExpression.php +++ b/src/InterNations/Component/Solr/Expression/FuzzyExpression.php @@ -20,7 +20,7 @@ class FuzzyExpression extends Expression * Create new fuzzy query object * * @param ExpressionInterface|string $expr - * @no-named-arguments + * @no-named-arguments */ public function __construct($expr, ?float $similarity = null) { diff --git a/src/InterNations/Component/Solr/Expression/GeofiltExpression.php b/src/InterNations/Component/Solr/Expression/GeofiltExpression.php index a624577..0a0bd42 100644 --- a/src/InterNations/Component/Solr/Expression/GeofiltExpression.php +++ b/src/InterNations/Component/Solr/Expression/GeofiltExpression.php @@ -10,7 +10,7 @@ class GeofiltExpression extends Expression /** * @param mixed[] $additionalParams - * @no-named-arguments + * @no-named-arguments */ public function __construct( string $field, diff --git a/src/InterNations/Component/Solr/Expression/GeolocationExpression.php b/src/InterNations/Component/Solr/Expression/GeolocationExpression.php index c626766..888b36a 100644 --- a/src/InterNations/Component/Solr/Expression/GeolocationExpression.php +++ b/src/InterNations/Component/Solr/Expression/GeolocationExpression.php @@ -7,7 +7,7 @@ class GeolocationExpression extends Expression private $longitude; private $precision; - /** @no-named-arguments */ + /** @no-named-arguments */ public function __construct(float $latitude, float $longitude, int $precision) { $this->latitude = $latitude; diff --git a/src/InterNations/Component/Solr/Expression/LocalParamsExpression.php b/src/InterNations/Component/Solr/Expression/LocalParamsExpression.php index b86b8c5..8a451a2 100644 --- a/src/InterNations/Component/Solr/Expression/LocalParamsExpression.php +++ b/src/InterNations/Component/Solr/Expression/LocalParamsExpression.php @@ -18,7 +18,7 @@ class LocalParamsExpression extends Expression /** * @param ExpressionInterface|string $type * @param mixed[] $params - * @no-named-arguments + * @no-named-arguments */ public function __construct($type, array $params = [], bool $shortForm = true) { diff --git a/src/InterNations/Component/Solr/Expression/ParameterExpression.php b/src/InterNations/Component/Solr/Expression/ParameterExpression.php index e43c674..948eef5 100644 --- a/src/InterNations/Component/Solr/Expression/ParameterExpression.php +++ b/src/InterNations/Component/Solr/Expression/ParameterExpression.php @@ -9,9 +9,9 @@ class ParameterExpression extends Expression private $parameters; /** - * @param mixed[] $parameters - * @no-named-arguments - */ + * @param mixed[] $parameters + * @no-named-arguments + */ public function __construct(array $parameters) { $this->parameters = $parameters; @@ -27,7 +27,7 @@ public function __toString(): string /** * @param mixed $value * @return PhraseExpression|mixed - * @no-named-arguments + * @no-named-arguments */ private function replaceNull($value) { diff --git a/src/InterNations/Component/Solr/Expression/ProximityExpression.php b/src/InterNations/Component/Solr/Expression/ProximityExpression.php index bff69e3..e71268a 100644 --- a/src/InterNations/Component/Solr/Expression/ProximityExpression.php +++ b/src/InterNations/Component/Solr/Expression/ProximityExpression.php @@ -24,7 +24,7 @@ class ProximityExpression extends Expression * Create new proximity query object * * @param string[] $words - * @no-named-arguments + * @no-named-arguments */ public function __construct(array $words, int $proximity) { diff --git a/src/InterNations/Component/Solr/Expression/RangeExpression.php b/src/InterNations/Component/Solr/Expression/RangeExpression.php index f941f27..cd58783 100644 --- a/src/InterNations/Component/Solr/Expression/RangeExpression.php +++ b/src/InterNations/Component/Solr/Expression/RangeExpression.php @@ -37,7 +37,7 @@ class RangeExpression extends Expression * * @param string|int|Expression $start * @param string|int|Expression $end - * @no-named-arguments + * @no-named-arguments */ public function __construct($start = null, $end = null, bool $inclusive = true) { @@ -60,7 +60,7 @@ public function __toString(): string /** * @param ExpressionInterface|string|null $value * @return ExpressionInterface|string - * @no-named-arguments + * @no-named-arguments */ private function cast($value) { diff --git a/src/InterNations/Component/Solr/Expression/WildcardExpression.php b/src/InterNations/Component/Solr/Expression/WildcardExpression.php index 6839bf1..6a35c94 100644 --- a/src/InterNations/Component/Solr/Expression/WildcardExpression.php +++ b/src/InterNations/Component/Solr/Expression/WildcardExpression.php @@ -38,7 +38,7 @@ class WildcardExpression extends Expression * * @param ExpressionInterface|string $prefix * @param ExpressionInterface|string $suffix - * @no-named-arguments + * @no-named-arguments */ public function __construct(string $wildcard, $prefix = '', $suffix = '') { diff --git a/src/InterNations/Component/Solr/Query/QueryString.php b/src/InterNations/Component/Solr/Query/QueryString.php index 214b0de..2515a84 100644 --- a/src/InterNations/Component/Solr/Query/QueryString.php +++ b/src/InterNations/Component/Solr/Query/QueryString.php @@ -14,7 +14,7 @@ class QueryString /** @var array */ private $placeholders = []; - /** @no-named-arguments */ + /** @no-named-arguments */ public function __construct(string $query) { $this->query = $query; @@ -24,7 +24,7 @@ public function __construct(string $query) * Add a value for a placeholder * * @param mixed $value - * @no-named-arguments + * @no-named-arguments */ public function setPlaceholder(string $placeholder, $value): self { @@ -37,7 +37,7 @@ public function setPlaceholder(string $placeholder, $value): self * Add values for several placeholders as key => value pairs * * @param mixed[] $placeholders - * @no-named-arguments + * @no-named-arguments */ public function setPlaceholders(array $placeholders): self { From c2feef6f252b7f96ff18855c4976eb3ce3f1745d Mon Sep 17 00:00:00 2001 From: Lars Strojny Date: Wed, 16 Mar 2022 11:21:41 +0100 Subject: [PATCH 15/15] Add test to make sure that the @no-named-arguments annotation is always there --- .../Component/Solr/AnnotationsTest.php | 58 +++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 tests/InterNations/Component/Solr/AnnotationsTest.php diff --git a/tests/InterNations/Component/Solr/AnnotationsTest.php b/tests/InterNations/Component/Solr/AnnotationsTest.php new file mode 100644 index 0000000..ac6c3b1 --- /dev/null +++ b/tests/InterNations/Component/Solr/AnnotationsTest.php @@ -0,0 +1,58 @@ +getFilesAsArray(__DIR__ . '/../../../../src', '.php') + ); + + return array_map( + static function (string $class) { + return [$class]; + }, + array_filter( + get_declared_classes(), + static function (string $class) { + return strpos($class, 'InterNations\\Component\\Solr\\') === 0 + && strpos($class, 'InterNations\\Component\\Solr\\Tests\\') === false; + } + ) + ); + } + + /** @dataProvider getClasses */ + public function testOptOutOfNamedArgumentSupportIsInPlace(string $className): void + { + $class = new ReflectionClass($className); + foreach ($class->getMethods(ReflectionMethod::IS_PUBLIC) as $method) { + if (count($method->getParameters()) > 0 && $method->getDeclaringClass()->getName() === $className) { + self::assertStringContainsString( + '@no-named-arguments', + $method->getDocComment(), + sprintf( + 'Expected "%s::%s()" to have annotation @no-named-arguments', + $method->getDeclaringClass()->getName(), + $method->getName() + ) + ); + } + } + $this->addToAssertionCount(1); + } +}