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 $showHidden = 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 $showHidden = 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 $showHidden = 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 $showHidden = 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 $showHidden = 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 $showHidden = 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 $showHidden = null): int;
 
     /**
      * Loads content related to $tag.
@@ -286,6 +286,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,7 @@ public function autoCompleteAction(Request $request): JsonResponse
         $searchResult = $this->tagsService->searchTags(
             $request->query->get('searchString') ?? '',
             $request->query->get('locale') ?? '',
+            showHidden: false,
         );
 
         $data = $data = $this->filterTags($searchResult->tags, $subTreeLimit, $hideRootTag);

bundle/Controller/Admin/TagController.php

@@ -500,9 +500,49 @@ public function childrenAction(Request $request, ?Tag $tag = null): Response
             );
         }
 
+        if ($request->request->has('HideTagsAction')) {
+            return $this->redirectToRoute(
+                'netgen_tags_admin_tag_hide_tags',
+                [
+                    'parentId' => $tag?->id ?? 0,
+                ],
+            );
+        }
+
+        if ($request->request->has('RevealTagsAction')) {
+            return $this->redirectToRoute(
+                'netgen_tags_admin_tag_reveal_tags',
+                [
+                    'parentId' => $tag?->id ?? 0,
+                ],
+            );
+        }
+
         return $this->redirect($request->getPathInfo());
     }
 
+    public function hideAction(Request $request, Tag $tag): Response
+    {
+        $this->denyAccessUnlessGranted('ibexa:tags:hide' . ($tag->isSynonym() ? 'synonym' : ''));
+
+        $this->tagsService->hideTag($tag);
+
+        $this->addFlashMessage('success', 'tag_hidden', ['%tagKeyword%' => $tag->keyword]);
+
+        return $this->redirectToTag($tag);
+    }
+
+    public function revealAction(Request $request, Tag $tag): Response
+    {
+        $this->denyAccessUnlessGranted('ibexa:tags:reveal' . ($tag->isSynonym() ? 'synonym' : ''));
+
+        $this->tagsService->revealTag($tag);
+
+        $this->addFlashMessage('success', 'tag_reveal', ['%tagKeyword%' => $tag->keyword]);
+
+        return $this->redirectToTag($tag);
+    }
+
     /**
      * This method is called from a form containing all children tags of a tag.
      * It shows a confirmation view.
@@ -666,6 +706,60 @@ public function deleteTagsAction(Request $request, ?Tag $parentTag = null): Resp
         );
     }
 
+    public function hideTagsAction(Request $request, ?Tag $parentTag = null): Response
+    {
+        $this->denyAccessUnlessGranted('ibexa:tags:hide');
+
+        $tagIds = (array) $request->request->get(
+            'Tags',
+            $request->hasSession() ? $request->getSession()->get('ngtags_tag_ids') : [],
+        );
+
+        if (count($tagIds) === 0) {
+            return $this->redirectToTag($parentTag);
+        }
+
+        $tags = [];
+        foreach ($tagIds as $tagId) {
+            $tags[] = $this->tagsService->loadTag((int) $tagId);
+        }
+
+        foreach ($tags as $tagObject) {
+            $this->tagsService->hideTag($tagObject);
+        }
+
+        $this->addFlashMessage('success', 'tags_hidden');
+
+        return $this->redirectToTag($parentTag);
+    }
+
+    public function revealTagsAction(Request $request, ?Tag $parentTag = null): Response
+    {
+        $this->denyAccessUnlessGranted('ibexa:tags:reveal');
+
+        $tagIds = (array) $request->request->get(
+            'Tags',
+            $request->hasSession() ? $request->getSession()->get('ngtags_tag_ids') : [],
+        );
+
+        if (count($tagIds) === 0) {
+            return $this->redirectToTag($parentTag);
+        }
+
+        $tags = [];
+        foreach ($tagIds as $tagId) {
+            $tags[] = $this->tagsService->loadTag((int) $tagId);
+        }
+
+        foreach ($tags as $tagObject) {
+            $this->tagsService->revealTag($tagObject);
+        }
+
+        $this->addFlashMessage('success', 'tags_revealed');
+
+        return $this->redirectToTag($parentTag);
+    }
+
     public function searchTagsAction(Request $request): Response
     {
         $this->denyAccessUnlessGranted('ibexa:tags:read');

bundle/Controller/Admin/TreeController.php

@@ -12,6 +12,7 @@
 use Symfony\Contracts\Translation\TranslatorInterface;
 
 use function htmlspecialchars;
+use function mb_strtolower;
 use function str_replace;
 
 use const ENT_HTML401;
@@ -44,6 +45,8 @@ public function __construct(
             'merge_tag' => $this->translator->trans('tag.tree.merge_tag', [], 'netgen_tags_admin'),
             'convert_tag' => $this->translator->trans('tag.tree.convert_tag', [], 'netgen_tags_admin'),
             'add_synonym' => $this->translator->trans('tag.tree.add_synonym', [], 'netgen_tags_admin'),
+            'hide_tag' => $this->translator->trans('tag.tree.hide_tag', [], 'netgen_tags_admin'),
+            'reveal_tag' => $this->translator->trans('tag.tree.reveal_tag', [], 'netgen_tags_admin'),
         ];
 
         $this->treeLinks = [
@@ -55,6 +58,8 @@ public function __construct(
             'merge_tag' => $this->router->generate('netgen_tags_admin_tag_merge', ['tagId' => ':tagId']),
             'convert_tag' => $this->router->generate('netgen_tags_admin_tag_convert', ['tagId' => ':tagId']),
             'add_synonym' => $this->router->generate('netgen_tags_admin_synonym_add_select', ['mainTagId' => ':mainTagId']),
+            'hide_tag' => $this->router->generate('netgen_tags_admin_tag_hide', ['tagId' => ':tagId']),
+            'reveal_tag' => $this->router->generate('netgen_tags_admin_tag_reveal', ['tagId' => ':tagId']),
         ];
     }
 
@@ -119,13 +124,13 @@ private function getRootTreeData(): array
      */
     private function getTagTreeData(Tag $tag, bool $isRoot = false): array
     {
-        $synonymCount = $this->tagsService->getTagSynonymCount($tag);
-
         return [
             'id' => $tag->id,
             'parent' => $isRoot ? '#' : $tag->parentTagId,
-            'text' => $synonymCount > 0 ? $this->escape($tag->keyword) . ' (+' . $synonymCount . ')' : $this->escape($tag->keyword),
+            'text' => $this->formatTagTreeText($tag),
             'children' => $this->tagsService->getTagChildrenCount($tag) > 0,
+            'hidden' => $tag->isHidden,
+            'invisible' => $tag->isInvisible,
             'a_attr' => [
                 'href' => str_replace(':tagId', (string) $tag->id, $this->treeLinks['show_tag']),
                 'rel' => $tag->id,
@@ -165,13 +170,37 @@ private function getTagTreeData(Tag $tag, bool $isRoot = false): array
                         'url' => str_replace(':tagId', (string) $tag->id, $this->treeLinks['convert_tag']),
                         'text' => $this->treeLabels['convert_tag'],
                     ],
+                    [
+                        'name' => 'hide_tag',
+                        'url' => str_replace(':tagId', (string) $tag->id, $this->treeLinks['hide_tag']),
+                        'text' => $this->treeLabels['hide_tag'],
+                    ],
+                    [
+                        'name' => 'reveal_tag',
+                        'url' => str_replace(':tagId', (string) $tag->id, $this->treeLinks['reveal_tag']),
+                        'text' => $this->treeLabels['reveal_tag'],
+                    ],
                 ],
             ],
         ];
     }
 
-    private function escape(string $string): string
+    private function formatTagTreeText(Tag $tag): string
     {
-        return htmlspecialchars($string, ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401, 'UTF-8');
+        $synonymCount = $this->tagsService->getTagSynonymCount($tag);
+
+        $text = htmlspecialchars($tag->keyword, ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401, 'UTF-8');
+
+        if ($tag->isHidden) {
+            $text .= ' (' . mb_strtolower($this->translator->trans('tag.hidden', [], 'netgen_tags_admin')) . ')';
+        } elseif ($tag->isInvisible) {
+            $text .= ' (' . $this->translator->trans('tag.hidden_by_parent', [], 'netgen_tags_admin') . ')';
+        }
+
+        if ($synonymCount > 0) {
+            $text .= ' (+' . $synonymCount . ')';
+        }
+
+        return $text;
     }
 }