NGSTACK-977 tags visibility #169

AntePrkacin · 2025-06-06T08:58:12Z

Added isHidden and isInvisible fields to Tag objects. Updated the database schema and updated the whole workflow for hiding and unhiding a tag (Service, Mapper, Handler, Gateway, ...).

Added columns 'Hidden' and 'Invisible' to table that show children tags of some tag in admin interface.
In admin interface added button for hiding a tag (or if a tag is already hidden, then this button will unhide it).
Also added buttons 'Hide selected tags' and 'Unhide selected tags' for the checked children tags.

When a tag is hidden, the route /tags/view/Topics/{tag_name} will throw 404 and return information that 'Tag is hidden' or 'Tag is hidden by parent'.

If a tag is hidden, then the user won't be able to add that tag to some 'eztags' content field for some content.
If some content already has a hidden tag, then this tag will have ' (hidden)' appended to it and it will be in gray color.

… in both API and persistence layer

…isible' columns in 'eztags' table

…n DoctrineDatabase, TagsMapper and Mapper classes

…anslation files and display them in admin UI

…rface

…terface

…show when a tag is hidden by parent

…en tags

… hidden tags to content

emodric · 2025-06-06T09:00:37Z

bundle/API/Repository/TagsService.php

+    /**
+     * Hides $tag.
+     *
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException If the current user is not allowed to delete this tag


Wrong exception text If the current user is not allowed to delete this tag. Shoud be hide instead of delete.

Same goes for unhide.

Fixed PHPDocs: c698f26

Will probably rename 'unhide' to 'reveal', as Petar suggested below

emodric · 2025-06-06T09:05:53Z

bundle/Controller/TagViewController.php

@@ -14,6 +14,14 @@ final class TagViewController extends Controller
     */
    public function viewAction(TagView $view): TagView
    {
+        if ($view->getTag()->isHidden) {
+            throw $this->createNotFoundException('Tag is hidden.');


We don't need the message here. As this is the frontend, we do not want to communicate any revealing info.

As far as the user is concerned, the tag does not exist and that's it.

Also, here, you can only check for visible/invisible since when the tag is hidden, it should automatically be invisible too. That is, it is not possible for the tag to be hidden but not invisible too.

Removed the message: c698f26

emodric · 2025-06-06T09:06:31Z

bundle/Core/Event/TagsService.php

@@ -226,6 +226,16 @@ public function newTagUpdateStruct(): TagUpdateStruct
        return $this->service->newTagUpdateStruct();
    }

+    public function hideTag(Tag $tag): void
+    {
+        $this->service->hideTag($tag);


No event dispatching here and in unhide tag method?

Forgot about them... added them now: 69672a5

emodric · 2025-06-06T09:08:30Z

bundle/Core/Persistence/Legacy/Tags/Gateway/DoctrineDatabase.php

+                $query->expr()->like('path_string', ':path_string'),
+            )
+            ->andWhere(
+                $query->expr()->neq('id', ':tag_id'),


When hiding a tag, the hidden root tag should also be invisible, so we don't need this neq condition.

This is the way Ibexa works when hiding content, so there is no need to do this differently here. It will only cause confusion in the long run.

Ok, didn't know that this was how Ibexa works.
Removed the neq: f8bcf8d

emodric · 2025-06-06T09:11:14Z

bundle/Core/Persistence/Legacy/Tags/Gateway/DoctrineDatabase.php

+                $query->expr()->like('path_string', ':path_string'),
+            )
+            ->andWhere(
+                $query->expr()->neq('id', ':tag_id'),


Same remark about root tag invisibility goes here.

Also, I think we need to consider here what happens when some tag is already hidden explicitly below the tag being unhidden here. In that case, we can't really make tags below the already hidden tag invisible to maintain data consistency. We should see how Ibexa does this and just copy the implementation from there.

Fixed the tag invisibility in the above comment.

Regarding the problem you mentioned about looking at the descendant tags and leaving them invisible if they have at least one parent that is explicitly hidden, I fixed it here:
8b20a72 54ec1e9 45b2f03

emodric · 2025-06-06T09:12:51Z

bundle/Core/Persistence/Legacy/Tags/Mapper.php

@@ -35,6 +35,8 @@ public function createTagInfoFromRow(array $row): TagInfo
        $tagInfo->alwaysAvailable = (bool) ((int) $row['language_mask'] & 1);
        $tagInfo->mainLanguageCode = $this->languageHandler->load($row['main_language_id'])->languageCode;
        $tagInfo->languageIds = $this->languageMaskGenerator->extractLanguageIdsFromMask((int) $row['language_mask']);
+        $tagInfo->isHidden = (bool) ((int) $row['is_hidden']);


We don't need double cast here. You probably copied the thing from (bool) ((int) $row['language_mask'] & 1), but that has double cast due to bitwise and operator.

Removed the double cast, kept only the bool one: e5b2f5f

emodric · 2025-06-06T09:14:43Z

bundle/Resources/config/policies.yaml

@@ -9,3 +9,5 @@ tags:
    deletesynonym: ~
    makesynonym: ~
    merge: ~
+    hide: ~


You're missing hidesysnonym and unhidesynonym policies here. Also do we really need policies for both hide and unhide?

Added hidesynonym and unhidesynonym policies: 7e88bdd

I also thought that just one policy for hiding tags is enough, but I made two just for clarity.
If you want, I can only leave 'hide' and 'hidesynonym' policies, which will mean that the user can both hide and reveal tags.

emodric · 2025-06-06T09:15:49Z

bundle/Resources/views/admin/eztags_content_field.html.twig

+        >
+            {{ tag.keyword }}
+            {% if tag.isHidden %}
+                (hidden)


Needs translations too.

Added translations here for '(hidden)' and '(hidden by parent)': dece52c

bundle/API/Repository/TagsService.php

…e schemas and fix MapperTest

…ible' fields

…g shown to the user

…visible' fields in Mapper

…latable in 'eztags' content field

…isibility

…sible when revealing a tag

…creating a tag

…and descendant hidden tags

…operty

AntePrkacin · 2025-06-10T08:34:40Z

Added show_hidden config parameter to the configTreeBuilder. By default it is set to true. This parameter can be changed for each site access.

Implemented the following methods of the TagsService class to look at this parameter:

loadTagChildren()
getTagChildrenCount()
loadTagsByKeyword()
getTagsByKeywordCount()
searchTags()
loadTagSynonyms()
getTagSynonymCount()

086e954 4af3ecd 0f8c7dd 75858b8

…en)' text next to synonym name if the synonym is hidden

… the tag is hidden

…s for revealTag() and hideTag() methods

…eeController

… for some tag

…tags field

…dden' and 'is_invisible' properties

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

pspanja · 2025-06-12T08:00:57Z

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,


Should this be controlled through the configuration as well?

I hardcoded here false because the autoCompleteAction() method is used for searching a tag to add it in eztags field. If the showHidden parameter wasn't false here, then the user could add a hidden tag to some content by searching for it when editing a content.

True, but there might be a use case where you prepare the Tags and Content in advance, and just reveal the Tags at some time point. I'll leave it to @emodric.

cc @Ljudevit for info, maybe you have a use case for this?

I would like to agree with @AntePrkacin on this one that we should always avoid outputting hidden tags in the autocomplete actions like searching for tags in tag fields, but there can be some quite silly edge-cases where editor would hide the tag so tags/view page is not visible yet, but they would like to start filling in the content with those hidden tags before revealing the tag all-together.

For sure this configuration parameter must be set to false as default, but for those pesky edge-cases, a parameter is needed.

Yes, parameter is definitely needed.

Also, please do not use named parameters, at least not mixed like this, it just looks wrong :D Either change all of them to use named parameters, or none.

pspanja · 2025-06-12T08:10:23Z

bundle/Controller/Admin/TagController.php

+    {
+        $this->denyAccessUnlessGranted('ibexa:tags:hide' . ($tag->isSynonym() ? 'synonym' : ''));
+
+        $this->tagsService->hideTag($tag);


Do we need to check the submitted button and CSRF token here?

Yes, we do. There is an example in deleteTagAction method.

pspanja · 2025-06-12T08:10:29Z

bundle/Controller/Admin/TagController.php

+    {
+        $this->denyAccessUnlessGranted('ibexa:tags:reveal' . ($tag->isSynonym() ? 'synonym' : ''));
+
+        $this->tagsService->revealTag($tag);


Do we need to check the submitted button and CSRF token here?

Yes, we do. There is an example in deleteTagAction method.

bundle/Controller/Admin/TagController.php

bundle/Controller/Admin/TreeController.php

pspanja · 2025-06-12T08:26:46Z

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;


Possibly we should have a default value for $showHidden here, instead of resolving it in the Persistence implementation. @emodric I'll leave that up to you :)

(Then the same applies for the similar cases below)

Edit: ignore the above, I think the parameter should not be optional in the Persistence layer, we probably need it to be optional here so we can properly handle it in the siteaccess-aware implementation.

I agree with @pspanja , however, nullable bool seems weird. Either we show or hide hidden tags, there's no third option for null. So bool $showHidden = false is probably good enough.

@emodric one question though, if here the default is not null, how do we detect explicitly passed value in the siteaccess-aware layer?

Hm. Good point. Although, do we even have the need for explicit API layer control of this flag? Can we rely only on siteaccess aware config?

I would say we do, this is not only for rendering, it might be used in import for example.

Import scripts can be run in admin siteaccess if needed.

It's just weird design, is all, since API interface presumes that somwhere down below, the value we give to the method might be overriden.

But okay, if there are valid usecases, I can live with it.

bundle/Core/Persistence/Legacy/Tags/Mapper.php

…nd remove double cast from the Mapper

pspanja · 2025-06-12T13:17:31Z

@AntePrkacin you can add upgrade instructions in doc/UPGRADE.md, including database migration, as was already done here: https://github.com/netgen/TagsBundle/blob/master/doc/UPGRADE.md#notes-on-upgrading-to-ez-platform-22

Use 5.4.0 as the next version.

… file

AntePrkacin · 2025-06-17T13:54:04Z

Updated the doc/UPGRADE.md file with update instructions and sql queries to include is_hidden and is_invisible columns (08ef43d). Correct me if anything needs to be fixed.

emodric · 2025-06-18T13:24:11Z

bundle/Controller/Admin/TagController.php

@@ -666,6 +706,60 @@ public function deleteTagsAction(Request $request, ?Tag $parentTag = null): Resp
        );
    }

+    public function hideTagsAction(Request $request, ?Tag $parentTag = null): Response


Same here with CSRF. What we need to do here is create a Symfony multiselect form for selecting the tags in lieu of moveTagsAction method. Same goes for revealTagsAction.

emodric · 2025-06-18T13:26:04Z

bundle/Controller/Admin/TreeController.php

                ],
            ],
        ];
    }

-    private function escape(string $string): string
+    private function formatTagTreeText(Tag $tag): string


We shouldn't mix escaping and formating. That is, leave escape method as is, and just reuse is in the new formatTagTreeText method. After all, all of the text should be escaped AFTER formatting it, and not just the starting text.

emodric · 2025-06-18T13:27:18Z

bundle/Core/Persistence/Legacy/Tags/Gateway/DoctrineDatabase.php

@@ -154,6 +161,13 @@ public function getChildren(int $tagId, int $offset = 0, int $limit = -1, ?array
        }

        $query = $this->createTagFindQuery($translations, $useAlwaysAvailable);
+
+        if ($showHidden !== null && $showHidden === false) {


If $showHidden were not nullable, as mentioned before, you wouldn't need double check here and in other places.

emodric · 2025-06-18T13:29:37Z

bundle/DependencyInjection/Configuration.php

@@ -155,6 +155,10 @@ public function getConfigTreeBuilder(): TreeBuilder
                        ->defaultValue(25)
                    ->end()
                ->end()
+            ->end()
+            ->booleanNode('show_hidden')


We should be explicit and name this show_hidden_tags.

emodric · 2025-06-18T13:31:35Z

bundle/Resources/sql/mysql/schema.sql

@@ -9,6 +9,8 @@ CREATE TABLE `eztags` (
  `remote_id` varchar(100) NOT NULL default '',
  `main_language_id` int(11) NOT NULL default '0',
  `language_mask` int(11) NOT NULL default '0',
+  `is_hidden` tinyint NOT NULL DEFAULT '0',


We also need MySQL and PostgreSQL upgrade scripts (see bundle/Resources/sql/upgrade folder).

emodric · 2025-06-18T13:32:19Z

doc/UPGRADE.md

+If you're using MySQL, run the commands below:
+
+```sql
+ALTER TABLE `eztags` ADD COLUMN `is_hidden` TINYINT NOT NULL DEFAULT 0;


These should go to an upgrade SQL script as mentioned before and just referenced here.

AntePrkacin added 11 commits May 23, 2025 19:08

NGSTACK-977 add 'isHidden' and 'isInvisible' properties to Tag object…

0c21b61

… in both API and persistence layer

NGSTACK-977 update database schema to include 'is_hidden' and 'is_inv…

71034c0

…isible' columns in 'eztags' table

NGSTACK-977 add support for 'isHidden' and 'isInvisible' properties i…

981a985

…n DoctrineDatabase, TagsMapper and Mapper classes

NGSTACK-977 add support for 'isHidden' and 'isInvisible' fields in tr…

d3dc59e

…anslation files and display them in admin UI

NGSTACK-977 add 'Hide tag' button and its functionality in admin inte…

62ba8ad

…rface

NGSTACK-977 add 'Unhide tag' button and its functionality in admin in…

0ee8a42

…terface

NGSTACK-977 fix bug when creating queries and update translations to …

033de91

…show when a tag is hidden by parent

NGSTACK-977 add functionality for hiding and unhiding selected childr…

b47e3a5

…en tags

NGSTACK-977 throw 404 on frontend if tag is hidden

302837d

NGSTACK-977 add 'disabled' property to hidden tags and disable adding…

fcabf76

… hidden tags to content

NGSTACK-977 add 'hidden' text after hidden tags in eztags content field

402ca4c

AntePrkacin requested review from emodric and pspanja June 6, 2025 08:58

AntePrkacin self-assigned this Jun 6, 2025

emodric requested changes Jun 6, 2025

View reviewed changes

NGSTACK-977 fix php-cs-fixer and phpstan reports

f12c262

pspanja reviewed Jun 6, 2025

View reviewed changes

bundle/API/Repository/TagsService.php Outdated Show resolved Hide resolved

AntePrkacin added 13 commits June 6, 2025 12:22

NGSTACK-977 add 'is_hidden' and 'is_invisible' fields to test databas…

9813914

…e schemas and fix MapperTest

NGSTACK-977 fix TagsIntegrationTest by adding 'isHidden' and 'isInvis…

9987286

…ible' fields

NGSTACK-977 update phpdocs and remove tag visibility information bein…

c698f26

…g shown to the user

NGSTACK-977 modify gateway to make the hidden tag also invisible

f8bcf8d

NGSTACK-977 remove unnecessary cast to int for 'is_hidden' and 'is_in…

e5b2f5f

…visible' fields in Mapper

NGSTACK-977 add 'hidesynonym' and 'unhidesynonym' policies

7e88bdd

NGSTACK-977 add translation domain and make tag visibility info trans…

dece52c

…latable in 'eztags' content field

NGSTACK-977 change all 'unhide' text to 'reveal' regarding the tags v…

543afc4

…isibility

NGSTACK-977 make descendant tags who have one hidden parent stay invi…

8b20a72

…sible when revealing a tag

NGSTACK-977 fix logic for revealing a hidden tag

54ec1e9

NGSTACK-977 set 'is_hidden' and 'is_invisible' fields correctly when …

a61028b

…creating a tag

NGSTACK-977 update logic for revealing a tag to handle both ancestor …

45b2f03

…and descendant hidden tags

NGSTACK-977 fix a test for creating a tag by adding 'is_invisible' pr…

e50dfdb

…operty

AntePrkacin added 2 commits June 10, 2025 10:51

NGSTACK-977 update PHPDoc for hide and reveal methods and add ' (hidd…

d99a9d4

…en)' text next to synonym name if the synonym is hidden

NGSTACK-977 add ' (hidden)' next to tag keyword in the TagTreeData if…

d09d660

… the tag is hidden

AntePrkacin force-pushed the NGSTACK-977-tags-visibility branch from 98cce00 to d09d660 Compare June 10, 2025 09:10

AntePrkacin added 5 commits June 10, 2025 14:25

NGSTACK-977 update DoctrineDatabaseTest and TagsHandlerTest with test…

a6d7415

…s for revealTag() and hideTag() methods

NGSTACK-977 add 'hide_tag' and 'reveal_tag' data to the TagTree in Tr…

eed05e2

…eeController

NGSTACK-977 add visibility information for children when listing them…

37da894

… for some tag

NGSTACK-977 not show hidden tags when trying to search for them in ez…

e69b243

…tags field

NGSTACK-977 update postgresql schema and legacy.yaml file with 'is_hi…

514e3d0

…dden' and 'is_invisible' properties