NGSTACK-906 eztags priority sorting #170

AntePrkacin · 2025-06-20T09:24:09Z

Two main things:

added priority property to the Tag object
added functionality to sort tags by either id, keyword, modified or priority

The sorting functionality is added below the children list for some tag. If tag has no children, then the sorting functionality is not rendered at all.

The sorting works by modifying the getChildren() method in the Gateway layer. It first sorts and orders the fetched data and then slices it by using offset and limit values.

…perty

…greSQL database schemas

… sortOrder

…r and update adapter implementation

…rvice layer

…Handler

…ay layer

…n admin UI

…bottom of children list

emodric · 2025-06-23T11:22:08Z

bundle/API/Repository/TagsService.php

     *
     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException If the current user is not allowed to read tags
     *
     * @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, ?string $sortBy = null, ?string $sortOrder = null): TagList;


Do we need this level of control, in contrast to just using whatever info is storred on parent tag?

I think this level of control is necessary because in the Gateway layer (getChildren() method), the fetched data from the database needs to first be sorted and then sliced using $limit and $offset values.

Which info stored on parent tag do you mean? Perhaps another approach for sorting would be if each Tag object would have information attached to it about the sortBy and sortOrder, something like the Location object in Ibexa has (if I'm not mistaken).

EDIT: read the comment below this one. OK, I will implement the sorting mechanism similar to the Ibexa one

emodric · 2025-06-23T11:23:59Z

bundle/Controller/Admin/TagController.php

@@ -45,6 +45,12 @@ public function showTagAction(Request $request, ?Tag $tag = null): Response
        if (!$tag instanceof Tag || !$tag->isSynonym()) {
            $configResolver = $this->getConfigResolver();

+            $sortBy = $request->query->get('sort_by');


I was under the impression that the sorting mechanism will be stored on parent tag, similar to how Ibexa does it in their locations. That way, you don't need to set the sorting for every children fetch, it will automatically fetch tags with the defined sort.

Default sort can then be set in configuration.

emodric · 2025-06-23T11:26:02Z

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

-        ->setMaxResults($limit > 0 ? $limit : PHP_INT_MAX);
+        )->setParameter('parent_id', $tagId, Types::INTEGER);
+
+        if ($sortBy !== null && $sortOrder !== null) {


We should have an enum with allowed sorting property and sorting directions, so we don't need to pass direct values. This way, we would only allow sorting by predefined columns, and not besically anything the user sends down the method call chain.

Added enums for sortBy and sortOrder: 4224d33
Also used enum cases to iterate over different options when selecting the property by which the user wants to sort the tags.

emodric · 2025-06-23T11:27:04Z

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

+            $tagIdsQuery->orderBy('eztags.keyword', 'ASC');
+        }
+
+        $tagIdsQuery


You don't need to separate setFirstResult and setMaxResults method calls from the main query builder calls.

I put it back together, after refactoring the whole process of sorting children tags

… TagInfo object

…en() method in Gateway layer

…ren() method in Handler layer

…ildren() method in Service layer

…nd move it out of tabs folder

…d TagStruct classes

…d and sortOrder data for some tag

… DoctrineDatabase class

emodric · 2025-06-24T13:05:50Z

bundle/Controller/Admin/TagController.php

+        $sortOrder = $request->request->get('sort_order');
+
+        $tagUpdateStruct = new TagUpdateStruct();
+        $tagUpdateStruct->sortField = TagSortField::from((string) $sortBy);


You can use ::tryFrom here, catch the exception and throw BadRequestHttpException. Otherwise, transfering an invalid value would get you error 500.

Did so here: e16f73f

emodric · 2025-06-24T13:07:39Z

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

@@ -128,6 +128,10 @@ public function getFullTagDataByKeywordAndParentId(string $keyword, int $parentI

    public function getChildren(int $tagId, int $offset = 0, int $limit = -1, ?array $translations = null, bool $useAlwaysAvailable = true): array
    {
+        $tagData = $tagId !== 0 ? $this->getBasicTagData($tagId) : [];
+        $sortBy = $tagData['sort_by'] ?? 'id';


We should add configuration for the default sort.

We also need configuration for the default sort for root tag (which has ID = 0), since we can't store this in the database.

You can also try to instantiate the enum to double check that the value stored in the database is an allowed stored type and direction.

First four commits made on 25 June 2025 are regarding the config parameters for default sorting.

There are two new config parameters added:

one for default sorting of all child tags (sort.by and sort.order)

one for default sorting of root tag children (sort.root.by and sort.root.order)

These config parameters are enums (enumNode), so their values will always match the cases of enum. There is even an option to put an enum class in the node, but that is only for Symfony 7.3 (I don't know which Symfony versions you want this bundle to support).

Also, in the database, the 'sort_by' and 'sort_order' column types were changed from enums to just varchar(100). By default, when a new tag is added, it will have ~~empty string ('')~~ NULL set at 'sort_by' and 'sort_order' columns - in this case, these two new config parameters will be fetched for sorting.
Only when the user sorts the children tags of some tag, then will the 'sort_by' and 'sort_order' columns be set for that (parent) tag.

This was done because the <someEnum>::tryFrom() method returns null if the corresponding (given) string has no matching case. In that case, the configResolver is used to get a parameter. Example:

$tag->sortBy = TagSortBy::tryFrom($row['sort_by']) ?? TagSortBy::from($this->configResolver->getParameter('sort.by', 'netgen_tags'));

…enum cases in sort_children_tags template and add translation for enums

…ms don't fit the enums when updating children sorting for some tag

…varchar in database

…ing specifically root tag children

… determining sortBy and sortOrder properties

AntePrkacin · 2025-06-25T11:02:32Z

Should the dropdowns for sorting by and sorting order be added/shown to the 'Top level tags'? Or is it good enough to just be able to set the sort.root.by and sort.root.order config parameters for sorting the children of the 'Top level tags'?

…tag and also show tag priority below the tag title

…for it

AntePrkacin · 2025-06-25T12:20:17Z

148a3c3
Added ability to change the priority property when editing a certain tag. Also, the information about tag priority will be displayed below the tag title (along with Tag ID, Remote ID and Modified properties).

emodric · 2025-06-25T12:20:21Z

We don't have anywhere to store this info, so for now, the config is good enough for top level tags.

…Tag objects and in the database

…base to properly handle the case when sortBy or sortOrder is null

…sortOrder is null and extracted that logic in a separate function

…sortOrder is null and fix TagsIntegrationTest

AntePrkacin · 2025-06-25T14:17:49Z

59beb45 84d9758 fd507dd a81d3f6
There was a problem when editing a certain tag. For example, when you went to edit a priority for some tag and hit 'save', the sort_by and sort_order properties (and columns in the database) would automatically be assigned the default values (from the config params).

I wanted to avoid this because then, if someone changes the config params for default sorting, the sorting will not change for this one tag because (unintentionally) editing the tag already set the sorting.

With the commits I pasted above, this problem is handled by making the sortBy and sortOrder properties be null (by default - both for the database and for the entity). ONLY when the user clicks to sort the tags (the thing the user can click below the children list in adminUI), only then are the sort_by and sort_order columns set in the database.

…'sort_by' and 'sort_order' columns and updated the UPGRADE doc

AntePrkacin · 2025-06-26T07:24:27Z

0ce8c25
Updated the doc/UPGRADE.md file with update instructions for this PR. Also added the upgrade scripts to add priority, sort_by and sort_order columns to eztags table.

3e9628a
Removed 'priority' info when showing synonyms and removed the 'priority' field when editing or adding a synonym to some tag. I think it makes no sense to show 'priority' info on synonyms, since there is no sorting for them at all. These synonyms will still have priority be 0 in the database, but that data won't be shown anywhere.

031c1aa
Added policy for sorting

…ty' field when adding or editing a synonym

…cy schema

AntePrkacin added 16 commits June 18, 2025 09:39

NGSTACK-906 add 'priority' property to Tag objects

c843d14

NGSTACK-906 add support for 'priority' property in the Mapper layer

1c5b716

NGSTACK-906 modify createTagFindQuery method to select 'priority' pro…

2d27fc0

…perty

NGSTACK-906 add 'priority' column to 'eztags' table in MySQL and Post…

a8cf605

…greSQL database schemas

NGSTACK-906 add translations for tag priority

3a84111

NGSTACK-906 show 'priority' column for tag's children

8e535ea

NGSTACK-906 add 'subitems' tab to the show tag template

7d59685

NGSTACK-906 add 'subitems' tab template with dropdowns for sortBy and…

fe7ba81

… sortOrder

NGSTACK-906 add translations for tag subitems sorting

9158a5d

NGSTACK-906 update tag children sorting functionality in TagControlle…

9ce9427

…r and update adapter implementation

NGSTACK-906 add support for sorting in loadTagChildren() method in Se…

60cf2cf

…rvice layer

NGSTACK-906 add support for sorting in loadChildren() method for Tag …

1041265

…Handler

NGSTACK-906 add support for sorting in getChildren() method for Gatew…

0955f35

…ay layer

NGSTACK-906 update subitems sort option value from 'tag_id' to 'id' i…

43def26

…n admin UI

NGSTACK-906 remove 'subitems' tag tab and add the tag sorting at the …

f0aa890

…bottom of children list

NGSTACK-906 update tests to handle 'priority' property

f1e4e1a

AntePrkacin requested review from emodric, pspanja and Ljudevit June 20, 2025 09:24

AntePrkacin self-assigned this Jun 20, 2025

emodric reviewed Jun 23, 2025

View reviewed changes

AntePrkacin added 6 commits June 24, 2025 11:53

NGSTACK-906 add enums for tag sortField and sortOrder properties

6139978

NGSTACK-906 add sortField and sortOrder properties to Tag objects and…

df8003b

… TagInfo object

NGSTACK-906 update Mappers with sortField and sortOrder fields

ef0d60a

NGSTACK-906 remove sortBy and sortOrder parameters from the getChildr…

be00504

…en() method in Gateway layer

NGSTACK-906 remove sortBy and sortOrder parameters from the loadChild…

d88c066

…ren() method in Handler layer

NGSTACK-906 remove sortBy and sortOrder parameters from the loadTagCh…

c0bf0f4

…ildren() method in Service layer

AntePrkacin added 6 commits June 24, 2025 14:17

NGSTACK-906 rename subitems template to sort_children_tags template a…

c719cc4

…nd move it out of tabs folder

NGSTACK-906 add sortField and sortOrder properties to UpdateStruct an…

93c1134

…d TagStruct classes

NGSTACK-906 remove sorting logic in ChildrenTagsAdapter

41e6787

NGSTACK-906 add new route and controller method for updating sortFiel…

705fc35

…d and sortOrder data for some tag

NGSTACK-906 rename sortField property to sortBy property everywhere

2397fcc

NGSTACK-906 add logic for sorting children by sortBy and sortOrder in…

c6c4555

… DoctrineDatabase class

emodric reviewed Jun 24, 2025

View reviewed changes

AntePrkacin added 7 commits June 24, 2025 15:24

NGSTACK-906 fix tests regarding sortBy and sortOrder properties

4a5391d

NGSTACK-906 update TagSortBy and TagSortOrder enums, iterate through …

4224d33

…enum cases in sort_children_tags template and add translation for enums

NGSTACK-906 throw BadRequestHttpException if sortBy or sortOrder para…

e16f73f

…ms don't fit the enums when updating children sorting for some tag

NGSTACK-906 change sort_by and sort_order column types from enums to …

dba4689

…varchar in database

NGSTACK-906 add config params for sorting all child tags and for sort…

a6100ae

…ing specifically root tag children

NGSTACK-906 update Mapper and DoctrineDatabase Gateway with logic for…

5733962

… determining sortBy and sortOrder properties

NGSTACK-906 add support for 'sort' config params in tests

5479257

AntePrkacin added 2 commits June 25, 2025 13:59

NGSTACK-906 add ability to modify 'priority' property when editing a …

148a3c3

…tag and also show tag priority below the tag title

NGSTACK-906 fix the update() method in DoctrineDatabase and the test …

3704566

…for it

AntePrkacin added 4 commits June 25, 2025 16:05

NGSTACK-906 update 'sortBy' and 'sortOrder' properties to be null on …

59beb45

…Tag objects and in the database

NGSTACK-906 update getChildren() and update() methods in DoctrineData…

84d9758

…base to properly handle the case when sortBy or sortOrder is null

NGSTACK-906 update Mapper to properly handle the case when sortBy or …

fd507dd

…sortOrder is null and extracted that logic in a separate function

NGSTACK-906 update sort_children_tags template to check if sortBy or …

a81d3f6

…sortOrder is null and fix TagsIntegrationTest

NGSTACK-906 add MySQL and PostgreSQL upgrade scripts for 'priority', …

0ce8c25

…'sort_by' and 'sort_order' columns and updated the UPGRADE doc

AntePrkacin added 3 commits June 26, 2025 13:08

NGSTACK-906 don't show 'priority' info on synonyms and remove 'priori…

3e9628a

…ty' field when adding or editing a synonym

NGSTACK-906 add 'priority', 'sort_by' and 'sort_order' fields to lega…

c6d1f47

…cy schema

NGSTACK-906 add policy for sorting children tags

031c1aa

NGSTACK-906 eztags priority sorting #170

Are you sure you want to change the base?

NGSTACK-906 eztags priority sorting #170

Uh oh!

Conversation

AntePrkacin commented Jun 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AntePrkacin Jun 24, 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!

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 25, 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!

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

Uh oh!

Uh oh!

AntePrkacin commented Jun 25, 2025

Uh oh!

emodric commented Jun 25, 2025

Uh oh!

AntePrkacin commented Jun 25, 2025

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

AntePrkacin Jun 24, 2025 •

edited

Loading

AntePrkacin Jun 25, 2025 •

edited

Loading

AntePrkacin commented Jun 25, 2025 •

edited

Loading

AntePrkacin commented Jun 26, 2025 •

edited

Loading