New: Add option to ignore filenames

Author: jonnitto

Classes/Fusion/RawListImplementation.php

@@ -66,6 +66,13 @@ class RawListImplementation extends AbstractFusionObject
      */
     protected $assetUsage;
 
+    /**
+    * Internal cache for the ignored filenames.
+    *
+    * @var array
+    */
+    protected $ignoreFilenames;
+
     /**
      * Internal cache for the used dimensions
      *
@@ -83,7 +90,7 @@ class RawListImplementation extends AbstractFusionObject
     /**
      * Internal cache for the context
      *
-     * @var array
+     * @var object
      */
     protected $context;
 
@@ -94,6 +101,24 @@ class RawListImplementation extends AbstractFusionObject
      */
     protected $currentSiteNodeIdentifierArray;
 
+    protected function getIgnoreFilenames(): array
+    {
+        $ignoreFilenames = $this->fusionValue('ignoreFilenames');
+
+        if (!is_array($ignoreFilenames)) {
+            return [];
+        }
+
+        $result = [];
+        foreach ($ignoreFilenames as $ignoredFile => $value) {
+            if ($value) {
+                $result[] = strtolower($ignoredFile);
+            }
+        }
+
+        return array_unique($result);
+    }
+
     /**
      * Returns the items as result of the fusion object.
      *
@@ -113,6 +138,7 @@ public function evaluate(): array
         $this->workspace = $startingPoint->getWorkspace()->getName();
         $this->startingPoint = $startingPoint;
         $this->context = $startingPoint->getContext();
+        $this->ignoreFilenames = $this->getIgnoreFilenames();
         if (isset($this->items)) {
             return $this->items;
         }
@@ -336,7 +362,7 @@ protected function assetHasCorrectMediaType(?AssetInterface $asset): bool
     }
 
     /**
-     * @param array $entityUsage
+     * @param object $entityUsage
      * @return array|null
      */
     protected function entityUsage($entityUsage): ?array
@@ -370,6 +396,11 @@ protected function entityUsage($entityUsage): ?array
         /** @var AssetInterface $asset */
         $asset = $this->assetRepository->findByIdentifier($id);
 
+        $filename = strtolower($asset->getResource()->getFilename());
+        if (in_array($filename, $this->ignoreFilenames)) {
+            return null;
+        }
+
         if (!$this->assetHasCorrectMediaType($asset)) {
             return null;
         }

Configuration/Settings.yaml

@@ -8,3 +8,11 @@ Neos:
         autoInclude:
           Garagist.ImageDirectory:
             - 'NodeTypes/*'
+
+Garagist:
+  ImageDirectory:
+    # List of filenames who should be always ignored. Case-insensitive.
+    ignoreFilenames:
+      'favicon.ico': true
+      'favicon.png': true
+      'apple-touch-icon.png': true

Resources/Private/Fusion/Helper/RawList.fusion

@@ -6,6 +6,8 @@ prototype(Garagist.ImageDirectory:Helper.RawList) {
     # Can be document or asset
     sortBy = ${null}
 
+    ignoreFilenames = ${Configuration.setting('Garagist.ImageDirectory.ignoreFilenames')}
+
     # Comma seperated list
     mediaTypes = 'image/*,video/*'