Closing API by marking some classes with "@Final" annotation

Signed-off-by: Wojciech Błoszyk <wbloszyk@gmail.com>

src/Block/Breadcrumb/NewsArchiveBreadcrumbBlockService.php

@@ -17,6 +17,8 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
+ * @final since sonata-project/news-bundle 3.x
+ *
  * BlockService for archive breadcrumb.
  *
  * @author Sylvain Deloux <sylvain.deloux@ekino.com>

src/Block/Breadcrumb/NewsPostBreadcrumbBlockService.php

@@ -21,6 +21,8 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
+ * @final since sonata-project/news-bundle 3.x
+ *
  * BlockService for post breadcrumb.
  *
  * @author Sylvain Deloux <sylvain.deloux@ekino.com>

src/Block/RecentCommentsBlockService.php

@@ -30,6 +30,8 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
+ * @final since sonata-project/news-bundle 3.x
+ *
  * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
  */
 class RecentCommentsBlockService extends AbstractAdminBlockService

src/Block/RecentPostsBlockService.php

@@ -30,6 +30,8 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
+ * @final since sonata-project/news-bundle 3.x
+ *
  * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
  */
 class RecentPostsBlockService extends AbstractAdminBlockService

src/Command/SynchronizeCommentsCountCommand.php

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

src/Controller/PostController.php

@@ -45,6 +45,11 @@
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
 
+/**
+ * NEXT_MAJOR: remove this method.
+ *
+ * @deprecated since sonata-project/news-bundle 3.x, to be removed in 4.0.
+ */
 class PostController extends Controller
 {
     /**

src/DependencyInjection/Configuration.php

@@ -17,6 +17,8 @@
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 /**
+ * @final since sonata-project/news-bundle 3.x
+ *
  * This is the class that validates and merges configuration from your app/config files.
  *
  * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html#cookbook-bundles-extension-config-class}

src/DependencyInjection/SonataNewsExtension.php

@@ -25,6 +25,8 @@
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 /**
+ * @final since sonata-project/news-bundle 3.x
+ *
  * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
  */
 class SonataNewsExtension extends Extension

src/Entity/CommentManager.php

@@ -71,6 +71,11 @@ public function delete($comment, $andFlush = true)
         $this->updateCommentsCount($post);
     }
 
+    /**
+     * NEXT_MAJOR: remove this method.
+     *
+     * @deprecated since sonata-project/news-bundle 3.x, to be removed in 4.0.
+     */
     public function getPager(array $criteria, $page, $limit = 10, array $sort = [])
     {
         if (!isset($criteria['mode'])) {

src/Entity/PostManager.php

@@ -77,6 +77,10 @@ public function findOneByPermalink($permalink, BlogInterface $blog)
     }
 
     /**
+     * NEXT_MAJOR: remove this method.
+     *
+     * @deprecated since sonata-project/news-bundle 3.x, to be removed in 4.0.
+     *
      * Valid criteria are:
      *    enabled - boolean
      *    date - query

src/Exception/NoDriverException.php

@@ -14,6 +14,8 @@
 namespace Sonata\NewsBundle\Exception;
 
 /**
+ * @final since sonata-project/news-bundle 3.x
+ *
  * @author Christian Gripp <mail@core23.de>
  */
 class NoDriverException extends \RuntimeException

src/Form/Type/CommentStatusType.php

@@ -16,6 +16,9 @@
 use Sonata\Form\Type\BaseStatusType;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
+/**
+ * @final since sonata-project/news-bundle 3.x
+ */
 class CommentStatusType extends BaseStatusType
 {
     public function configureOptions(OptionsResolver $resolver)

src/Form/Type/CommentType.php

@@ -21,6 +21,9 @@
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
+/**
+ * @final since sonata-project/news-bundle 3.x
+ */
 class CommentType extends AbstractType
 {
     public function buildForm(FormBuilderInterface $builder, array $options)

src/Mailer/Mailer.php

@@ -21,6 +21,9 @@
 use Symfony\Component\Routing\RouterInterface;
 use Symfony\Component\Templating\EngineInterface;
 
+/**
+ * @final since sonata-project/news-bundle 3.x
+ */
 class Mailer implements MailerInterface
 {
     /**

src/Permalink/CollectionPermalink.php

@@ -15,6 +15,9 @@
 
 use Sonata\NewsBundle\Model\PostInterface;
 
+/**
+ * @final since sonata-project/news-bundle 3.x
+ */
 class CollectionPermalink implements PermalinkInterface
 {
     public function generate(PostInterface $post)

src/Permalink/DatePermalink.php

@@ -15,6 +15,9 @@
 
 use Sonata\NewsBundle\Model\PostInterface;
 
+/**
+ * @final since sonata-project/news-bundle 3.x
+ */
 class DatePermalink implements PermalinkInterface
 {
     /**

src/SonataNewsBundle.php

@@ -19,6 +19,9 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
+/**
+ * @final since sonata-project/news-bundle 3.x
+ */
 class SonataNewsBundle extends Bundle
 {
     public function build(ContainerBuilder $container)
@@ -34,7 +37,11 @@ public function boot()
     }
 
     /**
+     * NEXT_MAJOR: remove this method.
+     *
      * Register form mapping information.
+     *
+     * @deprecated since sonata-project/news-bundle 3.x, to be removed in 4.0.
      */
     public function registerFormMapping()
     {

src/Status/CommentStatusRenderer.php

@@ -17,6 +17,8 @@
 use Sonata\Twig\Status\StatusClassRendererInterface;
 
 /**
+ * @final since sonata-project/news-bundle 3.x
+ *
  * @author Hugo Briand <briand@ekino.com>
  */
 class CommentStatusRenderer implements StatusClassRendererInterface

src/Twig/Extension/NewsExtension.php

@@ -24,6 +24,9 @@
 use Twig\Extension\InitRuntimeInterface;
 use Twig\TwigFunction;
 
+/**
+ * @final since sonata-project/news-bundle 3.x
+ */
 class NewsExtension extends AbstractExtension implements InitRuntimeInterface
 {
     /**

src/Util/HashGenerator.php

@@ -15,6 +15,9 @@
 
 use Sonata\NewsBundle\Model\CommentInterface;
 
+/**
+ * @final since sonata-project/news-bundle 3.x
+ */
 class HashGenerator implements HashGeneratorInterface
 {
     /**

tests/Action/DailyPostArchiveActionTest.php

@@ -25,7 +25,7 @@
 use Symfony\Contracts\Translation\TranslatorInterface;
 use Twig\Environment;
 
-class DailyPostArchiveActionTest extends TestCase
+final class DailyPostArchiveActionTest extends TestCase
 {
     public function testInvoke()
     {

tests/Controller/Api/CommentControllerTest.php

@@ -23,7 +23,7 @@
  *
  * @group legacy
  */
-class CommentControllerTest extends TestCase
+final class CommentControllerTest extends TestCase
 {
     public function testGetCommentAction()
     {

tests/Controller/Api/PostControllerTest.php

@@ -27,7 +27,7 @@
  *
  * @group legacy
  */
-class PostControllerTest extends TestCase
+final class PostControllerTest extends TestCase
 {
     public function testGetPostsAction()
     {

tests/DependencyInjection/Compiler/TwigStringExtensionCompilerPassTest.php

@@ -20,7 +20,7 @@
 use Symfony\Component\DependencyInjection\Definition;
 use Twig\Extra\String\StringExtension;
 
-class TwigStringExtensionCompilerPassTest extends AbstractCompilerPassTestCase
+final class TwigStringExtensionCompilerPassTest extends AbstractCompilerPassTestCase
 {
     public function testLoadTwigStringExtension(): void
     {

tests/DependencyInjection/SonataNewsExtensionTest.php

@@ -23,7 +23,7 @@
 use Sonata\NewsBundle\Model\Post;
 use Sonata\NewsBundle\Tests\Fixtures\UserMock;
 
-class SonataNewsExtensionTest extends AbstractExtensionTestCase
+final class SonataNewsExtensionTest extends AbstractExtensionTestCase
 {
     protected function setUp(): void
     {

tests/Document/CommentManagerTest.php

@@ -27,7 +27,7 @@
  *
  * @group legacy
  */
-class CommentManagerTest extends TestCase
+final class CommentManagerTest extends TestCase
 {
     public function testImplements()
     {

tests/Document/PostManagerTest.php

@@ -24,7 +24,7 @@
  *
  * @group legacy
  */
-class PostManagerTest extends TestCase
+final class PostManagerTest extends TestCase
 {
     public function testImplements()
     {

tests/Entity/CommentManagerTest.php

@@ -22,11 +22,15 @@
 use Sonata\NewsBundle\Model\PostManagerInterface;
 
 /**
+ * NEXT_MAJOR: Remove this class.
+ *
  * Tests the comment manager entity.
  *
  * @author Romain Mouillard <romain.mouillard@gmail.com>
+ *
+ * @group legacy
  */
-class CommentManagerTest extends TestCase
+final class CommentManagerTest extends TestCase
 {
     use EntityManagerMockFactoryTrait;