NGSTACK-977 tags visibility

bundle/API/Repository/Events/Tags/BeforeHideTagEvent.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Netgen\TagsBundle\API\Repository\Events\Tags;
+
+use Ibexa\Contracts\Core\Repository\Event\BeforeEvent;
+use Netgen\TagsBundle\API\Repository\Values\Tags\Tag;
+
+class BeforeHideTagEvent extends BeforeEvent
+{
+    public function __construct(private readonly Tag $tag) {}
+
+    public function getTag(): Tag
+    {
+        return $this->tag;
+    }
+}

bundle/API/Repository/Events/Tags/BeforeRevealTagEvent.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Netgen\TagsBundle\API\Repository\Events\Tags;
+
+use Ibexa\Contracts\Core\Repository\Event\BeforeEvent;
+use Netgen\TagsBundle\API\Repository\Values\Tags\Tag;
+
+class BeforeRevealTagEvent extends BeforeEvent
+{
+    public function __construct(private readonly Tag $tag) {}
+
+    public function getTag(): Tag
+    {
+        return $this->tag;
+    }
+}

bundle/API/Repository/Events/Tags/HideTagEvent.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Netgen\TagsBundle\API\Repository\Events\Tags;
+
+use Ibexa\Contracts\Core\Repository\Event\AfterEvent;
+use Netgen\TagsBundle\API\Repository\Values\Tags\Tag;
+
+class HideTagEvent extends AfterEvent
+{
+    public function __construct(private readonly Tag $tag) {}
+
+    public function getTag(): Tag
+    {
+        return $this->tag;
+    }
+}

bundle/API/Repository/Events/Tags/RevealTagEvent.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Netgen\TagsBundle\API\Repository\Events\Tags;
+
+use Ibexa\Contracts\Core\Repository\Event\AfterEvent;
+use Netgen\TagsBundle\API\Repository\Values\Tags\Tag;
+
+class RevealTagEvent extends AfterEvent
+{
+    public function __construct(private readonly Tag $tag) {}
+
+    public function getTag(): Tag
+    {
+        return $this->tag;
+    }
+}

bundle/API/Repository/TagsService.php

@@ -76,7 +76,7 @@ public function loadTagByUrl(string $url, array $languages): Tag;
      *
      * @return \Netgen\TagsBundle\API\Repository\Values\Tags\TagList
      */
-    public function loadTagChildren(?Tag $tag = null, int $offset = 0, int $limit = -1, ?array $languages = null, bool $useAlwaysAvailable = true): TagList;
+    public function loadTagChildren(?Tag $tag = null, int $offset = 0, int $limit = -1, ?array $languages = null, bool $useAlwaysAvailable = true, ?bool $showHiddenTags = null): TagList;
 
     /**
      * Returns the number of children of a tag object.
@@ -89,7 +89,7 @@ public function loadTagChildren(?Tag $tag = null, int $offset = 0, int $limit =
      *
      * @return int
      */
-    public function getTagChildrenCount(?Tag $tag = null, ?array $languages = null, bool $useAlwaysAvailable = true): int;
+    public function getTagChildrenCount(?Tag $tag = null, ?array $languages = null, bool $useAlwaysAvailable = true, ?bool $showHiddenTags = null): int;
 
     /**
      * Loads tags by specified keyword.
@@ -104,7 +104,7 @@ public function getTagChildrenCount(?Tag $tag = null, ?array $languages = null,
      *
      * @return \Netgen\TagsBundle\API\Repository\Values\Tags\TagList
      */
-    public function loadTagsByKeyword(string $keyword, string $language, bool $useAlwaysAvailable = true, int $offset = 0, int $limit = -1): TagList;
+    public function loadTagsByKeyword(string $keyword, string $language, bool $useAlwaysAvailable = true, int $offset = 0, int $limit = -1, ?bool $showHiddenTags = null): TagList;
 
     /**
      * Returns the number of tags by specified keyword.
@@ -117,7 +117,7 @@ public function loadTagsByKeyword(string $keyword, string $language, bool $useAl
      *
      * @return int
      */
-    public function getTagsByKeywordCount(string $keyword, string $language, bool $useAlwaysAvailable = true): int;
+    public function getTagsByKeywordCount(string $keyword, string $language, bool $useAlwaysAvailable = true, ?bool $showHiddenTags = null): int;
 
     /**
      * Search for tags.
@@ -132,7 +132,7 @@ public function getTagsByKeywordCount(string $keyword, string $language, bool $u
      *
      * @return \Netgen\TagsBundle\API\Repository\Values\Tags\SearchResult
      */
-    public function searchTags(string $searchString, string $language, bool $useAlwaysAvailable = true, int $offset = 0, int $limit = -1): SearchResult;
+    public function searchTags(string $searchString, string $language, bool $useAlwaysAvailable = true, int $offset = 0, int $limit = -1, ?bool $showHiddenTags = null): SearchResult;
 
     /**
      * Loads synonyms of a tag object.
@@ -148,7 +148,7 @@ public function searchTags(string $searchString, string $language, bool $useAlwa
      *
      * @return \Netgen\TagsBundle\API\Repository\Values\Tags\TagList
      */
-    public function loadTagSynonyms(Tag $tag, int $offset = 0, int $limit = -1, ?array $languages = null, bool $useAlwaysAvailable = true): TagList;
+    public function loadTagSynonyms(Tag $tag, int $offset = 0, int $limit = -1, ?array $languages = null, bool $useAlwaysAvailable = true, ?bool $showHiddenTags = null): TagList;
 
     /**
      * Returns the number of synonyms of a tag object.
@@ -162,7 +162,7 @@ public function loadTagSynonyms(Tag $tag, int $offset = 0, int $limit = -1, ?arr
      *
      * @return int
      */
-    public function getTagSynonymCount(Tag $tag, ?array $languages = null, bool $useAlwaysAvailable = true): int;
+    public function getTagSynonymCount(Tag $tag, ?array $languages = null, bool $useAlwaysAvailable = true, ?bool $showHiddenTags = null): int;
 
     /**
      * Loads content related to $tag.
@@ -222,6 +222,8 @@ public function addSynonym(SynonymCreateStruct $synonymCreateStruct): Tag;
     /**
      * Converts $tag to a synonym of $mainTag.
      *
+     * If $tag was hidden, it will remain hidden after converting
+     *
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException If either of specified tags is not found
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException If the current user is not allowed to convert tag to synonym
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException If either one of the tags is a synonym
@@ -286,6 +288,26 @@ public function newSynonymCreateStruct(int $mainTagId, string $mainLanguageCode)
      */
     public function newTagUpdateStruct(): TagUpdateStruct;
 
+    /**
+     * Hides $tag.
+     *
+     * If $tag is a synonym, only the synonym is hidden.
+     *
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException If the current user is not allowed to hide this tag
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException If the specified tag is not found
+     */
+    public function hideTag(Tag $tag): void;
+
+    /**
+     * Reveal $tag.
+     *
+     * If $tag is a synonym, only the synonym is revealed.
+     *
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException If the current user is not allowed to reveal this tag
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException If the specified tag is not found
+     */
+    public function revealTag(Tag $tag): void;
+
     /**
      * Allows tags API execution to be performed with full access sand-boxed.
      *

bundle/API/Repository/Values/Tags/Tag.php

@@ -28,6 +28,8 @@
  * @property-read bool $alwaysAvailable Indicates if the Tag object is shown in the main language if it is not present in an other requested language
  * @property-read string $mainLanguageCode The main language code of the Tag object
  * @property-read string[] $languageCodes List of languages in this Tag object
+ * @property-read bool $isHidden Indicates if the Tag object is visible or not
+ * @property-read bool $isInvisible Indicates if the Tag object is located under another hidden Tag object
  */
 final class Tag extends ValueObject
 {
@@ -104,6 +106,17 @@ final class Tag extends ValueObject
      */
     protected ?string $prioritizedLanguageCode;
 
+    /**
+     * Indicates that the Tag is hidden.
+     */
+    protected bool $isHidden;
+
+    /**
+     * Indicates that the Tag object is not visible, being either hidden itself,
+     * or implicitly hidden by parent or ancestor Tag object.
+     */
+    protected bool $isInvisible;
+
     /**
      * Construct object optionally with a set of properties.
      *

bundle/Controller/Admin/FieldController.php

@@ -37,6 +37,10 @@ public function autoCompleteAction(Request $request): JsonResponse
         $searchResult = $this->tagsService->searchTags(
             $request->query->get('searchString') ?? '',
             $request->query->get('locale') ?? '',
+            true,
+            0,
+            -1,
+            $this->configResolver->getParameter('autocomplete_provide_hidden_tags', 'netgen_tags'),
         );
 
         $data = $data = $this->filterTags($searchResult->tags, $subTreeLimit, $hideRootTag);