Merge pull request #255 from gsteel/v2/soft-final-everywhere

Mark all classes as soft `@final` where possible

psalm-baseline.xml

@@ -16,14 +16,6 @@
     </MixedArgument>
   </file>
   <file src="src/AbstractValidator.php">
-    <LessSpecificReturnStatement>
-      <code><![CDATA[$this]]></code>
-      <code><![CDATA[$this]]></code>
-      <code><![CDATA[$this]]></code>
-      <code><![CDATA[$this]]></code>
-      <code><![CDATA[$this]]></code>
-      <code><![CDATA[$this]]></code>
-    </LessSpecificReturnStatement>
     <MixedArgumentTypeCoercion>
       <code><![CDATA[$value]]></code>
     </MixedArgumentTypeCoercion>
@@ -367,15 +359,6 @@
     </PossiblyUnusedMethod>
   </file>
   <file src="src/Bitwise.php">
-    <DocblockTypeContradiction>
-      <code><![CDATA[self::OP_AND === $this->operator]]></code>
-      <code><![CDATA[self::OP_AND === $this->operator]]></code>
-      <code><![CDATA[self::OP_XOR === $this->operator]]></code>
-      <code><![CDATA[self::OP_XOR === $this->operator]]></code>
-    </DocblockTypeContradiction>
-    <InvalidPropertyAssignmentValue>
-      <code><![CDATA[$operator]]></code>
-    </InvalidPropertyAssignmentValue>
     <MixedAssignment>
       <code><![CDATA[$temp['control']]]></code>
       <code><![CDATA[$temp['operator']]]></code>
@@ -474,6 +457,9 @@
       <code><![CDATA[is_array($options)]]></code>
       <code><![CDATA[null === $this->session]]></code>
     </DocblockTypeContradiction>
+    <ImpureByReferenceAssignment>
+      <code><![CDATA[$session->tokenList]]></code>
+    </ImpureByReferenceAssignment>
     <MixedArgument>
       <code><![CDATA[$key]]></code>
       <code><![CDATA[$session->tokenList[$tokenId]]]></code>
@@ -1657,9 +1643,6 @@
     </RedundantCastGivenDocblockType>
   </file>
   <file src="src/Ip.php">
-    <LessSpecificImplementedReturnType>
-      <code><![CDATA[AbstractValidator]]></code>
-    </LessSpecificImplementedReturnType>
     <MixedArgument>
       <code><![CDATA[$regex]]></code>
       <code><![CDATA[$regex]]></code>
@@ -1803,25 +1786,14 @@
     <DocblockTypeContradiction>
       <code><![CDATA[is_array($options)]]></code>
     </DocblockTypeContradiction>
-    <InvalidArgument>
-      <code><![CDATA[$value]]></code>
-    </InvalidArgument>
     <MixedArgument>
-      <code><![CDATA[$this->baseValue]]></code>
-      <code><![CDATA[$this->step]]></code>
+      <code><![CDATA[$options['baseValue']]]></code>
+      <code><![CDATA[$options['step']]]></code>
     </MixedArgument>
     <MixedAssignment>
       <code><![CDATA[$temp['baseValue']]]></code>
       <code><![CDATA[$temp['step']]]></code>
     </MixedAssignment>
-    <MixedInferredReturnType>
-      <code><![CDATA[string]]></code>
-      <code><![CDATA[string]]></code>
-    </MixedInferredReturnType>
-    <MixedReturnStatement>
-      <code><![CDATA[$this->baseValue]]></code>
-      <code><![CDATA[$this->step]]></code>
-    </MixedReturnStatement>
     <PossiblyInvalidArgument>
       <code><![CDATA[$options]]></code>
     </PossiblyInvalidArgument>

src/AbstractValidator.php

@@ -153,7 +153,7 @@ public function getOptions()
      * Sets one or multiple options
      *
      * @param  array<string, mixed>|Traversable<string, mixed> $options Options to set
-     * @return $this Provides fluid interface
+     * @return self Provides fluid interface
      * @throws Exception\InvalidArgumentException If $options is not an array or Traversable.
      */
     public function setOptions($options = [])

src/Barcode.php

@@ -17,6 +17,7 @@
 use function substr;
 use function ucfirst;
 
+/** @final */
 class Barcode extends AbstractValidator
 {
     public const INVALID        = 'barcodeInvalid';

src/Barcode/Codabar.php

@@ -5,6 +5,7 @@
 use function strpbrk;
 use function substr;
 
+/** @final */
 class Codabar extends AbstractAdapter
 {
     /**

src/Barcode/Code128.php

@@ -10,6 +10,7 @@
 use function is_string;
 use function ord;
 
+/** @final */
 class Code128 extends AbstractAdapter
 {
     /**

src/Barcode/Code25.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Code25 extends AbstractAdapter
 {
     /**

src/Barcode/Code25interleaved.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Code25interleaved extends AbstractAdapter
 {
     /**

src/Barcode/Code39.php

@@ -5,6 +5,7 @@
 use function str_split;
 use function substr;
 
+/** @final */
 class Code39 extends AbstractAdapter
 {
     /** @var array */

src/Barcode/Code39ext.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Code39ext extends AbstractAdapter
 {
     /**

src/Barcode/Code93.php

@@ -7,6 +7,7 @@
 use function str_split;
 use function substr;
 
+/** @final */
 class Code93 extends AbstractAdapter
 {
     /**

src/Barcode/Code93ext.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Code93ext extends AbstractAdapter
 {
     /**

src/Barcode/Ean12.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Ean12 extends AbstractAdapter
 {
     /**

src/Barcode/Ean13.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Ean13 extends AbstractAdapter
 {
     /**

src/Barcode/Ean14.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Ean14 extends AbstractAdapter
 {
     /**

src/Barcode/Ean18.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Ean18 extends AbstractAdapter
 {
     /**

src/Barcode/Ean2.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Ean2 extends AbstractAdapter
 {
     /**

src/Barcode/Ean5.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Ean5 extends AbstractAdapter
 {
     /**

src/Barcode/Ean8.php

@@ -4,6 +4,7 @@
 
 use function strlen;
 
+/** @final */
 class Ean8 extends AbstractAdapter
 {
     /**

src/Barcode/Gtin12.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Gtin12 extends AbstractAdapter
 {
     /**

src/Barcode/Gtin13.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Gtin13 extends AbstractAdapter
 {
     /**

src/Barcode/Gtin14.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Gtin14 extends AbstractAdapter
 {
     /**

src/Barcode/Identcode.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Identcode extends AbstractAdapter
 {
     /**

src/Barcode/Intelligentmail.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Intelligentmail extends AbstractAdapter
 {
     /**

src/Barcode/Issn.php

@@ -7,6 +7,7 @@
 use function strlen;
 use function substr;
 
+/** @final */
 class Issn extends AbstractAdapter
 {
     /**

src/Barcode/Itf14.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Itf14 extends AbstractAdapter
 {
     /**

src/Barcode/Leitcode.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Leitcode extends AbstractAdapter
 {
     /**

src/Barcode/Planet.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Planet extends AbstractAdapter
 {
     /**

src/Barcode/Postnet.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Postnet extends AbstractAdapter
 {
     /**

src/Barcode/Royalmail.php

@@ -9,6 +9,7 @@
 use function strlen;
 use function substr;
 
+/** @final */
 class Royalmail extends AbstractAdapter
 {
     /** @var array<array-key, int> */

src/Barcode/Sscc.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Sscc extends AbstractAdapter
 {
     /**

src/Barcode/Upca.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator\Barcode;
 
+/** @final */
 class Upca extends AbstractAdapter
 {
     /**

src/Barcode/Upce.php

@@ -4,6 +4,7 @@
 
 use function strlen;
 
+/** @final */
 class Upce extends AbstractAdapter
 {
     /**

src/Between.php

@@ -14,6 +14,7 @@
 
 use const PHP_INT_MAX;
 
+/** @final */
 class Between extends AbstractValidator
 {
     public const NOT_BETWEEN        = 'notBetween';

src/Bitwise.php

@@ -9,6 +9,7 @@
 use function is_array;
 use function iterator_to_array;
 
+/** @final */
 class Bitwise extends AbstractValidator
 {
     public const OP_AND = 'and';
@@ -43,7 +44,7 @@ class Bitwise extends AbstractValidator
         'control' => 'control',
     ];
 
-    /** @var null|int */
+    /** @var null|string */
     protected $operator;
 
     /** @var bool */
@@ -96,7 +97,7 @@ public function getControl()
     /**
      * Returns the operator parameter.
      *
-     * @return null|int
+     * @return null|string
      */
     public function getOperator()
     {

src/BusinessIdentifierCode.php

@@ -7,6 +7,7 @@
 use function preg_match;
 use function strtoupper;
 
+/** @final */
 class BusinessIdentifierCode extends AbstractValidator
 {
     public const INVALID           = 'valueNotBic';

src/Callback.php

@@ -21,6 +21,7 @@
  *     throwExceptions?: bool,
  *     ...<string, mixed>
  * }
+ * @final
  */
 class Callback extends AbstractValidator
 {

src/ConfigProvider.php

@@ -2,6 +2,7 @@
 
 namespace Laminas\Validator;
 
+/** @final */
 class ConfigProvider
 {
     /**

src/CreditCard.php

@@ -24,6 +24,7 @@
 use function strlen;
 use function strtoupper;
 
+/** @final */
 class CreditCard extends AbstractValidator
 {
     /**