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 any changes about this? Should I just make one policy (e.g. visibility) or leave it as it is now?

I think one is enough. I don't see a usecase where someone can only hide, but not reveal and vice versa.

I would also remove the "synonym" variant too, which would leave only one hide policy for everything.

Left only the 'hide' policy, removed the rest: 71a9102

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

…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 OK. Just to confirm that I understood correctly - I will remove the 'Hide selected tags' and 'Reveal selected tags' buttons below the children list - childrenAction() method. Instead, I will put two new buttons (somewhere else) that tell 'Hide kids' or 'Reveal kids'. When either of them is pressed, a multiselect form will show up where the user will be able to select the desired tags they want to hide or reveal.

No no, do it in the same way as it is now, but with Symfony form in lieu of "move tags". Try and see if you can reuse the existing form type. It's now called MoveTagsType, try to reuse it by renaming it to e.g. MultiselectTagsType or similar.

Renamed MoveTagsType form to MultiselectTagsType form and used it when hiding and revealing multiple tags:
c05ab16 07866bc

@AntePrkacin Sounds good 👍

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.

Separated the escape logic from the formatting logic: 4a174cc

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.

Renamed show_hidden to show_hidden_tags here in the ConfigTree as well as in Service, Handler and Gateway layers (renamed parameter $showHidden to $showHiddenTags): 6692248

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).

Added MySQL and PostgreSQL upgrade scripts: 203dcd6

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.

Added MySQL and PostgreSQL upgrade scripts and referenced them here (doc/UPGRADE.md): 203dcd6

… and revealing a tag with CSRF token check

…eyword in TreeController

…igTree, Service, Handler and Gateway layers

…and 'is_invisible' columns

…add 'show_parent_field' option to the form

…Controller to use MultiselectTagsType form and render new templates

…onfigTreeBuilder and contextualize it

…look at 'autocomplete_provide_hidden_tags' config parameter

pspanja · 2025-06-25T06:34:28Z

@emodric depends a bit on how we solve some other open questions, but we should probably take care that non-visible tags are not indexed.

…n searching to add a tag to some content

…Netgen Tags adminUI

… and add the ability to select hidden tags in those processes

…lates

…ds that have showHiddenTags as parameter in DoctrineDatabase

…id' property

AntePrkacin · 2025-06-26T11:15:22Z

fd4e11f
When converting a certain tag to a synonym, the user needs to select the tag for which they want this synonym to be (to represent). In this case, I've added the ability that the user can select a hidden tag for which they want to create a synonym. If the tag they (the user) chose for conversion was hidden, it will remain hidden also after the conversion.

The same is valid when merging a tag - the user can select a hidden tag to which they want to merge some tag.

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

NGSTACK-977 extract TagTreeText formatting into a separate function a…

a69c38c

…nd remove double cast from the Mapper

NGSTACK-977 add upgrade instructions for tag visibility to UPGRADE.md…

08ef43d

… file

emodric reviewed Jun 18, 2025

View reviewed changes

AntePrkacin added 9 commits June 23, 2025 09:40

NGSTACK-977 update hideAction() and revealAction() methods for hiding…

550f0e3

… and revealing a tag with CSRF token check

NGSTACK-977 separate escape logic from the formatting logic for tag k…

4a174cc

…eyword in TreeController

NGSTACK-977 rename 'showHidden' to 'showHiddenTags' parameter in conf…

6692248

…igTree, Service, Handler and Gateway layers

NGSTACK-977 add MySQL and PostgreSQL upgrade scripts for 'is_hidden' …

203dcd6

…and 'is_invisible' columns

NGSTACK-977 fix a call to searchTags() method in FieldController

ec62925

NGSTACK-977 rename MoveTagsType form to MultiselectTagsType form and …

c05ab16

…add 'show_parent_field' option to the form

NGSTACK-977 update hideTagsAction and revealTagsAction methods in Tag…

07866bc

…Controller to use MultiselectTagsType form and render new templates

NGSTACK-977 add 'autocomplete_provide_hidden_tags' parameter to the c…

535890e

…onfigTreeBuilder and contextualize it

NGSTACK-977 modify autoCompleteAction() method in FieldController to …

96279be

…look at 'autocomplete_provide_hidden_tags' config parameter

AntePrkacin added 7 commits June 26, 2025 09:52

NGSTACK-977 make autocomplete suggestions not show invisible tags whe…

9a00e4e

…n searching to add a tag to some content

NGSTACK-977 add data about tag visibility when searching for tags in …

cf15dfc

…Netgen Tags adminUI

NGSTACK-977 fix tag converting to synonym process and merging process…

fd4e11f

… and add the ability to select hidden tags in those processes

NGSTACK-977 remove dump statements from 'hide' and 'reveal' twig temp…

c81ccef

…lates

NGSTACK-977 update 'is_hidden' check to 'is_invisible' check in metho…

45cf8e6

…ds that have showHiddenTags as parameter in DoctrineDatabase

NGSTACK-977 fix revealing a hidden synonym by checking the 'main_tag_…

50a4c29

…id' property

NGSTACK-977 update testConvertToSynonym to check 'is_invisible' property

40605b9

AntePrkacin added 2 commits June 26, 2025 13:50

NGSTACK-977 add some missing translations for french langauge

88fc80e

NGSTACK-977 change policies to only have one for hiding and revealing

71a9102

NGSTACK-977 tags visibility #169

Are you sure you want to change the base?

NGSTACK-977 tags visibility #169

Uh oh!

Conversation

AntePrkacin commented Jun 6, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AntePrkacin Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AntePrkacin Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pspanja commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AntePrkacin commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

emodric Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AntePrkacin Jun 9, 2025 •

edited

Loading

AntePrkacin Jun 26, 2025 •

edited

Loading

pspanja commented Jun 12, 2025 •

edited

Loading

AntePrkacin commented Jun 17, 2025 •

edited

Loading

emodric Jun 18, 2025 •

edited

Loading