Mark classes as final

UPGRADE-3.x.md

@@ -4,6 +4,10 @@ UPGRADE 3.x
 UPGRADE FROM 3.x to 3.x
 =======================
 
+### Close API
+
+Most of the classes have been marked as `@final` and they will be final in `4.0`.
+
 ### Upgrade to SonataDatagridBundle 3.0
 
 There is a minimal BC Break on `MessageManager::getPager`. If you are extending this method you should add parameter and return type hints.

src/Admin/MessageAdmin.php

@@ -22,6 +22,7 @@
 
 /**
  * @phpstan-extends AbstractAdmin<\Sonata\NotificationBundle\Model\Message>
+ * @final since sonata-project/notification-bundle 3.x
  */
 class MessageAdmin extends AbstractAdmin
 {

src/Backend/AMQPBackend.php

@@ -31,6 +31,8 @@
 
 /**
  * Consumer side of the rabbitMQ backend.
+ *
+ * @final since sonata-project/notification-bundle 3.x
  */
 class AMQPBackend implements BackendInterface
 {

src/Backend/AMQPBackendDispatcher.php

@@ -28,6 +28,8 @@
 
 /**
  * Producer side of the rabbitmq backend.
+ *
+ * @final since sonata-project/notification-bundle 3.x
  */
 class AMQPBackendDispatcher extends QueueBackendDispatcher
 {

src/Backend/BackendHealthCheck.php

@@ -15,6 +15,9 @@
 
 use Laminas\Diagnostics\Check\AbstractCheck;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class BackendHealthCheck extends AbstractCheck
 {
     /**

src/Backend/MessageManagerBackend.php

@@ -23,6 +23,9 @@
 use Sonata\NotificationBundle\Model\MessageManagerInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class MessageManagerBackend implements BackendInterface
 {
     /**

src/Backend/MessageManagerBackendDispatcher.php

@@ -20,6 +20,8 @@
 
 /**
  * Producer side of the doctrine backend.
+ *
+ * @final since sonata-project/notification-bundle 3.x
  */
 class MessageManagerBackendDispatcher extends QueueBackendDispatcher
 {

src/Backend/PostponeRuntimeBackend.php

@@ -26,6 +26,8 @@
  * @see https://gist.github.com/3852361
  *
  * @author Toni Uebernickel <[email protected]>
+ *
+ * @final since sonata-project/notification-bundle 3.x
  */
 class PostponeRuntimeBackend extends RuntimeBackend
 {

src/Command/CleanupCommand.php

@@ -19,6 +19,9 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class CleanupCommand extends ContainerAwareCommand
 {
     public function configure()

src/Command/ConsumerHandlerCommand.php

@@ -25,6 +25,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class ConsumerHandlerCommand extends ContainerAwareCommand
 {
     public function configure()

src/Command/CreateAndPublishCommand.php

@@ -18,6 +18,9 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class CreateAndPublishCommand extends ContainerAwareCommand
 {
     public function configure()

src/Command/ListHandlerCommand.php

@@ -17,6 +17,9 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class ListHandlerCommand extends ContainerAwareCommand
 {
     public function configure()

src/Command/ListQueuesCommand.php

@@ -18,6 +18,9 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class ListQueuesCommand extends ContainerAwareCommand
 {
     public function configure()

src/Command/RestartCommand.php

@@ -24,6 +24,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class RestartCommand extends ContainerAwareCommand
 {
     public function configure()

src/Consumer/ConsumerEvent.php

@@ -16,6 +16,9 @@
 use Sonata\NotificationBundle\Model\MessageInterface;
 use Symfony\Contracts\EventDispatcher\Event;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class ConsumerEvent extends Event implements ConsumerEventInterface
 {
     /**

src/Consumer/ConsumerReturnInfo.php

@@ -17,6 +17,8 @@
  * Return informations for comsumers.
  *
  * @author Kevin Nedelec <[email protected]>
+ *
+ * @final since sonata-project/notification-bundle 3.x
  */
 class ConsumerReturnInfo
 {

src/Consumer/LoggerConsumer.php

@@ -16,6 +16,9 @@
 use Psr\Log\LoggerInterface;
 use Sonata\NotificationBundle\Exception\InvalidParameterException;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class LoggerConsumer implements ConsumerInterface
 {
     /**

src/Consumer/Metadata.php

@@ -13,6 +13,9 @@
 
 namespace Sonata\NotificationBundle\Consumer;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class Metadata
 {
     /**

src/Consumer/SwiftMailerConsumer.php

@@ -15,6 +15,9 @@
 
 use Sonata\NotificationBundle\Model\MessageInterface;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class SwiftMailerConsumer implements ConsumerInterface
 {
     /**

src/Controller/Api/MessageController.php

@@ -27,6 +27,8 @@
 
 /**
  * @author Hugo Briand <[email protected]>
+ *
+ * @final since sonata-project/notification-bundle 3.x
  */
 class MessageController
 {

src/Controller/MessageAdminController.php

@@ -20,6 +20,9 @@
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class MessageAdminController extends CRUDController
 {
     /**

src/DependencyInjection/Compiler/NotificationCompilerPass.php

@@ -21,6 +21,11 @@
 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
 use Symfony\Component\DependencyInjection\Reference;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ *
+ * @internal since sonata-project/notification-bundle 4.0
+ */
 class NotificationCompilerPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container)

src/DependencyInjection/Configuration.php

@@ -19,6 +19,9 @@
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class Configuration implements ConfigurationInterface
 {
     public function getConfigTreeBuilder()

src/DependencyInjection/SonataNotificationExtension.php

@@ -26,6 +26,9 @@
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class SonataNotificationExtension extends Extension
 {
     /**

src/Entity/MessageManager.php

@@ -20,6 +20,9 @@
 use Sonata\NotificationBundle\Model\MessageInterface;
 use Sonata\NotificationBundle\Model\MessageManagerInterface;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class MessageManager extends BaseEntityManager implements MessageManagerInterface
 {
     public function save($entity, $andFlush = true)

src/Event/DoctrineBackendOptimizeListener.php

@@ -21,6 +21,8 @@
  * Used with doctrine backend to clear context taking care of the batch iterations.
  *
  * @author Kevin Nedelec <[email protected]>
+ *
+ * @final since sonata-project/notification-bundle 3.x
  */
 class DoctrineBackendOptimizeListener implements IterationListener
 {

src/Event/DoctrineOptimizeListener.php

@@ -21,6 +21,8 @@
  * Do not use with doctrine backend, use DoctrineBackendOptimizeListener instead.
  *
  * @author Kevin Nedelec <[email protected]>
+ *
+ * @final since sonata-project/notification-bundle 3.x
  */
 class DoctrineOptimizeListener implements IterationListener
 {

src/Event/IterateEvent.php

@@ -22,6 +22,8 @@
  * Event for ConsumerHandlerCommand iterations event.
  *
  * @author Kevin Nedelec <[email protected]>
+ *
+ * @final since sonata-project/notification-bundle 3.x
  */
 class IterateEvent extends Event
 {

src/Exception/BackendNotFoundException.php

@@ -13,6 +13,9 @@
 
 namespace Sonata\NotificationBundle\Exception;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class BackendNotFoundException extends \RuntimeException
 {
 }

src/Exception/HandlingException.php

@@ -13,6 +13,9 @@
 
 namespace Sonata\NotificationBundle\Exception;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class HandlingException extends \RuntimeException
 {
 }

src/Exception/InvalidParameterException.php

@@ -20,6 +20,9 @@ class InvalidParameterException extends CoreBundleException
     {
     }
 } else {
+    /**
+     * @final since sonata-project/notification-bundle 3.x
+     */
     class InvalidParameterException extends \RuntimeException
     {
     }

src/Form/Type/MessageSerializationType.php

@@ -15,6 +15,9 @@
 
 use Sonata\Form\Type\BaseDoctrineORMSerializationType;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class MessageSerializationType extends BaseDoctrineORMSerializationType
 {
 }

src/Iterator/AMQPMessageIterator.php

@@ -18,6 +18,9 @@
 use PhpAmqpLib\Message\AMQPMessage;
 use Sonata\NotificationBundle\Model\Message;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class AMQPMessageIterator implements MessageIteratorInterface
 {
     /**

src/Iterator/ErroneousMessageIterator.php

@@ -16,6 +16,9 @@
 use Sonata\NotificationBundle\Model\MessageInterface;
 use Sonata\NotificationBundle\Model\MessageManagerInterface;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class ErroneousMessageIterator extends MessageManagerMessageIterator
 {
     /**

src/Iterator/IteratorProxyMessageIterator.php

@@ -15,6 +15,8 @@
 
 /**
  * @author Toni Uebernickel <[email protected]>
+ *
+ * @final since sonata-project/notification-bundle 3.x
  */
 class IteratorProxyMessageIterator implements MessageIteratorInterface
 {

src/Selector/ErroneousMessagesSelector.php

@@ -16,6 +16,9 @@
 use Doctrine\Persistence\ManagerRegistry;
 use Sonata\NotificationBundle\Model\MessageInterface;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class ErroneousMessagesSelector
 {
     /**

src/SonataNotificationBundle.php

@@ -19,6 +19,9 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
+/**
+ * @final since sonata-project/notification-bundle 3.x
+ */
 class SonataNotificationBundle extends Bundle
 {
     public function build(ContainerBuilder $container)