chore: Deprecate Handlers methods

roadiz · Mar 14, 2024 · 9d0c560 · 9d0c560
1 parent 57a33f2
commit 9d0c560
Show file tree

Hide file tree

Showing 9 changed files with 446 additions and 85 deletions.
diff --git a/src/EntityHandler/NodeHandler.php b/src/EntityHandler/NodeHandler.php
@@ -239,6 +239,7 @@ public function getReverseNodesFromFieldName(string $fieldName): array
      * @param Translation $translation
      *
      * @return null|NodesSources
+     * @deprecated Use Node::getNodeSourcesByTranslation() instead.
      */
     public function getNodeSourceByTranslation($translation): ?NodesSources
     {
@@ -397,17 +398,6 @@ public function archiveWithChildren(): self
         return $this;
     }
 
-    /**
-     * Return if is in Newsletter Node.
-     *
-     * @deprecated Just here not to break themes.
-     * @return bool
-     */
-    public function isRelatedToNewsletter(): bool
-    {
-        return false;
-    }
-
     /**
      * Return if part of Node offspring.
      *
@@ -538,6 +528,7 @@ public function cleanRootNodesPositions(bool $setPositions = true): float
      * Return all node offspring id.
      *
      * @return array
+     * @deprecated Use NodeRepository::findAllOffspringIdByNode() instead.
      */
     public function getAllOffspringId(): array
     {
@@ -589,6 +580,7 @@ public function duplicate(): Node
      *
      * @return Node|null
      * @throws NonUniqueResultException
+     * @deprecated Use NodeRepository::findPreviousNode() instead.
      */
     public function getPrevious(
         ?array $criteria = null,
@@ -626,10 +618,12 @@ public function getPrevious(
     /**
      * Get next node from hierarchy.
      *
-     * @param  array|null $criteria
-     * @param  array|null $order
+     * @param array|null $criteria
+     * @param array|null $order
      *
      * @return Node|null
+     * @throws NonUniqueResultException
+     * @deprecated Use NodeRepository::findNextNode() instead.
      */
     public function getNext(
         ?array $criteria = null,
@@ -664,7 +658,7 @@ public function getNext(
     /**
      * @return NodeRepository
      */
-    public function getRepository(): NodeRepository
+    protected function getRepository(): NodeRepository
     {
         return $this->objectManager->getRepository(Node::class);
     }

diff --git a/src/EntityHandler/NodesSourcesHandler.php b/src/EntityHandler/NodesSourcesHandler.php
@@ -120,6 +120,7 @@ public function addDocumentForField(
      *
      * @param string $fieldName Name of the node-type field
      * @return array<Document>
+     * @deprecated Use directly NodesSources::getDocumentsByFieldsWithName
      */
     public function getDocumentsFromFieldName(string $fieldName): array
     {
@@ -168,7 +169,7 @@ public function getParent(): ?NodesSources
      *
      * @param array|null $criteria
      * @return array<NodesSources>
-     * @throws \Doctrine\ORM\NonUniqueResultException
+     * @deprecated Use NodesSourcesRepository::findParents
      */
     public function getParents(
         array $criteria = null
@@ -213,6 +214,7 @@ public function getParents(
      * @param array|null $order Non default ordering
      *
      * @return array<object|NodesSources>
+     * @deprecated Use TreeWalker or NodesSourcesRepository::findChildren
      */
     public function getChildren(
         array $criteria = null,
@@ -248,6 +250,7 @@ public function getChildren(
      * @param array|null $order
      *
      * @return NodesSources|null
+     * @deprecated Use NodesSourcesRepository::findFirstChild
      */
     public function getFirstChild(
         array $criteria = null,
@@ -282,6 +285,7 @@ public function getFirstChild(
      * @param  array|null $order
      *
      * @return NodesSources|null
+     * @deprecated Use NodesSourcesRepository::findLastChild
      */
     public function getLastChild(
         array $criteria = null,
@@ -317,6 +321,7 @@ public function getLastChild(
      * @param  array|null $order
      *
      * @return NodesSources|null
+     * @deprecated Use NodesSourcesRepository::findFirstSibling
      */
     public function getFirstSibling(
         array $criteria = null,
@@ -339,6 +344,7 @@ public function getFirstSibling(
      * @param array|null $order
      *
      * @return NodesSources|null
+     * @deprecated Use NodesSourcesRepository::findLastSibling
      */
     public function getLastSibling(
         array $criteria = null,
@@ -361,6 +367,7 @@ public function getLastSibling(
      * @param array|null $order
      *
      * @return NodesSources|null
+     * @deprecated Use NodesSourcesRepository::findPrevious
      */
     public function getPrevious(
         array $criteria = null,
@@ -407,6 +414,7 @@ public function getPrevious(
      * @param array|null $order
      *
      * @return NodesSources|null
+     * @deprecated Use NodesSourcesRepository::findNext
      */
     public function getNext(
         array $criteria = null,
@@ -446,6 +454,7 @@ public function getNext(
      * Get node tags with current source translation.
      *
      * @return iterable<Tag>
+     * @deprecated Use TagRepository::findByNodesSources
      */
     public function getTags(): iterable
     {

diff --git a/src/Message/Handler/ApplyRealmNodeInheritanceMessageHandler.php b/src/Message/Handler/ApplyRealmNodeInheritanceMessageHandler.php
@@ -17,13 +17,8 @@
 
 final class ApplyRealmNodeInheritanceMessageHandler implements MessageHandlerInterface
 {
-    private ManagerRegistry $managerRegistry;
-    private HandlerFactoryInterface $handlerFactory;
-
-    public function __construct(ManagerRegistry $managerRegistry, HandlerFactoryInterface $handlerFactory)
+    public function __construct(private readonly ManagerRegistry $managerRegistry)
     {
-        $this->managerRegistry = $managerRegistry;
-        $this->handlerFactory = $handlerFactory;
     }
 
     public function __invoke(ApplyRealmNodeInheritanceMessage $message): void
@@ -53,15 +48,12 @@ public function __invoke(ApplyRealmNodeInheritanceMessage $message): void
             return;
         }
 
-        /** @var NodeHandler $nodeHandler */
-        $nodeHandler = $this->handlerFactory->getHandler($node);
-        $childrenIds = $nodeHandler->getAllOffspringId();
+        $nodeRepository = $this->managerRegistry->getRepository(Node::class);
+        $childrenIds = $nodeRepository->findAllOffspringIdByNode($node);
 
         foreach ($childrenIds as $childId) {
             /** @var Node|null $child */
-            $child = $this->managerRegistry
-                ->getRepository(Node::class)
-                ->find($childId);
+            $child = $nodeRepository->find($childId);
             if (null === $child) {
                 continue;
             }

diff --git a/src/Message/Handler/CleanRealmNodeInheritanceMessageHandler.php b/src/Message/Handler/CleanRealmNodeInheritanceMessageHandler.php
@@ -16,13 +16,8 @@
 
 final class CleanRealmNodeInheritanceMessageHandler implements MessageHandlerInterface
 {
-    private ManagerRegistry $managerRegistry;
-    private HandlerFactoryInterface $handlerFactory;
-
-    public function __construct(ManagerRegistry $managerRegistry, HandlerFactoryInterface $handlerFactory)
+    public function __construct(private readonly ManagerRegistry $managerRegistry)
     {
-        $this->managerRegistry = $managerRegistry;
-        $this->handlerFactory = $handlerFactory;
     }
 
     public function __invoke(CleanRealmNodeInheritanceMessage $message): void
@@ -40,9 +35,8 @@ public function __invoke(CleanRealmNodeInheritanceMessage $message): void
             throw new UnrecoverableMessageHandlingException('Realm does not exist');
         }
 
-        /** @var NodeHandler $nodeHandler */
-        $nodeHandler = $this->handlerFactory->getHandler($node);
-        $childrenIds = $nodeHandler->getAllOffspringId();
+        $nodeRepository = $this->managerRegistry->getRepository(Node::class);
+        $childrenIds = $nodeRepository->findAllOffspringIdByNode($node);
 
         $realmNodes = $this->managerRegistry
             ->getRepository(RealmNode::class)

diff --git a/src/Repository/NodeRepository.php b/src/Repository/NodeRepository.php
@@ -1159,4 +1159,74 @@ protected function classicLikeComparison(
         $qb->orWhere($qb->expr()->like('LOWER(' . $alias . '.nodeName)', $qb->expr()->literal($value)));
         return $qb;
     }
+
+    /**
+     * Get previous node from hierarchy
+     */
+    public function findPreviousNode(
+        Node $node,
+        ?array $criteria = null,
+        ?array $order = null
+    ): ?Node {
+        if ($node->getPosition() <= 1) {
+            return null;
+        }
+        if (null === $order) {
+            $order = [];
+        }
+
+        if (null === $criteria) {
+            $criteria = [];
+        }
+
+        $criteria['parent'] = $node->getParent();
+        /*
+         * Use < operator to get first previous nodeSource
+         * even if it’s not the previous position index
+         */
+        $criteria['position'] = [
+            '<',
+            $node->getPosition(),
+        ];
+
+        $order['position'] = 'DESC';
+
+        return $this->findOneBy(
+            $criteria,
+            $order
+        );
+    }
+
+    /**
+     * Get next node from hierarchy.
+     */
+    public function findNextNode(
+        Node $node,
+        ?array $criteria = null,
+        ?array $order = null
+    ): ?Node {
+        if (null === $criteria) {
+            $criteria = [];
+        }
+        if (null === $order) {
+            $order = [];
+        }
+
+        $criteria['parent'] = $node->getParent();
+
+        /*
+         * Use > operator to get first next nodeSource
+         * even if it’s not the next position index
+         */
+        $criteria['position'] = [
+            '>',
+            $node->getPosition(),
+        ];
+        $order['position'] = 'ASC';
+
+        return $this->findOneBy(
+            $criteria,
+            $order
+        );
+    }
 }