From 820bb4c7167ad34bad5a315d2177cd32ac25bf65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Frank=20Bru=CC=88ckner?= Date: Tue, 30 Nov 2021 00:09:24 +0100 Subject: [PATCH] Adds call-outs for new and deprecated features of version 2.12.0 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Frank Brückner --- docs/book/standard-filters.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/book/standard-filters.md b/docs/book/standard-filters.md index 496ca3f1..702ceba0 100644 --- a/docs/book/standard-filters.md +++ b/docs/book/standard-filters.md @@ -4,6 +4,9 @@ laminas-filter comes with a standard set of filters, available for immediate use ## AllowList +TIP: **New Feature** +Available since version 2.12.0 + Previously known as `Whitelist`. This filter will return `null` if the value being filtered is not present the filter's allowed list of values. If the value is present, it will return that @@ -150,6 +153,12 @@ print $filter->filter('/vol/tmp/filename.txt'); This will return '`filename.txt`'. +## Blacklist + +CAUTION: **Deprecated** +This filter is deprecated since version 2.12.0. +Use the [DenyList filter](#denylist) instead. + ## Boolean This filter changes a given input to be a `BOOLEAN` value. This is often useful when working with @@ -716,6 +725,9 @@ which accepts an array of all options. ## DenyList +TIP: **New Feature** +Available since version 2.12.0 + Previously known as `Blacklist`. This filter will return `null` if the value being filtered is present in the filter's list of values. If the value is not present, it will return that value. @@ -1908,3 +1920,9 @@ echo $filter->filter('www.example.com'); ``` The above results in the string `https://www.example.com`. + +## Whitelist + +CAUTION: **Deprecated** +This filter is deprecated since version 2.12.0. +Use the [AllowList filter](#allowlist) instead.