Merge pull request #299 from gsteel/v2/hostname-deprecations

Deprecate option setters and getters in `Hostname`
laminas · Jul 2, 2024 · 43cbe54 · 43cbe54
2 parents e154a14 + 2c43627
commit 43cbe54
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 3 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1638,6 +1638,18 @@
     </PropertyNotSetInConstructor>
   </file>
   <file src="src/Hostname.php">
+    <DeprecatedMethod>
+      <code><![CDATA[getAllow]]></code>
+      <code><![CDATA[getAllow]]></code>
+      <code><![CDATA[getAllow]]></code>
+      <code><![CDATA[getAllow]]></code>
+      <code><![CDATA[getAllow]]></code>
+      <code><![CDATA[getAllow]]></code>
+      <code><![CDATA[getIdnCheck]]></code>
+      <code><![CDATA[getIpValidator]]></code>
+      <code><![CDATA[getIpValidator]]></code>
+      <code><![CDATA[getTldCheck]]></code>
+    </DeprecatedMethod>
     <DocblockTypeContradiction>
       <code><![CDATA[is_array($options)]]></code>
       <code><![CDATA[is_string($value)]]></code>
@@ -2473,6 +2485,10 @@
     </PossiblyUnusedMethod>
   </file>
   <file src="test/EmailAddressTest.php">
+    <DeprecatedMethod>
+      <code><![CDATA[useIdnCheck]]></code>
+      <code><![CDATA[useTldCheck]]></code>
+    </DeprecatedMethod>
     <InvalidArgument>
       <code><![CDATA[Hostname::ALLOW_ALL]]></code>
       <code><![CDATA[Hostname::ALLOW_ALL]]></code>
@@ -2839,6 +2855,11 @@
     </PossiblyUnusedMethod>
   </file>
   <file src="test/HostnameTest.php">
+    <DeprecatedMethod>
+      <code><![CDATA[getAllow]]></code>
+      <code><![CDATA[useIdnCheck]]></code>
+      <code><![CDATA[useTldCheck]]></code>
+    </DeprecatedMethod>
     <InvalidArgument>
       <code><![CDATA[$option]]></code>
       <code><![CDATA[$option]]></code>

diff --git a/src/Hostname.php b/src/Hostname.php
@@ -1833,6 +1833,8 @@ public function __construct($options = [])
     /**
      * Returns the set ip validator
      *
+     * @deprecated Since 2.61.0 all options getters and setters will be removed in 3.0
+     *
      * @return Ip
      */
     public function getIpValidator()
@@ -1841,6 +1843,8 @@ public function getIpValidator()
     }
 
     /**
+     * @deprecated Since 2.61.0 all options getters and setters will be removed in 3.0
+     *
      * @param Ip $ipValidator OPTIONAL
      * @return self
      */
@@ -1857,6 +1861,8 @@ public function setIpValidator(?Ip $ipValidator = null)
     /**
      * Returns the allow option
      *
+     * @deprecated Since 2.61.0 all options getters and setters will be removed in 3.0
+     *
      * @return int
      */
     public function getAllow()
@@ -1867,7 +1873,9 @@ public function getAllow()
     /**
      * Sets the allow option
      *
-     * @param  int $allow
+     * @deprecated Since 2.61.0 all options getters and setters will be removed in 3.0
+     *
+     * @param int $allow
      * @return $this Provides a fluent interface
      */
     public function setAllow($allow)
@@ -1879,6 +1887,8 @@ public function setAllow($allow)
     /**
      * Returns the set idn option
      *
+     * @deprecated Since 2.61.0 all options getters and setters will be removed in 3.0
+     *
      * @return bool
      */
     public function getIdnCheck()
@@ -1891,7 +1901,9 @@ public function getIdnCheck()
      *
      * This only applies when DNS hostnames are validated
      *
-     * @param  bool $useIdnCheck Set to true to validate IDN domains
+     * @deprecated Since 2.61.0 all options getters and setters will be removed in 3.0
+     *
+     * @param bool $useIdnCheck Set to true to validate IDN domains
      * @return $this
      */
     public function useIdnCheck($useIdnCheck)
@@ -1903,6 +1915,8 @@ public function useIdnCheck($useIdnCheck)
     /**
      * Returns the set tld option
      *
+     * @deprecated Since 2.61.0 all options getters and setters will be removed in 3.0
+     *
      * @return bool
      */
     public function getTldCheck()
@@ -1915,7 +1929,9 @@ public function getTldCheck()
      *
      * This only applies when DNS hostnames are validated
      *
-     * @param  bool $useTldCheck Set to true to validate TLD elements
+     * @deprecated Since 2.61.0 all options getters and setters will be removed in 3.0
+     *
+     * @param bool $useTldCheck Set to true to validate TLD elements
      * @return $this
      */
     public function useTldCheck($useTldCheck)