minor #165 Narrow API marking classes as final (phansys)

phansys · phansys · commit f2a52e11eea4 · 2020-07-05T16:52:22.000-03:00
This PR was merged into the 3.x branch. Discussion ---------- |Q |A | |--- |---| |Branch |3.x| |Bug fix? |no | |New feature? |no | |BC breaks? |no | |Deprecations?|no | |Tests pass? |yes| |Fixed tickets|n/a| |License |MIT| |Doc PR |n/a| Commits ------- c3bf56f Narrow API marking classes as final
diff --git a/Command/AutoClosingCommand.php b/Command/AutoClosingCommand.php
@@ -9,6 +9,9 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class AutoClosingCommand extends ContainerAwareCommand
 {
     protected static $defaultName = 'ticket:autoclosing';
diff --git a/Command/TicketManagerCommand.php b/Command/TicketManagerCommand.php
@@ -9,6 +9,9 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class TicketManagerCommand extends ContainerAwareCommand
 {
     protected static $defaultName = 'ticket:create';
diff --git a/Component/TicketFeatures.php b/Component/TicketFeatures.php
@@ -4,6 +4,9 @@
 
 use Hackzilla\Bundle\TicketBundle\Model\TicketFeature\MessageAttachmentInterface;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class TicketFeatures
 {
     private $features;
diff --git a/Controller/TicketAttachmentController.php b/Controller/TicketAttachmentController.php
@@ -9,6 +9,8 @@
  * Ticket Attachment controller.
  *
  * Download attachments
+ *
+ * @final since hackzilla/ticket-bundle 3.x.
  */
 class TicketAttachmentController extends Controller
 {
diff --git a/Controller/TicketController.php b/Controller/TicketController.php
@@ -15,6 +15,8 @@
 
 /**
  * Ticket controller.
+ *
+ * @final since hackzilla/ticket-bundle 3.x.
  */
 class TicketController extends Controller
 {
diff --git a/DependencyInjection/Compiler/DoctrineOrmMappingsPass.php b/DependencyInjection/Compiler/DoctrineOrmMappingsPass.php
@@ -6,6 +6,9 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class DoctrineOrmMappingsPass extends \Doctrine\Bundle\DoctrineBundle\DependencyInjection\Compiler\DoctrineOrmMappingsPass
 {
     public function __construct($driver = null, array $namespaces = [], $managerParameters = [], $enabledParameter = false, array $aliasMap = [])
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -9,6 +9,8 @@
  * 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}
+ *
+ * @final since hackzilla/ticket-bundle 3.x.
  */
 class Configuration implements ConfigurationInterface
 {
diff --git a/DependencyInjection/HackzillaTicketExtension.php b/DependencyInjection/HackzillaTicketExtension.php
@@ -11,6 +11,8 @@
  * This is the class that loads and manages your bundle configuration.
  *
  * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}
+ *
+ * @final since hackzilla/ticket-bundle 3.x.
  */
 class HackzillaTicketExtension extends Extension
 {
diff --git a/Event/TicketEvent.php b/Event/TicketEvent.php
@@ -5,6 +5,9 @@
 use Hackzilla\Bundle\TicketBundle\Model\TicketInterface;
 use Symfony\Component\EventDispatcher\Event;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class TicketEvent extends Event
 {
     protected $ticket;
diff --git a/EventListener/FileSubscriber.php b/EventListener/FileSubscriber.php
@@ -10,6 +10,8 @@
  * Class FileSubscriber.
  *
  * Source: https://gist.github.com/hubgit/0cdf96c296f20017fe91#file-filesubscriber-php
+ *
+ * @final since hackzilla/ticket-bundle 3.x.
  */
 class FileSubscriber implements EventSubscriberInterface
 {
diff --git a/EventListener/UserLoad.php b/EventListener/UserLoad.php
@@ -6,6 +6,9 @@
 use Hackzilla\Bundle\TicketBundle\Model\TicketInterface;
 use Hackzilla\Bundle\TicketBundle\Model\TicketMessageInterface;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class UserLoad
 {
     protected $userRepository;
diff --git a/Form/DataTransformer/StatusTransformer.php b/Form/DataTransformer/StatusTransformer.php
@@ -5,6 +5,9 @@
 use Hackzilla\Bundle\TicketBundle\Entity\TicketMessage;
 use Symfony\Component\Form\DataTransformerInterface;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class StatusTransformer implements DataTransformerInterface
 {
     /**
@@ -19,6 +22,8 @@ public function transform($number)
         if (TicketMessage::STATUS_CLOSED == $number) {
             return 1;
         }
+
+        return null;
     }
 
     /**
@@ -33,5 +38,7 @@ public function reverseTransform($number)
         if (1 == $number) {
             return TicketMessage::STATUS_CLOSED;
         }
+
+        return null;
     }
 }
diff --git a/Form/Type/PriorityType.php b/Form/Type/PriorityType.php
@@ -8,6 +8,9 @@
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class PriorityType extends AbstractType
 {
     public function configureOptions(OptionsResolver $resolver)
diff --git a/Form/Type/StatusType.php b/Form/Type/StatusType.php
@@ -8,6 +8,9 @@
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class StatusType extends AbstractType
 {
     public function configureOptions(OptionsResolver $resolver)
diff --git a/Form/Type/TicketMessageType.php b/Form/Type/TicketMessageType.php
@@ -13,6 +13,9 @@
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class TicketMessageType extends AbstractType
 {
     protected $userManager;
diff --git a/Form/Type/TicketType.php b/Form/Type/TicketType.php
@@ -8,6 +8,9 @@
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class TicketType extends AbstractType
 {
     protected $ticketClass;
diff --git a/Manager/TicketManager.php b/Manager/TicketManager.php
@@ -9,6 +9,9 @@
 use Hackzilla\Bundle\TicketBundle\TicketRole;
 use Symfony\Component\Translation\TranslatorInterface;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class TicketManager implements TicketManagerInterface
 {
     private $translator;
diff --git a/Manager/UserManager.php b/Manager/UserManager.php
@@ -10,6 +10,9 @@
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class UserManager implements UserManagerInterface
 {
     /**
@@ -59,7 +62,7 @@ public function getCurrentUser()
     public function getUserById($userId)
     {
         if (!$userId) {
-            return;
+            return null;
         }
 
         return $this->userRepository->find($userId);
diff --git a/Tests/Component/TicketFeaturesTest.php b/Tests/Component/TicketFeaturesTest.php
@@ -32,11 +32,10 @@ public function constructProvider()
     /**
      * @dataProvider featureAttachmentProvider
      *
-     * @param array     $features
      * @param string    $class
      * @param bool|null $compare
      */
-    public function testFeatureAttachment($features, $class, $compare)
+    public function testFeatureAttachment(array $features, $class, $compare)
     {
         $obj = new TicketFeatures($features, $class);
 
diff --git a/TicketRole.php b/TicketRole.php
@@ -2,6 +2,9 @@
 
 namespace Hackzilla\Bundle\TicketBundle;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class TicketRole
 {
     const ADMIN = 'ROLE_TICKET_ADMIN';
diff --git a/TwigExtension/TicketFeatureExtension.php b/TwigExtension/TicketFeatureExtension.php
@@ -6,6 +6,9 @@
 use Twig\Extension\AbstractExtension;
 use Twig\TwigFunction;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class TicketFeatureExtension extends AbstractExtension
 {
     private $ticketFeatures;
diff --git a/TwigExtension/TicketGlobalExtension.php b/TwigExtension/TicketGlobalExtension.php
@@ -5,6 +5,9 @@
 use Twig\Extension\AbstractExtension;
 use Twig\Extension\GlobalsInterface;
 
+/**
+ * @final since hackzilla/ticket-bundle 3.x.
+ */
 class TicketGlobalExtension extends AbstractExtension implements GlobalsInterface
 {
     protected $templates = [];

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,9 @@`
`9`	`9`	`use Symfony\Component\Console\Input\InputOption;`
`10`	`10`	`use Symfony\Component\Console\Output\OutputInterface;`
`11`	`11`
	`12`	`+/**`
	`13`	`+ * @final since hackzilla/ticket-bundle 3.x.`
	`14`	`+ */`
`12`	`15`	`class AutoClosingCommand extends ContainerAwareCommand`
`13`	`16`	`{`
`14`	`17`	`protected static $defaultName = 'ticket:autoclosing';`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,9 @@`
`4`	`4`
`5`	`5`	`use Hackzilla\Bundle\TicketBundle\Model\TicketFeature\MessageAttachmentInterface;`
`6`	`6`
	`7`	`+/**`
	`8`	`+ * @final since hackzilla/ticket-bundle 3.x.`
	`9`	`+ */`
`7`	`10`	`class TicketFeatures`
`8`	`11`	`{`
`9`	`12`	`private $features;`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@`
`9`	`9`	`* Ticket Attachment controller.`
`10`	`10`	`*`
`11`	`11`	`* Download attachments`
	`12`	`+ *`
	`13`	`+ * @final since hackzilla/ticket-bundle 3.x.`
`12`	`14`	`*/`
`13`	`15`	`class TicketAttachmentController extends Controller`
`14`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@`
`15`	`15`
`16`	`16`	`/**`
`17`	`17`	`* Ticket controller.`
	`18`	`+ *`
	`19`	`+ * @final since hackzilla/ticket-bundle 3.x.`
`18`	`20`	`*/`
`19`	`21`	`class TicketController extends Controller`
`20`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,9 @@`
`6`	`6`	`use Symfony\Component\DependencyInjection\ContainerBuilder;`
`7`	`7`	`use Symfony\Component\DependencyInjection\Definition;`
`8`	`8`
	`9`	`+/**`
	`10`	`+ * @final since hackzilla/ticket-bundle 3.x.`
	`11`	`+ */`
`9`	`12`	`class DoctrineOrmMappingsPass extends \Doctrine\Bundle\DoctrineBundle\DependencyInjection\Compiler\DoctrineOrmMappingsPass`
`10`	`13`	`{`
`11`	`14`	`public function __construct($driver = null, array $namespaces = [], $managerParameters = [], $enabledParameter = false, array $aliasMap = [])`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@`
`9`	`9`	`* This is the class that validates and merges configuration from your app/config files.`
`10`	`10`	`*`
`11`	`11`	`* To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html#cookbook-bundles-extension-config-class}`
	`12`	`+ *`
	`13`	`+ * @final since hackzilla/ticket-bundle 3.x.`
`12`	`14`	`*/`
`13`	`15`	`class Configuration implements ConfigurationInterface`
`14`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`	`* This is the class that loads and manages your bundle configuration.`
`12`	`12`	`*`
`13`	`13`	`* To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}`
	`14`	`+ *`
	`15`	`+ * @final since hackzilla/ticket-bundle 3.x.`
`14`	`16`	`*/`
`15`	`17`	`class HackzillaTicketExtension extends Extension`
`16`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`	`use Hackzilla\Bundle\TicketBundle\Model\TicketInterface;`
`6`	`6`	`use Symfony\Component\EventDispatcher\Event;`
`7`	`7`
	`8`	`+/**`
	`9`	`+ * @final since hackzilla/ticket-bundle 3.x.`
	`10`	`+ */`
`8`	`11`	`class TicketEvent extends Event`
`9`	`12`	`{`
`10`	`13`	`protected $ticket;`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@`
`10`	`10`	`* Class FileSubscriber.`
`11`	`11`	`*`
`12`	`12`	`* Source: https://gist.github.com/hubgit/0cdf96c296f20017fe91#file-filesubscriber-php`
	`13`	`+ *`
	`14`	`+ * @final since hackzilla/ticket-bundle 3.x.`
`13`	`15`	`*/`
`14`	`16`	`class FileSubscriber implements EventSubscriberInterface`
`15`	`17`	`{`