[Asset]: Add a filter to show only Unreferenced Assets. (#1860)

Author: martineiber

composer.json

@@ -21,8 +21,8 @@
     "league/csv": "^9.27",
     "nesbot/carbon": "^3.8.4",
     "pimcore/static-resolver-bundle": "^3.6.1 ",
-    "pimcore/generic-data-index-bundle": "^2.5.0",
-    "pimcore/pimcore": "^12.3",
+    "pimcore/generic-data-index-bundle": "^2.5.3",
+    "pimcore/pimcore": "^12.3.9",
     "zircote/swagger-php": "^4.8 || ^5.0",
     "ext-zip": "*",
     "symfony/mercure": "^0.6.5",

config/data_index_filters.yaml

@@ -131,3 +131,7 @@ services:
 
   Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\DataObject\CRM\ConsentFilter:
     tags: [ 'pimcore.studio_backend.search_index.data_object.filter' ]
+
+  # Asset
+  Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\Asset\UnreferencedFilter:
+    tags: [ 'pimcore.studio_backend.search_index.asset.filter' ]

doc/01_Architecture_Overview/01_Grid.md

@@ -135,6 +135,7 @@ Available filters are:
 |        classificationstore.number        |                  object                  |      `from`, `to`, `is`, `setting`      |      true      |
 |               crm.consent                |                  array                   |            `true` or `false`            |      true      |
 |           dataobject.relation            |                  array                   |    array of `type`, `ids` objects       |      true      |
+|          system.unreferenced             |                 boolean                  |  Asset grid only — unreferenced assets  |     false      |
 
 
 ### Examples:
@@ -242,6 +243,18 @@ To filter by this structure:
 ...
 ```
 
+Filter unreferenced assets (asset grid only):
+```json
+...
+"columnFilters" [
+  {
+    "type": "system.unreferenced",
+    "filterValue": true
+  }
+]
+...
+```
+
 ## Advanced Columns
 
 Advanced columns combine multiple data sources and transformers. Data source types:

src/DataIndex/Filter/Asset/UnreferencedFilter.php

@@ -0,0 +1,49 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\Asset;
+
+use Pimcore\Bundle\StudioBackendBundle\DataIndex\Filter\FilterInterface;
+use Pimcore\Bundle\StudioBackendBundle\DataIndex\Query\AssetQueryInterface;
+use Pimcore\Bundle\StudioBackendBundle\DataIndex\Query\QueryInterface;
+use Pimcore\Bundle\StudioBackendBundle\Grid\Column\ColumnType;
+use Pimcore\Bundle\StudioBackendBundle\MappedParameter\Filter\SimpleColumnFiltersParameterInterface;
+
+/**
+ * @internal
+ */
+final class UnreferencedFilter implements FilterInterface
+{
+    public function apply(mixed $parameters, QueryInterface $query): QueryInterface
+    {
+        if (!$parameters instanceof SimpleColumnFiltersParameterInterface) {
+            return $query;
+        }
+
+        if (!$query instanceof AssetQueryInterface) {
+            return $query;
+        }
+
+        $filter = $parameters->getSimpleColumnFilterByType(ColumnType::SYSTEM_UNREFERENCED->value);
+
+        if ($filter === null) {
+            return $query;
+        }
+
+        if ($filter->getFilterValue() === true) {
+            $query->filterUnreferenced();
+        }
+
+        return $query;
+    }
+}

src/DataIndex/Query/AssetQuery.php

@@ -22,6 +22,7 @@
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\IdsFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\IntegerFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\NumberFilter;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Dependency\UnreferencedFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\FieldType\BooleanMultiSelectFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\FieldType\DateFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\FieldType\MultiSelectFilter;
@@ -128,6 +129,13 @@ public function filterMetadata(string $name, string $type, mixed $data): self
         return $this;
     }
 
+    public function filterUnreferenced(): self
+    {
+        $this->search->addModifier(new UnreferencedFilter());
+
+        return $this;
+    }
+
     public function orderByField(string $fieldName, SortDirection $direction): self
     {
         $this->search->addModifier(new OrderByField($fieldName, $direction));

src/DataIndex/Query/AssetQueryInterface.php

@@ -22,5 +22,7 @@ interface AssetQueryInterface extends QueryInterface
 {
     public function filterMetadata(string $name, string $type, mixed $data): self;
 
+    public function filterUnreferenced(): self;
+
     public function getSearch(): AssetSearchInterface;
 }

src/Grid/Column/ColumnType.php

@@ -23,6 +23,7 @@ enum ColumnType: string
     case SYSTEM_TIME = 'system.time';
     case SYSTEM_DATE = 'system.date';
     case SYSTEM_BOOLEAN = 'system.boolean';
+    case SYSTEM_UNREFERENCED = 'system.unreferenced';
     case SYSTEM_TAG = 'system.tag';
     case SYSTEM_PQL_QUERY = 'system.pql';
     case SYSTEM_NUMBER = 'system.number';