BAP-22772: Use override attribute instead of inheritdoc annotations (…

…#39344) - Updated php-cs-fixer config - Applied new cs rules - Deleted annotations like "{@inheritdoc}" - Rector AddOverrideAttributeToOverriddenMethodsRector rule applied - Updated documentation
oroinc · Sep 24, 2024 · 0249850 · 0249850
1 parent b94419d
commit 0249850
Show file tree

Hide file tree

Showing 246 changed files with 421 additions and 843 deletions.
diff --git a/Autocomplete/AttendeeSearchHandler.php b/Autocomplete/AttendeeSearchHandler.php
@@ -12,9 +12,7 @@ class AttendeeSearchHandler extends ContextSearchHandler
     /** @var AttendeeManager */
     protected $attendeeManager;
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     protected function convertItems(array $items)
     {
         $groupped = $this->groupIdsByEntityName($items);
@@ -67,9 +65,7 @@ protected function groupIdsByEntityName(array $items)
         return $groupped;
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     protected function getSearchAliases()
     {
         return ['oro_user'];

diff --git a/Autocomplete/UserCalendarHandler.php b/Autocomplete/UserCalendarHandler.php
@@ -48,9 +48,7 @@ public function __construct(
         $this->aclHelper = $aclHelper;
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    #[\Override]
     public function search($query, $page, $perPage, $searchById = false)
     {
         [$search, $entityClass, $permission, $entityId, $excludeCurrentUser] = explode(';', $query);
@@ -100,25 +98,19 @@ public function search($query, $page, $perPage, $searchById = false)
         ];
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    #[\Override]
     public function getProperties()
     {
         return ['id'];
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    #[\Override]
     public function getEntityName()
     {
         return Calendar::class;
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    #[\Override]
     public function convertItem($item)
     {
         /** @var Calendar $item */

diff --git a/Controller/AjaxCalendarEventController.php b/Controller/AjaxCalendarEventController.php
@@ -124,9 +124,7 @@ public function attendeesAutocompleteDataAction($id)
         ]);
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     public static function getSubscribedServices(): array
     {
         return array_merge(

diff --git a/Controller/Api/Rest/CalendarConnectionController.php b/Controller/Api/Rest/CalendarConnectionController.php
@@ -96,6 +96,7 @@ public function deleteAction($id)
     /**
      * @return CalendarPropertyApiEntityManager
      */
+    #[\Override]
     public function getManager()
     {
         return $this->container->get('oro_calendar.calendar_property.manager.api');
@@ -104,6 +105,7 @@ public function getManager()
     /**
      * @return Form
      */
+    #[\Override]
     public function getForm()
     {
         return $this->container->get('oro_calendar.calendar_property.form.api');
@@ -112,14 +114,13 @@ public function getForm()
     /**
      * @return ApiFormHandler
      */
+    #[\Override]
     public function getFormHandler()
     {
         return $this->container->get('oro_calendar.calendar_property.form.handler.api');
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     protected function fixFormData(array &$data, $entity)
     {
         parent::fixFormData($data, $entity);

diff --git a/Controller/Api/Rest/CalendarController.php b/Controller/Api/Rest/CalendarController.php
@@ -56,6 +56,7 @@ public function getDefaultAction()
         return new Response(json_encode($result), Response::HTTP_OK);
     }
 
+    #[\Override]
     public static function getSubscribedServices(): array
     {
         return array_merge(

diff --git a/Controller/Api/Rest/CalendarEventController.php b/Controller/Api/Rest/CalendarEventController.php
@@ -301,6 +301,7 @@ public function deleteAction(int $id)
     /**
      * @return ApiEntityManager
      */
+    #[\Override]
     public function getManager()
     {
         return $this->container->get('oro_calendar.calendar_event.manager.api');
@@ -309,6 +310,7 @@ public function getManager()
     /**
      * @return Form
      */
+    #[\Override]
     public function getForm()
     {
         return $this->container->get('oro_calendar.calendar_event.form.api');
@@ -317,14 +319,13 @@ public function getForm()
     /**
      * @return ApiFormHandler
      */
+    #[\Override]
     public function getFormHandler()
     {
         return $this->container->get('oro_calendar.calendar_event.form.handler.api');
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     public function handleUpdateRequest($id)
     {
         /** @var CalendarEvent $entity */
@@ -350,9 +351,7 @@ public function handleUpdateRequest($id)
         return $this->buildResponse($view, self::ACTION_UPDATE, ['id' => $id, 'entity' => $entity]);
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     public function handleCreateRequest($_ = null)
     {
         $isProcessed = false;
@@ -375,9 +374,7 @@ public function handleCreateRequest($_ = null)
         return $this->buildResponse($view, self::ACTION_CREATE, ['success' => $isProcessed, 'entity' => $entity]);
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     protected function fixFormData(array &$data, $entity)
     {
         parent::fixFormData($data, $entity);
@@ -420,9 +417,7 @@ function (ConfigInterface $config) {
         );
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     protected function createResponseData($entity)
     {
         $response        = parent::createResponseData($entity);

diff --git a/Controller/Api/Rest/SystemCalendarController.php b/Controller/Api/Rest/SystemCalendarController.php
@@ -28,26 +28,20 @@ public function deleteAction(int $id)
         return $this->handleDeleteRequest($id);
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     public function getManager()
     {
         return $this->container->get('oro_calendar.system_calendar.manager.api');
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     public function getForm()
     {
         throw new \BadMethodCallException('Not implemented');
         //return $this->container->get('oro_calendar.system_calendar.form.api');
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     public function getFormHandler()
     {
         throw new \BadMethodCallException('Not implemented');

diff --git a/Controller/AutocompleteController.php b/Controller/AutocompleteController.php
@@ -62,9 +62,7 @@ public function autocompleteAttendeesAction(Request $request)
         ));
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     public static function getSubscribedServices(): array
     {
         return array_merge(

diff --git a/Controller/CalendarController.php b/Controller/CalendarController.php
@@ -107,9 +107,7 @@ public function viewAction(Calendar $calendar)
         ];
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     public static function getSubscribedServices(): array
     {
         return array_merge(

diff --git a/Controller/CalendarEventController.php b/Controller/CalendarEventController.php
@@ -268,9 +268,7 @@ protected function checkPermissionByParentCalendar(CalendarEvent $entity, $actio
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     public static function getSubscribedServices(): array
     {
         return array_merge(

diff --git a/Controller/Dashboard/DashboardController.php b/Controller/Dashboard/DashboardController.php
@@ -84,9 +84,7 @@ public function myCalendarAction($widget)
         );
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     public static function getSubscribedServices(): array
     {
         return array_merge(parent::getSubscribedServices(), [

diff --git a/Controller/SystemCalendarController.php b/Controller/SystemCalendarController.php
@@ -191,9 +191,7 @@ private function isSystemCalendarManagementEnabled(): bool
         return $this->isGranted('oro_system_calendar_management');
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     public static function getSubscribedServices(): array
     {
         return array_merge(

diff --git a/Controller/SystemCalendarEventController.php b/Controller/SystemCalendarEventController.php
@@ -234,9 +234,7 @@ protected function getCalendarConfig(): SystemCalendarConfig
         return $this->container->get(SystemCalendarConfig::class);
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     public static function getSubscribedServices(): array
     {
         return array_merge(

diff --git a/Datagrid/MassAction/DeleteMassActionHandler.php b/Datagrid/MassAction/DeleteMassActionHandler.php
@@ -19,9 +19,7 @@ public function setDeleteManager(DeleteManager $deleteManager): void
         $this->deleteManager = $deleteManager;
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    #[\Override]
     protected function processDelete(object $entity, EntityManagerInterface $manager): void
     {
         /** @var CalendarEvent $entity */

diff --git a/DependencyInjection/Compiler/CalendarProviderPass.php b/DependencyInjection/Compiler/CalendarProviderPass.php
@@ -15,9 +15,7 @@ class CalendarProviderPass implements CompilerPassInterface
 {
     use PriorityTaggedLocatorTrait;
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     public function process(ContainerBuilder $container): void
     {
         $tagName = 'oro_calendar.calendar_provider';

diff --git a/DependencyInjection/Compiler/TwigSandboxConfigurationPass.php b/DependencyInjection/Compiler/TwigSandboxConfigurationPass.php
@@ -12,9 +12,7 @@
  */
 class TwigSandboxConfigurationPass extends AbstractTwigSandboxConfigurationPass
 {
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     protected function getFunctions(): array
     {
         return [
@@ -24,25 +22,19 @@ protected function getFunctions(): array
         ];
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     protected function getFilters(): array
     {
         return [];
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     protected function getTags(): array
     {
         return [];
     }
 
-    /**
-     * {@inheritdoc}
-     */
+    #[\Override]
     protected function getExtensions(): array
     {
         return [

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -8,9 +8,7 @@
 
 class Configuration implements ConfigurationInterface
 {
-    /**
-     * {@inheritDoc}
-     */
+    #[\Override]
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('oro_calendar');

diff --git a/DependencyInjection/OroCalendarExtension.php b/DependencyInjection/OroCalendarExtension.php
@@ -10,9 +10,7 @@
 
 class OroCalendarExtension extends Extension
 {
-    /**
-     * {@inheritDoc}
-     */
+    #[\Override]
     public function load(array $configs, ContainerBuilder $container): void
     {
         $config = $this->processConfiguration($this->getConfiguration($configs, $container), $configs);

diff --git a/Entity/Attendee.php b/Entity/Attendee.php
@@ -85,6 +85,7 @@ public function getId()
     /**
      * @return string
      */
+    #[\Override]
     public function getEmail()
     {
         return $this->email;
@@ -237,6 +238,7 @@ public function preUpdate()
     /**
      * @return string
      */
+    #[\Override]
     public function __toString()
     {
         return (string) $this->displayName;

diff --git a/Entity/Calendar.php b/Entity/Calendar.php
@@ -75,6 +75,7 @@ public function __construct()
     /**
      * @return string
      */
+    #[\Override]
     public function __toString()
     {
         return empty($this->name)