Mark classes internal to this bundle as final (#23)

CHANGELOG.md

@@ -5,6 +5,7 @@ To get the diff for a specific change, go to https://github.com/webfactory/polyg
 ## Version 3.0.0 [unreleased]
 
 * Dropped support for PHP versions below 8.1, and for Symfony versions before 5.4.
+* Classes internal to this bundle are now marked as `final`. Static analysis tools should be able to pick up `@final` announcements used as of v2.5.0.
 
 ## Version 2.0.0
 

src/Annotation/Locale.php

@@ -14,10 +14,8 @@
 /**
  * @Annotation
  * @Target({"CLASS","PROPERTY"})
- *
- * @final
  */
-class Locale extends Annotation
+final class Locale extends Annotation
 {
     /**
      * @var string

src/Annotation/Translatable.php

@@ -13,10 +13,8 @@
 
 /**
  * @Annotation
- *
- * @final
  */
-class Translatable extends Annotation
+final class Translatable extends Annotation
 {
     /**
      * @var string

src/Annotation/TranslationCollection.php

@@ -11,9 +11,7 @@
 
 /**
  * @Annotation
- *
- * @final
  */
-class TranslationCollection
+final class TranslationCollection
 {
 }

src/DependencyInjection/WebfactoryPolyglotExtension.php

@@ -14,7 +14,7 @@
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
-class WebfactoryPolyglotExtension extends Extension
+final class WebfactoryPolyglotExtension extends Extension
 {
     public function load(array $configs, ContainerBuilder $container): void
     {

src/Doctrine/PersistentTranslatable.php

@@ -22,10 +22,8 @@
 /**
  * Eine TranslationProxy-Implementierung für eine Entität, die
  * bereits unter Verwaltung des EntityManagers steht.
- *
- * @final
  */
-class PersistentTranslatable implements TranslatableInterface
+final class PersistentTranslatable implements TranslatableInterface
 {
     /**
      * Cache für die Übersetzungen, indiziert nach Entity-OID und Locale. Ist static, damit ihn sich verschiedene Proxies (für die gleiche Entität, aber unterschiedliche Felder) teilen können.
@@ -134,9 +132,6 @@ public function __construct(
         $this->logger = (null == $logger) ? new NullLogger() : $logger;
     }
 
-    /**
-     * @param mixed $value
-     */
     public function setPrimaryValue($value)
     {
         $this->primaryValue = $value;

src/Doctrine/PolyglotListener.php

@@ -19,10 +19,7 @@
 use SplObjectStorage;
 use Webfactory\Bundle\PolyglotBundle\Locale\DefaultLocaleProvider;
 
-/**
- * @final
- */
-class PolyglotListener
+final class PolyglotListener
 {
     public const CACHE_SALT = '$WebfactoryPolyglot';
 

src/Doctrine/TranslatableClassMetadata.php

@@ -28,10 +28,8 @@
  * like which fields in the class are @Translatable_s, which field holds the collection
  * of translations etc. There need only be one instance of this class for every
  * entity class with translations.
- *
- * @final
  */
-class TranslatableClassMetadata
+final class TranslatableClassMetadata
 {
     /**
      * Ein Mapping von Feldnamen in der Hauptklasse auf die Felder in der

src/EventListener/LocaleListener.php

@@ -19,10 +19,8 @@
  * Taken from Christophe COEVOET's Doctrine Extensions Bundle.
  *
  * @author Christophe COEVOET
- *
- * @final
  */
-class LocaleListener implements EventSubscriberInterface
+final class LocaleListener implements EventSubscriberInterface
 {
     private $defaultLocaleProvider;
 

src/Locale/DefaultLocaleProvider.php

@@ -9,10 +9,7 @@
 
 namespace Webfactory\Bundle\PolyglotBundle\Locale;
 
-/**
- * @final
- */
-class DefaultLocaleProvider
+final class DefaultLocaleProvider
 {
     private $defaultLocale;
 

src/Translatable.php

@@ -37,10 +37,8 @@
  *     protected $aField;
  *     public function __construct() {...
  *       $aField = new Translatable();
- *
- * @final
  */
-class Translatable implements TranslatableInterface
+final class Translatable implements TranslatableInterface
 {
     /**
      * @var string

src/TranslatableInterface.php

@@ -26,7 +26,6 @@ public function translate(string $locale = null);
     /**
      * Overwrites the translation for the given locale.
      *
-     * @param mixed       $value
      * @param string|null $locale The target locale or null for the current locale.
      */
     public function setTranslation($value, string $locale = null);