feat: replace doctrine annotation to php attribute

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ jobs:
       fail-fast: false
       matrix:
         operating-system: [ ubuntu-latest ]
-        php-versions: [ '8.0', '8.1', '8.2' ]
+        php-versions: [ '8.1', '8.2', '8.3' ]
 
     steps:
       - name: Checkout
@@ -41,7 +41,7 @@ jobs:
         run: composer install --no-progress --prefer-dist --optimize-autoloader
       - name: Install Other dependencies
         run: |
-          curl -L https://github.com/php-coveralls/php-coveralls/releases/download/v2.4.3/php-coveralls.phar -o /usr/local/bin/php-coveralls
+          curl -L https://github.com/php-coveralls/php-coveralls/releases/download/v2.7.0/php-coveralls.phar -o /usr/local/bin/php-coveralls
           chmod +x /usr/local/bin/php-coveralls
           mkdir -p build/logs
       - name: Run tests

Annotation/SubscribeDoctrineEvents.php → Attribute/SubscribeDoctrineEvents.php

@@ -9,16 +9,15 @@
  * with this source code in the file LICENSE.
  */
 
-namespace Xiidea\EasyAuditBundle\Annotation;
+namespace Xiidea\EasyAuditBundle\Attribute;
 
 /**
- * Annotation for ORM Subscribed Event.
- *
- * @Annotation
- * @Target({"CLASS"})
+ * Attribute for ORM Subscribed Event.
  *
  * @author Roni Saha <[email protected]>
  */
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
 /* @final */ class SubscribeDoctrineEvents
 {
     public $events = array();

DependencyInjection/Compiler/LoggerFactoryPass.php

@@ -17,6 +17,7 @@
 
 class LoggerFactoryPass implements CompilerPassInterface
 {
+    #[\Override]
     public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasDefinition('xiidea.easy_audit.logger_factory')) {

DependencyInjection/Compiler/MonologLoggerPass.php

@@ -16,6 +16,7 @@
 
 class MonologLoggerPass implements CompilerPassInterface
 {
+    #[\Override]
     public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasAlias('logger')) {

DependencyInjection/Compiler/ResolverFactoryPass.php

@@ -17,6 +17,7 @@
 
 class ResolverFactoryPass implements CompilerPassInterface
 {
+    #[\Override]
     public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasDefinition('xiidea.easy_audit.event_resolver_factory')) {

DependencyInjection/Compiler/SubscriberPass.php

@@ -17,6 +17,7 @@
 
 class SubscriberPass implements CompilerPassInterface
 {
+    #[\Override]
     public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasDefinition('xiidea.easy_audit.event_listener')) {

DependencyInjection/Configuration.php

@@ -28,6 +28,7 @@ class Configuration implements ConfigurationInterface
     /**
      * {@inheritdoc}
      */
+    #[\Override]
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder(self::ROOT_NODE_NAME);
@@ -148,7 +149,7 @@ public static function throwExceptionOnInvalid($invalid)
 
     public static function appendChannelTypes($element, &$isExclusiveList, &$elements = array())
     {
-        $isExclusiveItem = 0 === strpos($element, '!');
+        $isExclusiveItem = str_starts_with($element, '!');
 
         self::throwExceptionOnInvalid(!$isExclusiveItem === $isExclusiveList);
 

DependencyInjection/XiideaEasyAuditExtension.php

@@ -28,6 +28,7 @@ class XiideaEasyAuditExtension extends Extension implements PrependExtensionInte
     /**
      * {@inheritdoc}
      */
+    #[\Override]
     public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();
@@ -72,6 +73,7 @@ protected function loadDefaultResolverServices($config, LoaderInterface $loader)
      * Allow an extension to prepend the extension configurations.
      * @param ContainerBuilder $container
      */
+    #[\Override]
     public function prepend(ContainerBuilder $container): void
     {
         $prependConfig = $this->getExtendedConfig($container);

Events/DoctrineObjectEvent.php

@@ -15,17 +15,8 @@
 
 class DoctrineObjectEvent extends Event
 {
-    private $identity;
-
-    /**
-     * @var LifecycleEventArgs
-     */
-    private $lifecycleEventArgs;
-
-    public function __construct(LifecycleEventArgs $lifecycleEventArgs, $identity)
+    public function __construct(private LifecycleEventArgs $lifecycleEventArgs, private $identity)
     {
-        $this->lifecycleEventArgs = $lifecycleEventArgs;
-        $this->identity = $identity;
     }
 
     /**

Listener/LogEventsListener.php

@@ -17,19 +17,8 @@
 
 class LogEventsListener
 {
-    /**
-     * @var LoggerFactory
-     */
-    private $loggerFactory;
-    /**
-     * @var \Xiidea\EasyAuditBundle\Resolver\EventResolverFactory
-     */
-    private $resolverFactory;
-
-    public function __construct(LoggerFactory $loggerFactory, EventResolverFactory $resolverFactory)
+    public function __construct(private LoggerFactory $loggerFactory, private EventResolverFactory $resolverFactory)
     {
-        $this->loggerFactory = $loggerFactory;
-        $this->resolverFactory = $resolverFactory;
     }
 
     public function resolveEventHandler(Event $event, $eventName)

Logger/Logger.php

@@ -20,16 +20,11 @@ class Logger implements LoggerInterface
 {
     private $entityDeleteLogs = [];
 
-    /**
-     * @var \Doctrine\Persistence\ManagerRegistry
-     */
-    private $doctrine;
-
-    public function __construct(ManagerRegistry $doctrine)
+    public function __construct(private ManagerRegistry $doctrine)
     {
-        $this->doctrine = $doctrine;
     }
 
+    #[\Override]
     public function log(AuditLog $event = null)
     {
         if (empty($event)) {

Logger/LoggerFactory.php

@@ -19,13 +19,10 @@ class LoggerFactory
     /** @var LoggerInterface[] */
     private static $loggers = array();
 
-    private $loggersChannel;
-
     private $debug = false;
 
-    public function __construct(array $channel = array())
+    public function __construct(private array $loggersChannel = array())
     {
-        $this->loggersChannel = $channel;
     }
 
     /**
@@ -116,10 +113,7 @@ protected function isValidLoggerForThisEvent(BaseAuditLog $eventInfo, $logger, $
         return $logger instanceof LoggerInterface && $this->isChannelRegisterWithLogger($id, $eventInfo->getLevel());
     }
 
-    /**
-     * @param mixed $debug
-     */
-    public function setDebug($debug)
+    public function setDebug(mixed $debug)
     {
         $this->debug = $debug;
     }

Logger/MonologLogger.php

@@ -17,18 +17,13 @@
 
 class MonologLogger implements LoggerInterface
 {
-    /**
-     * @var \Psr\Log\LoggerInterface
-     */
-    private $logger;
-
     private static $ignoreProperties = array('description', 'id', 'level');
 
-    public function __construct(\Psr\Log\LoggerInterface $logger)
+    public function __construct(private \Psr\Log\LoggerInterface $logger)
     {
-        $this->logger = $logger;
     }
 
+    #[\Override]
     public function log(AuditLog $event = null)
     {
         if (null === $event) {

Model/BaseAuditLog.php

@@ -190,10 +190,7 @@ public function getImpersonatingUser()
         return $this->impersonatingUser;
     }
 
-    /**
-     * @param mixed $impersonatingUser
-     */
-    public function setImpersonatingUser($impersonatingUser)
+    public function setImpersonatingUser(mixed $impersonatingUser)
     {
         $this->impersonatingUser = $impersonatingUser;
     }

Resolver/DefaultEventResolver.php

@@ -21,6 +21,7 @@ class DefaultEventResolver implements EventResolverInterface
      *
      * @return array
      */
+    #[\Override]
     public function getEventLogInfo(Event $event, $eventName)
     {
         return array(

Resolver/DoctrineObjectEventResolver.php

@@ -49,6 +49,7 @@ class DoctrineObjectEventResolver implements EventResolverInterface
      *
      * @throws \ReflectionException
      */
+    #[\Override]
     public function getEventLogInfo(Event $event, $eventName)
     {
         if (!$event instanceof DoctrineObjectEvent) {

Resolver/EventResolverFactory.php

@@ -31,11 +31,7 @@ class EventResolverFactory extends UserAwareComponent
      */
     private $entityEventResolver;
 
-    private $resolverEventMap = array();
-
     private $debug = false;
-    private $userProperty;
-    private $entityClass;
 
     /**
      * EventResolverFactory constructor.
@@ -44,11 +40,8 @@ class EventResolverFactory extends UserAwareComponent
      * @param $userProperty
      * @param $entityClass
      */
-    public function __construct(array $resolverEventMap = array(), $userProperty = 'userIdentifier', $entityClass = BaseAuditLog::class)
+    public function __construct(private array $resolverEventMap = array(), private $userProperty = 'userIdentifier', private $entityClass = BaseAuditLog::class)
     {
-        $this->resolverEventMap = $resolverEventMap;
-        $this->userProperty = $userProperty;
-        $this->entityClass = $entityClass;
     }
 
     /**
@@ -195,11 +188,9 @@ public function addCustomResolver($id, $resolver)
     }
 
     /**
-     * @param mixed $resolver
-     *
      * @throws \Exception
      */
-    public function setCommonResolver($resolver)
+    public function setCommonResolver(mixed $resolver)
     {
         if (!$resolver instanceof EventResolverInterface) {
             $this->commonResolver = $this->handleException(new InvalidServiceException(
@@ -280,10 +271,7 @@ protected function setImpersonatingUser(BaseAuditLog $entity, $userProperty)
         }
     }
 
-    /**
-     * @param mixed $debug
-     */
-    public function setDebug($debug)
+    public function setDebug(mixed $debug)
     {
         $this->debug = $debug;
     }

Resolver/UserEventCommand/InteractiveLoginCommand.php

@@ -15,21 +15,16 @@
 
 class InteractiveLoginCommand extends UserLoginCommand
 {
-    /**
-     * @var UserAwareComponent
-     */
-    private $userAwareComponent;
-
-    public function __construct(UserAwareComponent $userAwareComponent)
+    public function __construct(private UserAwareComponent $userAwareComponent)
     {
-        $this->userAwareComponent = $userAwareComponent;
     }
 
     /**
      * @param $event
      *
      * @return mixed
      */
+    #[\Override]
     public function resolve($event)
     {
         return $this->getEventDetailsArray($this->userAwareComponent->getUsername());

Resolver/UserEventCommand/UserLoginCommand.php

@@ -16,6 +16,7 @@ abstract class UserLoginCommand extends ResolverCommand
     /**
      * @return string
      */
+    #[\Override]
     public function getType()
     {
         return 'User Logged in';
@@ -24,6 +25,7 @@ public function getType()
     /**
      * @return string
      */
+    #[\Override]
     public function getTemplate()
     {
         return "User '%s' Logged in Successfully";

Resolver/UserEventResolver.php

@@ -36,6 +36,7 @@ public function __construct()
      *
      * @return array
      */
+    #[\Override]
     public function getEventLogInfo(Event $event, $eventName)
     {
         $this->default = array(

Resources/config/doctrine_services.yml

@@ -5,7 +5,6 @@ services:
           arguments: ['%xiidea.easy_audit.doctrine_objects%']
           calls:
               - [ setDispatcher,[ '@event_dispatcher' ] ]
-              - [ setAnnotationReader,[ '@annotation_reader' ] ]
           tags:
               - { name: doctrine.event_listener, event: preRemove }
               - { name: doctrine.event_listener, event: postUpdate }

Subscriber/DoctrineDeleteEventLogger.php

@@ -18,19 +18,13 @@
 
 class DoctrineDeleteEventLogger implements EventSubscriberInterface
 {
-    /**
-     * @var Logger
-     */
-    private $logger;
-
     /**
      * DoctrineDeleteEventLogger constructor.
      *
      * @param Logger $logger
      */
-    public function __construct(Logger $logger)
+    public function __construct(private Logger $logger)
     {
-        $this->logger = $logger;
     }
 
     public function savePendingLogs()
@@ -41,6 +35,7 @@ public function savePendingLogs()
     /**
      * @return array
      */
+    #[\Override]
     public static function getSubscribedEvents(): array
     {
         return [