minor #20138 [HttpFoundation] Add new parameters to IpUtils::anonymize() (alexandre-daubois)

javiereguiluz · javiereguiluz · commit 55d50b0a3873 · 2024-08-26T09:08:10.000+02:00
This PR was merged into the 7.2 branch. Discussion ---------- [HttpFoundation] Add new parameters to `IpUtils::anonymize()` Related to symfony/symfony#58038 Commits ------- 84da11c [HttpFoundation] Add new parameters to `IpUtils::anonymize()`
diff --git a/components/http_foundation.rst b/components/http_foundation.rst
@@ -362,6 +362,23 @@ analysis purposes. Use the ``anonymize()`` method from the
     $anonymousIpv6 = IpUtils::anonymize($ipv6);
     // $anonymousIpv6 = '2a01:198:603:10::'
 
+If you need even more anonymization, you can use the second and third parameters
+of the ``anonymize()`` method to specify the number of bytes that should be
+anonymized depending on the IP address format::
+
+    $ipv4 = '123.234.235.236';
+    $anonymousIpv4 = IpUtils::anonymize($ipv4, v4Bytes: 3);
+    // $anonymousIpv4 = '123.0.0.0'
+
+    $ipv6 = '2a01:198:603:10:396e:4789:8e99:890f';
+    $anonymousIpv6 = IpUtils::anonymize($ipv6, v6Bytes: 10);
+    // $anonymousIpv6 = '2a01:198:603::'
+
+.. versionadded:: 7.2
+
+    The ``v4Bytes`` and ``v6Bytes`` parameters of the ``anonymize()`` method
+    were introduced in Symfony 7.2.
+
 Check If an IP Belongs to a CIDR Subnet
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
