Add command to clean orphaned components and groups

Author: silverbackdan

src/Command/CleanOrphanedCommand.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Silverback\ApiComponentsBundle\Command;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Silverback\ApiComponentsBundle\Entity\Core\AbstractComponent;
+use Silverback\ApiComponentsBundle\Entity\Core\ComponentGroup;
+use Silverback\ApiComponentsBundle\Helper\OrphanedResourceHelper;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\ProgressBar;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+#[AsCommand(name: 'silverback:api-components:clean-orphaned')]
+class CleanOrphanedCommand extends Command
+{
+    public function __construct(private readonly OrphanedResourceHelper $orphanedResourceHelper, private readonly EntityManagerInterface $entityManager)
+    {
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setDescription('Checks every component and component group and will delete all orphaned components.')
+            ->setDefinition([]);
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $count = 0;
+        $componentGroupRepository = $this->entityManager->getRepository(ComponentGroup::class);
+        $componentGroups = $componentGroupRepository->findAll();
+        $groupsProgressBar = new ProgressBar($output, count($componentGroups));
+        $groupsProgressBar->start();
+        foreach ($componentGroups as $componentGroup) {
+            $groupsProgressBar->advance();
+            if ($this->orphanedResourceHelper->checkAndRemoveOrphanedComponentGroup($componentGroup)) {
+                $count++;
+            }
+        }
+        $groupsProgressBar->finish();
+
+        $componentRepository = $this->entityManager->getRepository(AbstractComponent::class);
+        $components = $componentRepository->findAll();
+        $componentsProgressBar = new ProgressBar($output, count($componentGroups));
+        $componentsProgressBar->start();
+        foreach ($components as $component) {
+            $componentsProgressBar->advance();
+            if ($this->orphanedResourceHelper->checkAndRemoveOrphanedComponent($component)) {
+                $count++;
+            }
+        }
+        $componentsProgressBar->finish();
+
+        $output->writeln(\sprintf('Removed <comment>%d</comment> orphaned components (excluding cascades)', $count));
+        return 0;
+    }
+}

src/Helper/OrphanedResourceHelper.php

@@ -16,7 +16,7 @@
 use Silverback\ApiComponentsBundle\Metadata\Factory\PageDataMetadataFactoryInterface;
 use Symfony\Component\PropertyAccess\PropertyAccess;
 
-final class OrphanedResourceHelper
+final readonly class OrphanedResourceHelper
 {
     public function __construct(
         private PageDataMetadataFactoryInterface $pageDataMetadataFactory,
@@ -63,6 +63,28 @@ public function handleRemovedRoutable(RoutableInterface $resource): void {
         }
     }
 
+    public function checkAndRemoveOrphanedComponentGroup(ComponentGroup $componentGroup): bool {
+        if ($componentGroup->pages->count() || $componentGroup->layouts->count() || $componentGroup->components->count()) {
+            return false;
+        }
+        $groupManager = $this->registry->getManagerForClass(ComponentGroup::class);
+
+        $positionManager = $this->registry->getManagerForClass(ComponentPosition::class);
+        foreach ($componentGroup->componentPositions as $componentPosition) {
+            $positionManager?->remove($componentPosition);
+            $this->removeOrphanedComponentPosition($componentPosition);
+        }
+
+        $groupManager?->remove($componentGroup);
+        $groupManager?->flush();
+        $positionManager?->flush();
+        return true;
+    }
+
+    public function checkAndRemoveOrphanedComponent(AbstractComponent $component): bool {
+        return $this->removeOrphanedComponent($component, 0, true);
+    }
+
     private function isComponentGroupInOtherLocations(ComponentGroup $componentGroup, AbstractComponent|Page|Layout|null $deletedLocation = null): bool
     {
         if (!$deletedLocation) {
@@ -109,13 +131,20 @@ private function removeOrphanedComponentPosition(ComponentPosition $componentPos
         }
     }
 
-    private function removeOrphanedComponent(ComponentInterface $component): void
+    private function removeOrphanedComponent(ComponentInterface $component, int $countCheck = 1, bool $doFlush = false): bool
     {
         $metadata = $this->usageMetadataFactory->create($component);
-        if (1 === $metadata->getTotal()) {
+        if ($countCheck === $metadata->getTotal()) {
             $resourceClass = get_class($component);
             $manager = $this->registry->getManagerForClass($resourceClass);
             $manager?->remove($component);
+            if ($doFlush) {
+                $manager?->flush();
+            }
+            return true;
         }
+        return false;
     }
+
+
 }