TASK: Adjust AssetsHelper method names and make them more precise

Author: Sebobo

Neos.Media/Classes/Eel/AssetsHelper.php

@@ -32,7 +32,6 @@
  */
 class AssetsHelper implements ProtectedContextAwareInterface
 {
-
     /**
      * @Flow\Inject
      * @var AssetRepository
@@ -54,55 +53,55 @@ class AssetsHelper implements ProtectedContextAwareInterface
     /**
      * @return QueryResultInterface<AssetInterface> | null
      */
-    public function findByTag(Tag|string $tag): ?QueryResultInterface
+    public function findByTag(?Tag $tag): ?QueryResultInterface
     {
-        if (is_string($tag)) {
-            $tag = $this->tagRepository->findOneByLabel($tag);
-        }
-
         if (!$tag) {
             return null;
         }
-
-        try {
-            return $this->assetRepository->findByTag($tag);
-        } catch (InvalidQueryException) {
-        }
-
-        return null;
+        return $this->assetRepository->findByTag($tag);
     }
 
     /**
      * @return QueryResultInterface<AssetInterface> | null
      */
-    public function findByCollection(AssetCollection|string $collection): ?QueryResultInterface
+    public function findByTagLabel(?string $tagLabel): ?QueryResultInterface
     {
-        if (is_string($collection)) {
-            $collection = $this->assetCollectionRepository->findOneByTitle($collection);
+        if (!$tagLabel) {
+            return null;
         }
+        $tag = $this->tagRepository->findOneByLabel($tagLabel);
+        return $this->findByTag($tag);
+    }
 
+    /**
+     * @return QueryResultInterface<AssetInterface> | null
+     */
+    public function findByCollection(?AssetCollection $collection): ?QueryResultInterface
+    {
         if (!$collection) {
             return null;
         }
+        return $this->assetRepository->findByAssetCollection($collection);
+    }
 
-        try {
-            return $this->assetRepository->findByAssetCollection($collection);
-        } catch (InvalidQueryException) {
+    /**
+     * @return QueryResultInterface<AssetInterface> | null
+     */
+    public function findByCollectionTitle(?string $collectionTitle): ?QueryResultInterface
+    {
+        if (!$collectionTitle) {
+            return null;
         }
-
-        return null;
+        $collection = $this->assetCollectionRepository->findOneByTitle($collectionTitle);
+        return $this->findByCollection($collection);
     }
 
     /**
      * @param Tag[] $tags
      * @return QueryResultInterface<AssetInterface> | null
      */
-    public function findBySearchTerm(string $searchTerm, array $tags = [], AssetCollection|string $collection = null): ?QueryResultInterface
+    public function search(string $searchTerm, array $tags = [], AssetCollection $collection = null): ?QueryResultInterface
     {
-        if (is_string($collection)) {
-            $collection = $this->assetCollectionRepository->findOneByTitle($collection);
-        }
-
         if (!$searchTerm) {
             return null;
         }

Neos.Neos/Documentation/References/EelHelpersReference.rst

@@ -1462,23 +1462,37 @@ Implemented in: ``Neos\Media\Eel\AssetsHelper``
 Neos.Media.Assets.findByTag(tag)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* ``tag`` (Neos\Media\Domain\Model\Tag|string) The label of a tag or a ``Tag`` object
+* ``tag`` (Neos\Media\Domain\Model\Tag) A ``Tag`` instance
+
+**Return** (null|QueryResultInterface<AssetInterface>)
+
+Neos.Media.Assets.findByTagLabel(label)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* ``label`` (string) The label of a tag
 
 **Return** (null|QueryResultInterface<AssetInterface>)
 
 Neos.Media.Assets.findByCollection(collection)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* ``collection`` (Neos\Media\Domain\Model\AssetCollection|string) The title of a collection or a ``AssetCollection`` object
+* ``collection`` (Neos\Media\Domain\Model\AssetCollection) An ``AssetCollection`` instance
+
+**Return** (null|QueryResultInterface<AssetInterface>)
+
+Neos.Media.Assets.findByCollectionTitle(title)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* ``title`` (string) The title of a collection
 
 **Return** (null|QueryResultInterface<AssetInterface>)
 
-Neos.Media.Assets.findBySearchTerm(searchTerm, tags, collection)
+Neos.Media.Assets.search(searchTerm, tags, collection)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 * ``searchTerm`` (string) The search term to look for in the title, filename and caption of assets
-* ``tags`` (Neos\Media\Domain\Model\Tag[], optional) A list of ``Tag`` objects
-* ``collection`` (Neos\Media\Domain\Model\AssetCollection|string, optional) The title of a collection or a ``AssetCollection`` object
+* ``tags`` (Neos\Media\Domain\Model\Tag[], optional) A list of ``Tag`` instances
+* ``collection`` (Neos\Media\Domain\Model\AssetCollection, optional) An ``AssetCollection`` instance
 
 **Return** (null|QueryResultInterface<AssetInterface>)