Add package list filters

Author: codedmonkey

src/Controller/Dashboard/DashboardPackagesController.php

@@ -5,7 +5,9 @@
 use CodedMonkey\Dirigent\Attribute\IsGrantedAccess;
 use CodedMonkey\Dirigent\Doctrine\Entity\Package;
 use CodedMonkey\Dirigent\Doctrine\Entity\PackageFetchStrategy;
+use CodedMonkey\Dirigent\Doctrine\Entity\Registry;
 use CodedMonkey\Dirigent\Doctrine\Repository\PackageRepository;
+use CodedMonkey\Dirigent\Doctrine\Repository\RegistryRepository;
 use CodedMonkey\Dirigent\EasyAdmin\PackagePaginator;
 use CodedMonkey\Dirigent\Form\PackageAddMirroringFormType;
 use CodedMonkey\Dirigent\Form\PackageAddVcsFormType;
@@ -19,6 +21,7 @@
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Component\Security\Http\Attribute\IsGranted;
+use function Symfony\Component\String\u;
 
 class DashboardPackagesController extends AbstractController
 {
@@ -32,19 +35,46 @@ public function __construct(
 
     #[Route('/packages', name: 'dashboard_packages')]
     #[IsGrantedAccess]
-    public function list(Request $request): Response
+    public function list(Request $request, RegistryRepository $registryRepository): Response
     {
         $queryBuilder = $this->packageRepository->createQueryBuilder('package');
+        $filtersActive = false;
+
+        if ($request->query->has('query')) {
+            $filtersActive = true;
+            $searchQuery = $request->query->getString('query');
+            $searchQuery = u($searchQuery)->lower();
 
-        if (null !== $query = $request->query->get('query')) {
             $queryBuilder->andWhere($queryBuilder->expr()->like('package.name', ':query'));
-            $queryBuilder->setParameter('query', "%{$query}%");
+            $queryBuilder->setParameter('query', "%{$searchQuery}%");
+        }
+
+        if ($request->query->has('registry')) {
+            $registryId = $request->query->getInt('registry');
+
+            if (0 === $registryId) {
+                $filtersActive = true;
+                $selectedRegistry = 'local';
+
+                $queryBuilder->andWhere($queryBuilder->expr()->isNull('package.mirrorRegistry'));
+            } elseif (null !== $selectedRegistry = $registryRepository->find($registryId)) {
+                $filtersActive = true;
+
+                $queryBuilder->andWhere($queryBuilder->expr()->eq('package.mirrorRegistry', ':registry'));
+                $queryBuilder->setParameter('registry', $selectedRegistry);
+            }
         }
 
         $paginator = PackagePaginator::fromRequest($request, $queryBuilder, $this->container->get('router'));
 
+        $registries = $this->entityManager->getRepository(Registry::class)->findAll();
+
         return $this->render('dashboard/packages/list.html.twig', [
+            'filtersActive' => $filtersActive,
             'paginator' => $paginator,
+            'registries' => $registries,
+            'searchQuery' => $searchQuery ?? null,
+            'selectedRegistry' => $selectedRegistry ?? null,
         ]);
     }
 

src/Twig/PackageExtension.php

@@ -5,23 +5,43 @@
 use CodedMonkey\Dirigent\Doctrine\Entity\Package;
 use CodedMonkey\Dirigent\Doctrine\Repository\PackageRepository;
 use Composer\Pcre\Preg;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+use Twig\Attribute\AsTwigFunction;
+use Twig\Attribute\AsTwigTest;
 use Twig\Extension\AbstractExtension;
 use Twig\TwigTest;
 
-class PackageExtension extends AbstractExtension
+readonly class PackageExtension
 {
     public function __construct(
-        private readonly PackageRepository $packageRepository,
+        private PackageRepository $packageRepository,
+        private UrlGeneratorInterface $router,
+        private RequestStack $requestStack,
     ) {
     }
 
-    public function getTests(): array
+    #[AsTwigFunction('packageFilterParameters')]
+    public function getFilterParameters(string $parameter, string|int|null $value): array
     {
-        return [
-            new TwigTest('existing_package', [$this, 'packageExistsTest']),
+        $request = $this->requestStack->getCurrentRequest();
+        $filters = [
+            'query' => $request->query->get('query'),
+            'registry' => $request->query->get('registry'),
         ];
+
+        $filters[$parameter] = $value;
+
+        return array_filter($filters, fn ($value) => null !== $value);
+    }
+
+    #[AsTwigFunction('packageFilterUrl')]
+    public function createFilterUrl(string $parameter, string|int|null $value): string
+    {
+        return $this->router->generate('dashboard_packages', $this->getFilterParameters($parameter, $value));
     }
 
+    #[AsTwigTest('existing_package')]
     public function packageExistsTest(mixed $package): bool
     {
         if ($package instanceof Package) {

templates/dashboard/packages/_search_box.html.twig

@@ -7,19 +7,22 @@
         <label class="content-search-label">
           <input
             name="query"
-            class="form-control {{ app.request.get('query') is null ? 'is-blank' }}"
+            class="form-control {{ searchQuery is not defined ? 'is-blank' }}"
             type="search"
-            value="{{ app.request.get('query') ?? '' }}"
+            value="{{ searchQuery ?? '' }}"
             placeholder="{{ 'Search packages'|trans }}"
             spellcheck="false"
             autocorrect="off"
             {% if autofocus ?? true %}autofocus="autofocus"{% endif %}
           >
         </label>
 
-        {% if app.request.get('query') %}
-          {% set clearRouteParameters = app.request.get('_route_params')|filter((value, key) => key != 'query' and key != 'page') %}
-          <a href="{{ path('dashboard_packages', clearRouteParameters) }}" class="content-search-reset">
+        {% for parameter, value in packageFilterParameters('query', null) %}
+          <input type="hidden" name="{{ parameter }}" value="{{ value }}">
+        {% endfor %}
+
+        {% if searchQuery is defined and searchQuery is not null %}
+          <a href="{{ packageFilterUrl('query', null) }}" class="content-search-reset">
             <i class="fas fa-fw fa-times"></i>
           </a>
         {% endif %}

templates/dashboard/packages/list.html.twig

@@ -3,7 +3,7 @@
 {% block page_title %}Packages{% endblock %}
 
 {% block search_wrapper %}
-  {{ include('dashboard/packages/_search_box.html.twig', with_context: false) }}
+  {{ include('dashboard/packages/_search_box.html.twig', {searchQuery: searchQuery}, with_context: false) }}
 {% endblock %}
 
 {% block page_actions %}
@@ -25,5 +25,38 @@
 {% endblock %}
 
 {% block page_content %}
+  <div class="d-flex align-items-center gap-2 mb-3">
+    <div>{{ 'Filter by'|trans }}</div>
+    {% if registries|length %}
+      <div>
+        <div class="dropdown">
+          <button class="btn btn-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
+            {{ selectedRegistry ? (selectedRegistry == 'local' ? ('Local'|trans) : selectedRegistry.name)  : ('All registries'|trans) }}
+          </button>
+          <ul class="dropdown-menu">
+            {{ _self.registryFilterItem(selectedRegistry, null, 'All registries'|trans) }}
+            {{ _self.registryFilterItem(selectedRegistry, 0, 'Local'|trans) }}
+            {% for registry in registries %}
+              {{ _self.registryFilterItem(selectedRegistry, registry.id, registry.name) }}
+            {% endfor %}
+          </ul>
+        </div>
+      </div>
+    {% endif %}
+    {% if filtersActive %}
+      <div>
+        <a class="btn btn-secondary" href="{{ path('dashboard_packages') }}">{{ 'Clear filters'|trans }}</a>
+      </div>
+    {% endif %}
+  </div>
+
   {{ include('dashboard/packages/_package_list.html.twig', {paginator: paginator}, with_context: false) }}
 {% endblock %}
+
+{% macro registryFilterItem(selectedRegistry, registry, label) %}
+  {% if registry is same as(selectedRegistry) %}
+    <li><span class="dropdown-item active">{{ label }}</span></li>
+  {% else %}
+    <li><a class="dropdown-item" href="{{ packageFilterUrl('registry', registry) }}">{{ label }}</a></li>
+  {% endif %}
+{% endmacro %}

translations/messages.en.yaml

@@ -25,6 +25,12 @@ User: User
 Users: Users
 Versions: Versions
 
+# Filter labels
+All registries: All registries
+Clear filters: Clear filters
+Filter by: Filter by
+Local: Local
+
 # Form labels
 Current password: Current password
 Description: Description