Remove aggregation deprecations (#2138)

ruflin · Jan 3, 2023 · 96d21ee · 96d21ee
1 parent 83629ed
commit 96d21ee
Show file tree

Hide file tree

Showing 20 changed files with 48 additions and 520 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -41,6 +41,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   * `Elastica\Result::getType()`
   * `Elastica\Suggest\Phrase::addCandidateGenerator()` -> use `Elastica\Suggest\Phrase::addDirectGenerator()` instead
   * `Elastica\Util::getParamName()`
+* Changed following aggregation constructors [#2138](https://github.com/ruflin/Elastica/pull/2138)
+  * `Elastica\Aggregation\AvgBucket`: The second argument `$bucketsPath` is now mandatory
+  * `Elastica\Aggregation\BucketScript`: The second (`array $bucketsPath`) and the third (`string $script`) argument are now mandatory
+  * `Elastica\Aggregation\BucketSelector`: The second (`array $bucketsPath`) and the third (`string $script`) argument are now mandatory
+  * `Elastica\Aggregation\Derivative`: The second argument (`string $bucketsPath`) is now mandatory
+  * `Elastica\Aggregation\NormalizeAggregation`: The second (`string $bucketsPath`) and the third (`string $method`) argument are now mandatory
+  * `Elastica\Aggregation\PercentilesBucket`: The second argument (`string $bucketsPath`) is now mandatory
+  * `Elastica\Aggregation\SerialDiff`: The second argument (`string $bucketsPath`) is now mandatory
+  * `Elastica\Aggregation\StatsBucket`: The second argument (`string $bucketsPath`) is now mandatory
+  * `Elastica\Aggregation\SumBucket`: The second argument (`string $bucketsPath`) is now mandatory
+
 ### Added
 * Added support for PHP 8.2 [#2136](https://github.com/ruflin/Elastica/pull/2136)
 ### Changed

diff --git a/src/Aggregation/AvgBucket.php b/src/Aggregation/AvgBucket.php
@@ -2,8 +2,6 @@
 
 namespace Elastica\Aggregation;
 
-use Elastica\Exception\InvalidException;
-
 /**
  * Class AvgBucket.
  *
@@ -16,17 +14,11 @@ class AvgBucket extends AbstractAggregation implements GapPolicyInterface
 
     public const DEFAULT_FORMAT_VALUE = null;
 
-    public function __construct(string $name, ?string $bucketsPath = null)
+    public function __construct(string $name, string $bucketsPath)
     {
         parent::__construct($name);
 
-        if (null !== $bucketsPath) {
-            $this->setBucketsPath($bucketsPath);
-        } elseif (\func_num_args() >= 2) {
-            \trigger_deprecation('ruflin/elastica', '7.1.3', 'Passing null as 2nd argument to "%s()" is deprecated, pass a string instead. It will be removed in 8.0.', __METHOD__);
-        } else {
-            \trigger_deprecation('ruflin/elastica', '7.1.3', 'Not passing a 2nd argument to "%s()" is deprecated, pass a string instead. It will be removed in 8.0.', __METHOD__);
-        }
+        $this->setBucketsPath($bucketsPath);
     }
 
     /**
@@ -38,16 +30,4 @@ public function setFormat(?string $format = null): self
     {
         return $this->setParam('format', $format);
     }
-
-    /**
-     * @throws InvalidException If buckets path or script is not set
-     */
-    public function toArray(): array
-    {
-        if (!$this->hasParam('buckets_path')) {
-            throw new InvalidException('Buckets path is required');
-        }
-
-        return parent::toArray();
-    }
 }
diff --git a/src/Aggregation/BucketScript.php b/src/Aggregation/BucketScript.php
@@ -2,8 +2,6 @@
 
 namespace Elastica\Aggregation;
 
-use Elastica\Exception\InvalidException;
-
 /**
  * Class BucketScript.
  *
@@ -13,17 +11,12 @@ class BucketScript extends AbstractAggregation implements GapPolicyInterface
 {
     use Traits\GapPolicyTrait;
 
-    public function __construct(string $name, ?array $bucketsPath = null, ?string $script = null)
+    public function __construct(string $name, array $bucketsPath, string $script)
     {
         parent::__construct($name);
 
-        if (null !== $bucketsPath) {
-            $this->setBucketsPath($bucketsPath);
-        }
-
-        if (null !== $script) {
-            $this->setScript($script);
-        }
+        $this->setBucketsPath($bucketsPath);
+        $this->setScript($script);
     }
 
     /**
@@ -55,19 +48,4 @@ public function setFormat(?string $format = null): self
     {
         return $this->setParam('format', $format);
     }
-
-    /**
-     * @throws InvalidException If buckets path or script is not set
-     */
-    public function toArray(): array
-    {
-        if (!$this->hasParam('buckets_path')) {
-            throw new InvalidException('Buckets path is required');
-        }
-        if (!$this->hasParam('script')) {
-            throw new InvalidException('Script parameter is required');
-        }
-
-        return parent::toArray();
-    }
 }
diff --git a/src/Aggregation/BucketSelector.php b/src/Aggregation/BucketSelector.php
@@ -11,17 +11,12 @@ class BucketSelector extends AbstractSimpleAggregation implements GapPolicyInter
 {
     use Traits\GapPolicyTrait;
 
-    public function __construct(string $name, ?array $bucketsPath = null, ?string $script = null)
+    public function __construct(string $name, array $bucketsPath, string $script)
     {
         parent::__construct($name);
 
-        if (null !== $bucketsPath) {
-            $this->setBucketsPath($bucketsPath);
-        }
-
-        if (null !== $script) {
-            $this->setScript($script);
-        }
+        $this->setBucketsPath($bucketsPath);
+        $this->setScript($script);
     }
 
     /**

diff --git a/src/Aggregation/Derivative.php b/src/Aggregation/Derivative.php
@@ -2,8 +2,6 @@
 
 namespace Elastica\Aggregation;
 
-use Elastica\Exception\InvalidException;
-
 /**
  * Class Derivative.
  *
@@ -14,17 +12,11 @@ class Derivative extends AbstractAggregation implements GapPolicyInterface
     use Traits\BucketsPathTrait;
     use Traits\GapPolicyTrait;
 
-    public function __construct(string $name, ?string $bucketsPath = null)
+    public function __construct(string $name, string $bucketsPath)
     {
         parent::__construct($name);
 
-        if (null !== $bucketsPath) {
-            $this->setBucketsPath($bucketsPath);
-        } elseif (\func_num_args() >= 2) {
-            \trigger_deprecation('ruflin/elastica', '7.1.3', 'Passing null as 2nd argument to "%s()" is deprecated, pass a string instead. It will be removed in 8.0.', __METHOD__);
-        } else {
-            \trigger_deprecation('ruflin/elastica', '7.1.3', 'Not passing a 2nd argument to "%s()" is deprecated, pass a string instead. It will be removed in 8.0.', __METHOD__);
-        }
+        $this->setBucketsPath($bucketsPath);
     }
 
     /**
@@ -36,16 +28,4 @@ public function setFormat(string $format): self
     {
         return $this->setParam('format', $format);
     }
-
-    /**
-     * @throws InvalidException If buckets path or script is not set
-     */
-    public function toArray(): array
-    {
-        if (!$this->hasParam('buckets_path')) {
-            throw new InvalidException('Buckets path is required');
-        }
-
-        return parent::toArray();
-    }
 }
diff --git a/src/Aggregation/NormalizeAggregation.php b/src/Aggregation/NormalizeAggregation.php
@@ -2,8 +2,6 @@
 
 namespace Elastica\Aggregation;
 
-use Elastica\Exception\InvalidException;
-
 /**
  * Class NormalizeAggregation.
  *
@@ -13,25 +11,12 @@ class NormalizeAggregation extends AbstractAggregation
 {
     use Traits\BucketsPathTrait;
 
-    public function __construct(string $name, ?string $bucketsPath = null, ?string $method = null)
+    public function __construct(string $name, string $bucketsPath, string $method)
     {
         parent::__construct($name);
 
-        if (null !== $bucketsPath) {
-            $this->setBucketsPath($bucketsPath);
-        } elseif (\func_num_args() >= 2) {
-            \trigger_deprecation('ruflin/elastica', '7.1.3', 'Passing null as 2nd argument to "%s()" is deprecated, pass a string instead. It will be removed in 8.0.', __METHOD__);
-        } else {
-            \trigger_deprecation('ruflin/elastica', '7.1.3', 'Not passing a 2nd argument to "%s()" is deprecated, pass a string instead. It will be removed in 8.0.', __METHOD__);
-        }
-
-        if (null !== $method) {
-            $this->setMethod($method);
-        } elseif (\func_num_args() >= 3) {
-            \trigger_deprecation('ruflin/elastica', '7.1.3', 'Passing null as 3rd argument to "%s()" is deprecated, pass a string instead. It will be removed in 8.0.', __METHOD__);
-        } else {
-            \trigger_deprecation('ruflin/elastica', '7.1.3', 'Not passing a 3rd argument to "%s()" is deprecated, pass a string instead. It will be removed in 8.0.', __METHOD__);
-        }
+        $this->setBucketsPath($bucketsPath);
+        $this->setMethod($method);
     }
 
     /**
@@ -53,20 +38,4 @@ public function setFormat(string $format): self
     {
         return $this->setParam('format', $format);
     }
-
-    /**
-     * @throws InvalidException If buckets path or method are not set
-     */
-    public function toArray(): array
-    {
-        if (!$this->hasParam('buckets_path')) {
-            throw new InvalidException('Buckets path is required');
-        }
-
-        if (!$this->hasParam('method')) {
-            throw new InvalidException('Method parameter is required');
-        }
-
-        return parent::toArray();
-    }
 }
diff --git a/src/Aggregation/PercentilesBucket.php b/src/Aggregation/PercentilesBucket.php
@@ -2,8 +2,6 @@
 
 namespace Elastica\Aggregation;
 
-use Elastica\Exception\InvalidException;
-
 /**
  * Class PercentilesBucket.
  *
@@ -15,29 +13,11 @@ class PercentilesBucket extends AbstractAggregation implements GapPolicyInterfac
     use Traits\GapPolicyTrait;
     use Traits\KeyedTrait;
 
-    public function __construct(string $name, ?string $bucketsPath = null)
+    public function __construct(string $name, string $bucketsPath)
     {
         parent::__construct($name);
 
-        if (null !== $bucketsPath) {
-            $this->setBucketsPath($bucketsPath);
-        } elseif (\func_num_args() >= 2) {
-            \trigger_deprecation('ruflin/elastica', '7.1.3', 'Passing null as 2nd argument to "%s()" is deprecated, pass a string instead. It will be removed in 8.0.', __METHOD__);
-        } else {
-            \trigger_deprecation('ruflin/elastica', '7.1.3', 'Not passing a 2nd argument to "%s()" is deprecated, pass a string instead. It will be removed in 8.0.', __METHOD__);
-        }
-    }
-
-    /**
-     * @throws InvalidException If buckets path or script is not set
-     */
-    public function toArray(): array
-    {
-        if (!$this->hasParam('buckets_path')) {
-            throw new InvalidException('Buckets path is required');
-        }
-
-        return parent::toArray();
+        $this->setBucketsPath($bucketsPath);
     }
 
     /**

diff --git a/src/Aggregation/SerialDiff.php b/src/Aggregation/SerialDiff.php
@@ -2,8 +2,6 @@
 
 namespace Elastica\Aggregation;
 
-use Elastica\Exception\InvalidException;
-
 /**
  * Class SerialDiff.
  *
@@ -15,17 +13,11 @@ class SerialDiff extends AbstractAggregation implements GapPolicyInterface
 
     public const DEFAULT_GAP_POLICY_VALUE = GapPolicyInterface::INSERT_ZEROS;
 
-    public function __construct(string $name, ?string $bucketsPath = null)
+    public function __construct(string $name, string $bucketsPath)
     {
         parent::__construct($name);
 
-        if (null !== $bucketsPath) {
-            $this->setBucketsPath($bucketsPath);
-        } elseif (\func_num_args() >= 2) {
-            \trigger_deprecation('ruflin/elastica', '7.1.3', 'Passing null as 2nd argument to "%s()" is deprecated, pass a string instead. It will be removed in 8.0.', __METHOD__);
-        } else {
-            \trigger_deprecation('ruflin/elastica', '7.1.3', 'Not passing a 2nd argument to "%s()" is deprecated, pass a string instead. It will be removed in 8.0.', __METHOD__);
-        }
+        $this->setBucketsPath($bucketsPath);
     }
 
     /**
@@ -57,16 +49,4 @@ public function setFormat(?string $format = null): self
     {
         return $this->setParam('format', $format);
     }
-
-    /**
-     * @throws InvalidException If buckets path is not set
-     */
-    public function toArray(): array
-    {
-        if (!$this->hasParam('buckets_path')) {
-            throw new InvalidException('Buckets path is required');
-        }
-
-        return parent::toArray();
-    }
 }
diff --git a/src/Aggregation/StatsBucket.php b/src/Aggregation/StatsBucket.php
@@ -2,8 +2,6 @@
 
 namespace Elastica\Aggregation;
 
-use Elastica\Exception\InvalidException;
-
 /**
  * Class StatsBucket.
  *
@@ -14,17 +12,11 @@ class StatsBucket extends AbstractAggregation implements GapPolicyInterface
     use Traits\BucketsPathTrait;
     use Traits\GapPolicyTrait;
 
-    public function __construct(string $name, ?string $bucketsPath = null)
+    public function __construct(string $name, string $bucketsPath)
     {
         parent::__construct($name);
 
-        if (null !== $bucketsPath) {
-            $this->setBucketsPath($bucketsPath);
-        } elseif (\func_num_args() >= 2) {
-            \trigger_deprecation('ruflin/elastica', '7.1.3', 'Passing null as 2nd argument to "%s()" is deprecated, pass a string instead. It will be removed in 8.0.', __METHOD__);
-        } else {
-            \trigger_deprecation('ruflin/elastica', '7.1.3', 'Not passing a 2nd argument to "%s()" is deprecated, pass a string instead. It will be removed in 8.0.', __METHOD__);
-        }
+        $this->setBucketsPath($bucketsPath);
     }
 
     /**
@@ -36,16 +28,4 @@ public function setFormat(string $format): self
     {
         return $this->setParam('format', $format);
     }
-
-    /**
-     * @throws InvalidException If buckets path or script is not set
-     */
-    public function toArray(): array
-    {
-        if (!$this->hasParam('buckets_path')) {
-            throw new InvalidException('Buckets path is required');
-        }
-
-        return parent::toArray();
-    }
 }