Replace @final with final keyword

Signed-off-by: George Steel <[email protected]>
laminas · Nov 6, 2023 · 5a9b126 · 5a9b126
1 parent fd23598
commit 5a9b126
Show file tree

Hide file tree

Showing 45 changed files with 49 additions and 88 deletions.
diff --git a/docs/book/v3/migration/v2-to-v3.md b/docs/book/v3/migration/v2-to-v3.md
@@ -39,6 +39,12 @@ $filtered = $filter->filter('A String');
 
 ## Removed Features
 
+### Final by default
+
+Nearly all the shipped filters now have the final keyword applied to the class. Individual filters were not designed for inheritance, so if you have filters that do extend from any of the shipped filters, you will likely have to re-consider your design. 
+
+### Removal of supported compression formats
+
 `Laminas\Filter\Compress` no longer supports the compression formats `Lzf`, `Rar` and `Snappy`.
 Support for these formats has been removed so the following classes are no longer available:
 

diff --git a/src/AllowList.php b/src/AllowList.php
@@ -17,9 +17,8 @@
  *     ...
  * }
  * @extends AbstractFilter<Options>
- * @final
  */
-class AllowList extends AbstractFilter
+final class AllowList extends AbstractFilter
 {
     /** @var bool */
     protected $strict = false;

diff --git a/src/BaseName.php b/src/BaseName.php
@@ -10,9 +10,8 @@
 /**
  * @psalm-type Options = array{}
  * @extends AbstractFilter<Options>
- * @final
  */
-class BaseName extends AbstractFilter
+final class BaseName extends AbstractFilter
 {
     /**
      * Defined by Laminas\Filter\FilterInterface

diff --git a/src/Boolean.php b/src/Boolean.php
@@ -25,9 +25,8 @@
  *     translations?: array,
  * }
  * @extends AbstractFilter<Options>
- * @final
  */
-class Boolean extends AbstractFilter
+final class Boolean extends AbstractFilter
 {
     public const TYPE_BOOLEAN      = 1;
     public const TYPE_INTEGER      = 2;

diff --git a/src/Callback.php b/src/Callback.php
@@ -19,9 +19,8 @@
  *     ...
  * }
  * @extends AbstractFilter<Options>
- * @final
  */
-class Callback extends AbstractFilter
+final class Callback extends AbstractFilter
 {
     /** @var array */
     protected $options = [

diff --git a/src/Compress/Bz2.php b/src/Compress/Bz2.php
@@ -25,9 +25,8 @@
  *     archive?: string|null,
  * }
  * @extends AbstractCompressionAlgorithm<Options>
- * @final
  */
-class Bz2 extends AbstractCompressionAlgorithm
+final class Bz2 extends AbstractCompressionAlgorithm
 {
     /**
      * Compression Options

diff --git a/src/Compress/Gz.php b/src/Compress/Gz.php
@@ -36,9 +36,8 @@
  *     archive?: string|null,
  * }
  * @extends AbstractCompressionAlgorithm<Options>
- * @final
  */
-class Gz extends AbstractCompressionAlgorithm
+final class Gz extends AbstractCompressionAlgorithm
 {
     /**
      * Compression Options

diff --git a/src/Compress/Tar.php b/src/Compress/Tar.php
@@ -30,9 +30,8 @@
  *     mode?: 'gz'|'bz2'|null,
  * }
  * @extends AbstractCompressionAlgorithm<Options>
- * @final
  */
-class Tar extends AbstractCompressionAlgorithm
+final class Tar extends AbstractCompressionAlgorithm
 {
     /**
      * Compression Options

diff --git a/src/Compress/Zip.php b/src/Compress/Zip.php
@@ -33,9 +33,8 @@
  *     target?: string|null,
  * }
  * @extends AbstractCompressionAlgorithm<Options>
- * @final
  */
-class Zip extends AbstractCompressionAlgorithm
+final class Zip extends AbstractCompressionAlgorithm
 {
     /**
      * Compression Options

diff --git a/src/DataUnitFormatter.php b/src/DataUnitFormatter.php
@@ -22,7 +22,6 @@
  *     prefixes?: list<string>,
  * }
  * @extends AbstractFilter<Options>
- * @final
  */
 final class DataUnitFormatter extends AbstractFilter
 {

diff --git a/src/DateSelect.php b/src/DateSelect.php
@@ -17,9 +17,8 @@
  * }
  * @template TOptions of Options
  * @template-extends AbstractDateDropdown<TOptions, InputArray>
- * @final
  */
-class DateSelect extends AbstractDateDropdown
+final class DateSelect extends AbstractDateDropdown
 {
     /**
      * Year-Month-Day

diff --git a/src/DateTimeFormatter.php b/src/DateTimeFormatter.php
@@ -17,9 +17,8 @@
  *     ...
  * }
  * @extends AbstractFilter<Options>
- * @final
  */
-class DateTimeFormatter extends AbstractFilter
+final class DateTimeFormatter extends AbstractFilter
 {
     /**
      * A valid format string accepted by date()

diff --git a/src/DateTimeSelect.php b/src/DateTimeSelect.php
@@ -24,9 +24,8 @@
  * }
  * @template TOptions of Options
  * @template-extends AbstractDateDropdown<TOptions, InputArray>
- * @final
  */
-class DateTimeSelect extends AbstractDateDropdown
+final class DateTimeSelect extends AbstractDateDropdown
 {
     /**
      * Year-Month-Day Hour:Min:Sec

diff --git a/src/Decompress.php b/src/Decompress.php
@@ -8,10 +8,8 @@
 
 /**
  * Decompresses a given string
- *
- * @final
  */
-class Decompress extends Compress
+final class Decompress extends Compress
 {
     /**
      * Use filter as functor

diff --git a/src/DenyList.php b/src/DenyList.php
@@ -17,9 +17,8 @@
  *     ...
  * }
  * @extends AbstractFilter<Options>
- * @final
  */
-class DenyList extends AbstractFilter
+final class DenyList extends AbstractFilter
 {
     /** @var bool */
     protected $strict = false;

diff --git a/src/Digits.php b/src/Digits.php
@@ -14,9 +14,8 @@
 /**
  * @psalm-type Options = array{}
  * @extends AbstractFilter<Options>
- * @final
  */
-class Digits extends AbstractFilter
+final class Digits extends AbstractFilter
 {
     /**
      * Defined by Laminas\Filter\FilterInterface

diff --git a/src/Dir.php b/src/Dir.php
@@ -10,9 +10,8 @@
 /**
  * @psalm-type Options = array{}
  * @extends AbstractFilter<Options>
- * @final
  */
-class Dir extends AbstractFilter
+final class Dir extends AbstractFilter
 {
     /**
      * Defined by Laminas\Filter\FilterInterface

diff --git a/src/File/LowerCase.php b/src/File/LowerCase.php
@@ -16,8 +16,7 @@
 use function is_string;
 use function is_writable;
 
-/** @final */
-class LowerCase extends StringToLower
+final class LowerCase extends StringToLower
 {
     /**
      * Defined by Laminas\Filter\Filter

diff --git a/src/File/Rename.php b/src/File/Rename.php
@@ -33,9 +33,8 @@
  * }
  * @template TOptions of Options
  * @template-extends Filter\AbstractFilter<TOptions>
- * @final
  */
-class Rename extends Filter\AbstractFilter
+final class Rename extends Filter\AbstractFilter
 {
     /**
      * Internal array of array(source, target, overwrite)

diff --git a/src/File/UpperCase.php b/src/File/UpperCase.php
@@ -14,8 +14,7 @@
 use function is_scalar;
 use function is_writable;
 
-/** @final */
-class UpperCase extends StringToUpper
+final class UpperCase extends StringToUpper
 {
     /**
      * Defined by Laminas\Filter\FilterInterface

diff --git a/src/FilterChain.php b/src/FilterChain.php
@@ -20,7 +20,6 @@
 use function strtolower;
 
 /**
- * @final
  * @psalm-type FilterChainConfiguration = array{
  *    filters?: list<array{
  *        name: string|class-string<FilterInterface>,
@@ -35,7 +34,7 @@
  * @extends AbstractFilter<FilterChainConfiguration>
  * @implements IteratorAggregate<array-key, FilterInterface|callable(mixed): mixed>
  */
-class FilterChain extends AbstractFilter implements Countable, IteratorAggregate
+final class FilterChain extends AbstractFilter implements Countable, IteratorAggregate
 {
     /**
      * Default priority at which filters are added

diff --git a/src/FilterPluginManager.php b/src/FilterPluginManager.php
@@ -24,10 +24,9 @@
  * FilterInterface. Additionally, it registers a number of default filters
  * available, as well as aliases for them.
  *
- * @final
  * @extends AbstractPluginManager<FilterInterface|callable(mixed): mixed>
  */
-class FilterPluginManager extends AbstractPluginManager
+final class FilterPluginManager extends AbstractPluginManager
 {
     protected $aliases = [
         // @codingStandardsIgnoreStart

diff --git a/src/HtmlEntities.php b/src/HtmlEntities.php
@@ -26,9 +26,8 @@
  *     ...
  * }
  * @extends AbstractFilter<Options>
- * @final
  */
-class HtmlEntities extends AbstractFilter
+final class HtmlEntities extends AbstractFilter
 {
     /**
      * Corresponds to the second htmlentities() argument

diff --git a/src/Inflector.php b/src/Inflector.php
@@ -35,9 +35,8 @@
  *     pluginManager?: FilterPluginManager,
  * }
  * @extends AbstractFilter<Options>
- * @final
  */
-class Inflector extends AbstractFilter
+final class Inflector extends AbstractFilter
 {
     /** @var FilterPluginManager */
     protected $pluginManager;

diff --git a/src/MonthSelect.php b/src/MonthSelect.php
@@ -16,9 +16,8 @@
  *  }
  * @template TOptions of Options
  * @template-extends AbstractDateDropdown<TOptions, InputArray>
- * @final
  */
-class MonthSelect extends AbstractDateDropdown
+final class MonthSelect extends AbstractDateDropdown
 {
     /**
      * Year-Month

diff --git a/src/PregReplace.php b/src/PregReplace.php
@@ -25,9 +25,8 @@
  *     replacement?: string|list<string>,
  * }
  * @extends AbstractFilter<Options>
- * @final
  */
-class PregReplace extends AbstractFilter
+final class PregReplace extends AbstractFilter
 {
     /** @var Options */
     protected $options = [

diff --git a/src/RealPath.php b/src/RealPath.php
@@ -29,9 +29,8 @@
  * }
  * @template TOptions of Options
  * @extends AbstractFilter<TOptions>
- * @final
  */
-class RealPath extends AbstractFilter
+final class RealPath extends AbstractFilter
 {
     /** @var TOptions $options */
     protected $options = [

diff --git a/src/StringPrefix.php b/src/StringPrefix.php
@@ -15,9 +15,8 @@
  *     prefix?: null|string,
  * }
  * @extends AbstractFilter<Options>
- * @final
  */
-class StringPrefix extends AbstractFilter
+final class StringPrefix extends AbstractFilter
 {
     /** @var Options */
     protected $options = [

diff --git a/src/StringSuffix.php b/src/StringSuffix.php
@@ -15,9 +15,8 @@
  *     suffix?: null|string,
  * }
  * @extends AbstractFilter<Options>
- * @final
  */
-class StringSuffix extends AbstractFilter
+final class StringSuffix extends AbstractFilter
 {
     /** @var Options */
     protected $options = [

diff --git a/src/StringTrim.php b/src/StringTrim.php
@@ -16,9 +16,8 @@
  *     charlist?: string|null,
  * }
  * @extends AbstractFilter<Options>
- * @final
  */
-class StringTrim extends AbstractFilter
+final class StringTrim extends AbstractFilter
 {
     /** @var Options */
     protected $options = [

diff --git a/src/StripNewlines.php b/src/StripNewlines.php
@@ -11,9 +11,8 @@
 /**
  * @psalm-type Options = array{}
  * @extends AbstractFilter<Options>
- * @final
  */
-class StripNewlines extends AbstractFilter
+final class StripNewlines extends AbstractFilter
 {
     /**
      * Defined by Laminas\Filter\FilterInterface

diff --git a/src/StripTags.php b/src/StripTags.php
@@ -31,9 +31,8 @@
  *     ...
  * }
  * @extends AbstractFilter<Options>
- * @final
  */
-class StripTags extends AbstractFilter
+final class StripTags extends AbstractFilter
 {
     /**
      * Unique ID prefix used for allowing comments

diff --git a/src/ToFloat.php b/src/ToFloat.php
@@ -9,9 +9,8 @@
 /**
  * @psalm-type Options = array{}
  * @extends AbstractFilter<Options>
- * @final
  */
-class ToFloat extends AbstractFilter
+final class ToFloat extends AbstractFilter
 {
     /**
      * Defined by Laminas\Filter\FilterInterface

diff --git a/src/ToInt.php b/src/ToInt.php
@@ -9,9 +9,8 @@
 /**
  * @psalm-type Options = array{}
  * @extends AbstractFilter<Options>
- * @final
  */
-class ToInt extends AbstractFilter
+final class ToInt extends AbstractFilter
 {
     /**
      * Defined by Laminas\Filter\FilterInterface

diff --git a/src/ToNull.php b/src/ToNull.php
@@ -21,9 +21,8 @@
  *     type?: int-mask-of<self::TYPE_*>,
  * }
  * @extends AbstractFilter<Options>
- * @final
  */
-class ToNull extends AbstractFilter
+final class ToNull extends AbstractFilter
 {
     public const TYPE_BOOLEAN     = 1;
     public const TYPE_INTEGER     = 2;