Merge #259

259: Fix deprecations r=brunoocasali a=norkunas

# Pull Request

## Related issue
Fixes #258

## What does this PR do?
- Fixes deprecations

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?


Co-authored-by: Tomas <norkunas.tom@gmail.com>

Author: meili-bors[bot]

.php-cs-fixer.dist.php

@@ -16,6 +16,7 @@
                 'import_functions' => false,
                 'import_constants' => false,
             ],
+            'no_superfluous_phpdoc_tags' => false,
         ]
 )
     ->setRiskyAllowed(true)

config/services.xml

@@ -12,9 +12,6 @@
                  class="Meilisearch\Bundle\EventListener\DoctrineEventSubscriber"
                  public="true">
             <argument type="service" id="search.service"/>
-            <argument type="collection"/> <!-- doctrine subscribed events -->
-            <tag name="doctrine.event_subscriber"/>
-            <tag name="doctrine_mongodb.odm.event_subscriber"/>
         </service>
 
         <service id="search.client" class="Meilisearch\Client" public="true" lazy="true">

src/Collection.php

@@ -17,9 +17,6 @@ final class Collection implements \ArrayAccess, \Countable, \IteratorAggregate
      */
     private array $items;
 
-    /**
-     * @param mixed $items
-     */
     public function __construct($items = [])
     {
         $this->items = $this->getArrayableItems($items);
@@ -30,12 +27,6 @@ public function all(): array
         return $this->items;
     }
 
-    /**
-     * @param mixed $key
-     * @param mixed $default
-     *
-     * @return mixed
-     */
     public function get($key, $default = null)
     {
         if (array_key_exists($key, $this->items)) {
@@ -151,10 +142,6 @@ public function unique($key = null, bool $strict = false)
 
     /**
      * Get the first item from the collection passing the given truth test.
-     *
-     * @param mixed $default
-     *
-     * @return mixed
      */
     public function first(callable $callback = null, $default = null)
     {
@@ -181,27 +168,18 @@ public function first(callable $callback = null, $default = null)
      * Get the first item by the given key value pair.
      *
      * @param string $key
-     * @param mixed  $operator
-     * @param mixed  $value
-     *
-     * @return mixed
      */
     public function firstWhere($key, $operator = null, $value = null)
     {
         return $this->first($this->operatorForWhere(...func_get_args()));
     }
 
-    /**
-     * @param mixed $offset
-     */
     public function offsetExists($offset): bool
     {
         return isset($this->items[$offset]);
     }
 
     /**
-     * @param mixed $offset
-     *
      * @return mixed
      */
     #[\ReturnTypeWillChange]
@@ -210,10 +188,6 @@ public function offsetGet($offset)
         return $this->items[$offset];
     }
 
-    /**
-     * @param mixed $offset
-     * @param mixed $value
-     */
     public function offsetSet($offset, $value): void
     {
         if (is_null($offset)) {
@@ -223,9 +197,6 @@ public function offsetSet($offset, $value): void
         }
     }
 
-    /**
-     * @param mixed $offset
-     */
     public function offsetUnset($offset): void
     {
         unset($this->items[$offset]);
@@ -241,9 +212,6 @@ public function getIterator(): \ArrayIterator
         return new \ArrayIterator($this->items);
     }
 
-    /**
-     * @param mixed $items
-     */
     private function getArrayableItems($items): array
     {
         if (is_array($items)) {
@@ -269,9 +237,6 @@ private function getArrayableItems($items): array
         return (array) $items;
     }
 
-    /**
-     * @param mixed $value
-     */
     private function useAsCallable($value): bool
     {
         return !is_string($value) && is_callable($value);
@@ -292,11 +257,7 @@ private function valueRetriever($value)
     }
 
     /**
-     * @param mixed                 $target
      * @param string|array|int|null $key
-     * @param mixed                 $default
-     *
-     * @return mixed
      */
     private static function getDeepData($target, $key, $default = null)
     {
@@ -358,9 +319,6 @@ public static function arrayCollapse(iterable $array): array
         return array_merge([], ...$results);
     }
 
-    /**
-     * @param mixed $value
-     */
     public static function accessible($value): bool
     {
         return is_array($value) || $value instanceof \ArrayAccess;
@@ -381,10 +339,7 @@ private static function existsInArray($array, $key): bool
         return array_key_exists($key, $array);
     }
 
-    /**
-     * @param mixed $value
-     */
-    private function operatorForWhere(string $key, ?string $operator = null, $value = null): \Closure
+    private function operatorForWhere(string $key, string $operator = null, $value = null): \Closure
     {
         if (1 === func_num_args()) {
             $value = true;

src/DependencyInjection/MeilisearchExtension.php

@@ -19,9 +19,6 @@
  */
 final class MeilisearchExtension extends Extension
 {
-    /**
-     * {@inheritdoc}
-     */
     public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__.'/../../config'));
@@ -39,7 +36,12 @@ public function load(array $configs, ContainerBuilder $container): void
         $container->setParameter('meili_symfony_version', MeilisearchBundle::qualifiedVersion());
 
         if (\count($doctrineEvents = $config['doctrineSubscribedEvents']) > 0) {
-            $container->getDefinition('search.search_indexer_subscriber')->setArgument(1, $doctrineEvents);
+            $subscriber = $container->getDefinition('search.search_indexer_subscriber');
+
+            foreach ($doctrineEvents as $event) {
+                $subscriber->addTag('doctrine.event_listener', ['event' => $event]);
+                $subscriber->addTag('doctrine_mongodb.odm.event_listener', ['event' => $event]);
+            }
         } else {
             $container->removeDefinition('search.search_indexer_subscriber');
         }

src/EventListener/DoctrineEventSubscriber.php

@@ -4,24 +4,16 @@
 
 namespace Meilisearch\Bundle\EventListener;
 
-use Doctrine\Common\EventSubscriber;
 use Doctrine\Persistence\Event\LifecycleEventArgs;
 use Meilisearch\Bundle\SearchService;
 
-final class DoctrineEventSubscriber implements EventSubscriber
+final class DoctrineEventSubscriber
 {
     private SearchService $searchService;
-    private array $subscribedEvents;
 
-    public function __construct(SearchService $searchService, array $subscribedEvents)
+    public function __construct(SearchService $searchService)
     {
         $this->searchService = $searchService;
-        $this->subscribedEvents = $subscribedEvents;
-    }
-
-    public function getSubscribedEvents(): array
-    {
-        return $this->subscribedEvents;
     }
 
     public function postUpdate(LifecycleEventArgs $args): void

src/Model/Aggregator.php

@@ -78,10 +78,7 @@ public static function getEntityClassFromObjectID(string $objectId): string
         throw new EntityNotFoundInObjectID("Entity class from ObjectID $objectId not found.");
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function normalize(NormalizerInterface $normalizer, ?string $format = null, array $context = []): array
+    public function normalize(NormalizerInterface $normalizer, string $format = null, array $context = []): array
     {
         return array_merge(['objectID' => $this->objectID], $normalizer->normalize($this->entity, $format, $context));
     }

src/SearchableEntity.php

@@ -43,7 +43,7 @@ public function __construct(
         string $indexUid,
         $entity,
         ClassMetadata $entityMetadata,
-        ?NormalizerInterface $normalizer = null,
+        NormalizerInterface $normalizer = null,
         array $extra = []
     ) {
         $this->indexUid = $indexUid;

src/Services/MeilisearchService.php

@@ -46,9 +46,6 @@ public function __construct(NormalizerInterface $normalizer, Engine $engine, arr
         $this->setIndexIfMapping();
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function isSearchable($className): bool
     {
         if (is_object($className)) {
@@ -68,9 +65,6 @@ public function getConfiguration(): Collection
         return $this->configuration;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function searchableAs(string $className): string
     {
         $indexes = new Collection($this->getConfiguration()->get('indices'));
@@ -185,9 +179,6 @@ public function search(
         return $results;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function rawSearch(
         string $className,
         string $query = '',

tests/Entity/Link.php

@@ -91,9 +91,6 @@ public function setIsSponsored(bool $isSponsored): Link
         return $this;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public function normalize(NormalizerInterface $normalizer, $format = null, array $context = []): array
     {
         if (Searchable::NORMALIZATION_FORMAT === $format) {

tests/Entity/Page.php

@@ -27,7 +27,7 @@ class Page
     #[ORM\Id]
     #[ORM\GeneratedValue(strategy: 'NONE')]
     #[ORM\Column(type: Types::OBJECT)]
-    private $id = null;
+    private $id;
 
     /**
      * @ORM\Column(type="string", nullable=true)