Merge pull request #124 from froschdesign/hotfix/91

Mark PhoneNumber validator class as deprecated
laminas · Jun 30, 2024 · f9044ff · f9044ff
2 parents 79cde05 + affffba
commit f9044ff
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,5 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="5.22.2@d768d914152dbbf3486c36398802f74e80cfde48">
+<files psalm-version="5.24.0@462c80e31c34e58cc4f750c656be3927e80e550e">
+  <file src="src/ConfigProvider.php">
+    <DeprecatedClass>
+      <code><![CDATA[Validator\PhoneNumber::class]]></code>
+      <code><![CDATA[Validator\PhoneNumber::class]]></code>
+      <code><![CDATA[Validator\PhoneNumber::class]]></code>
+      <code><![CDATA[Validator\PhoneNumber::class]]></code>
+      <code><![CDATA[Validator\PhoneNumber::class]]></code>
+    </DeprecatedClass>
+  </file>
   <file src="src/Exception/ExtensionNotLoadedException.php">
     <UnusedClass>
       <code><![CDATA[ExtensionNotLoadedException]]></code>
@@ -861,6 +870,15 @@
     </PossiblyUnusedMethod>
   </file>
   <file src="test/Validator/PhoneNumberTest.php">
+    <DeprecatedClass>
+      <code><![CDATA[PhoneNumber]]></code>
+      <code><![CDATA[new PhoneNumber($constructorOptions)]]></code>
+      <code><![CDATA[new PhoneNumber()]]></code>
+      <code><![CDATA[new PhoneNumber()]]></code>
+      <code><![CDATA[new PhoneNumber([
+            'country' => 'country-code',
+        ])]]></code>
+    </DeprecatedClass>
     <PossiblyUnusedMethod>
       <code><![CDATA[constructDataProvider]]></code>
       <code><![CDATA[numbersDataProvider]]></code>

diff --git a/src/Validator/PhoneNumber.php b/src/Validator/PhoneNumber.php
@@ -19,6 +19,11 @@
 use function strtoupper;
 use function substr;
 
+/**
+ * @deprecated This class is deprecated and will be removed in v3.0.0
+ *             Use Laminas\I18n\PhoneNumber\Validator\PhoneNumber instead:
+ *             https://github.com/laminas/laminas-i18n-phone-number
+ */
 class PhoneNumber extends AbstractValidator
 {
     public const NO_MATCH    = 'phoneNumberNoMatch';