Merge pull request #132 from gsteel/validator-update

Deprecate runtime mutation of validator options
laminas · Jul 15, 2024 · e1e3126 · e1e3126
2 parents d61fdd8 + 5990e03
commit e1e3126
Show file tree

Hide file tree

Showing 8 changed files with 135 additions and 45 deletions.
diff --git a/composer.lock b/composer.lock
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -484,21 +484,41 @@
     </MixedAssignment>
   </file>
   <file src="src/Validator/Alnum.php">
+    <DeprecatedMethod>
+      <code><![CDATA[getAllowWhiteSpace]]></code>
+    </DeprecatedMethod>
     <RedundantCastGivenDocblockType>
       <code><![CDATA[(bool) $allowWhiteSpace]]></code>
       <code><![CDATA[(bool) $allowWhiteSpace]]></code>
     </RedundantCastGivenDocblockType>
   </file>
   <file src="src/Validator/Alpha.php">
+    <DeprecatedMethod>
+      <code><![CDATA[getAllowWhiteSpace]]></code>
+    </DeprecatedMethod>
     <InvalidClassConstantType>
       <code><![CDATA[INVALID]]></code>
       <code><![CDATA[STRING_EMPTY]]></code>
     </InvalidClassConstantType>
+    <InvalidExtendClass>
+      <code><![CDATA[Alnum]]></code>
+    </InvalidExtendClass>
+    <MethodSignatureMismatch>
+      <code><![CDATA[public function isValid($value)]]></code>
+    </MethodSignatureMismatch>
     <NonInvariantDocblockPropertyType>
       <code><![CDATA[$filter]]></code>
     </NonInvariantDocblockPropertyType>
   </file>
   <file src="src/Validator/DateTime.php">
+    <DeprecatedMethod>
+      <code><![CDATA[getDateType]]></code>
+      <code><![CDATA[getLocale]]></code>
+      <code><![CDATA[getTimeType]]></code>
+      <code><![CDATA[setCalendar]]></code>
+      <code><![CDATA[setPattern]]></code>
+      <code><![CDATA[setTimezone]]></code>
+    </DeprecatedMethod>
     <DocblockTypeContradiction>
       <code><![CDATA[is_string($value)]]></code>
     </DocblockTypeContradiction>
@@ -517,11 +537,21 @@
     </PossiblyUnusedMethod>
   </file>
   <file src="src/Validator/IsFloat.php">
+    <DeprecatedMethod>
+      <code><![CDATA[getLocale]]></code>
+      <code><![CDATA[getLocale]]></code>
+      <code><![CDATA[setLocale]]></code>
+    </DeprecatedMethod>
     <MixedArgument>
       <code><![CDATA[$options['locale']]]></code>
     </MixedArgument>
   </file>
   <file src="src/Validator/IsInt.php">
+    <DeprecatedMethod>
+      <code><![CDATA[getLocale]]></code>
+      <code><![CDATA[setLocale]]></code>
+      <code><![CDATA[setStrict]]></code>
+    </DeprecatedMethod>
     <DocblockTypeContradiction>
       <code><![CDATA[is_bool($strict)]]></code>
     </DocblockTypeContradiction>
@@ -563,7 +593,13 @@
   </file>
   <file src="src/Validator/PostCode.php">
     <DeprecatedMethod>
+      <code><![CDATA[getFormat]]></code>
+      <code><![CDATA[getLocale]]></code>
       <code><![CDATA[getService]]></code>
+      <code><![CDATA[setFormat]]></code>
+      <code><![CDATA[setLocale]]></code>
+      <code><![CDATA[setLocale]]></code>
+      <code><![CDATA[setOptions]]></code>
       <code><![CDATA[setService]]></code>
     </DeprecatedMethod>
     <MixedArgument>

diff --git a/src/Validator/Alnum.php b/src/Validator/Alnum.php
@@ -12,6 +12,7 @@
 use function is_scalar;
 use function is_string;
 
+/** @final */
 class Alnum extends AbstractValidator
 {
     public const INVALID      = 'alnumInvalid';
@@ -28,7 +29,7 @@ class Alnum extends AbstractValidator
     /**
      * Validation failure message template definitions
      *
-     * @var string[]
+     * @var array<string, string>
      */
     protected $messageTemplates = [
         self::INVALID      => 'Invalid type given. String, integer or float expected',
@@ -63,6 +64,8 @@ public function __construct($allowWhiteSpace = false)
     /**
      * Returns the allowWhiteSpace option
      *
+     * @deprecated Since 2.28.0 - This method will be removed in 3.0
+     *
      * @return bool
      */
     public function getAllowWhiteSpace()
@@ -73,7 +76,9 @@ public function getAllowWhiteSpace()
     /**
      * Sets the allowWhiteSpace option
      *
-     * @param  bool $allowWhiteSpace
+     * @deprecated Since 2.28.0 - This method will be removed in 3.0. Provide options to the constructor instead.
+     *
+     * @param bool $allowWhiteSpace
      * @return $this
      */
     public function setAllowWhiteSpace($allowWhiteSpace)

diff --git a/src/Validator/Alpha.php b/src/Validator/Alpha.php
@@ -6,6 +6,7 @@
 
 use function is_string;
 
+/** @final */
 class Alpha extends Alnum
 {
     public const INVALID      = 'alphaInvalid';
@@ -22,7 +23,7 @@ class Alpha extends Alnum
     /**
      * Validation failure message template definitions
      *
-     * @var string[]
+     * @var array<string, string>
      */
     protected $messageTemplates = [
         self::INVALID      => 'Invalid type given. String expected',