NGSTACK-906 eztags priority sorting

bundle/API/Repository/TagsService.php

@@ -71,12 +71,14 @@ public function loadTagByUrl(string $url, array $languages): Tag;
      * @param int $limit The number of tags returned. If $limit = -1 all children starting at $offset are returned
      * @param string[]|null $languages A language filter for keywords. If not given all languages are returned
      * @param bool $useAlwaysAvailable Add main language to $languages if true (default) and if tag is always available
+     * @param string|null $sortBy The field to sort the children by (e.g. 'id', 'keyword', 'modificationDate', 'priority')
+     * @param string|null $sortOrder The sort direction, either 'asc' or 'desc'
      *
      * @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;
 
     /**
      * Returns the number of children of a tag object.

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

@@ -28,6 +28,7 @@
  * @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 int $priority Tag priority
  */
 final class Tag extends ValueObject
 {
@@ -104,6 +105,13 @@ final class Tag extends ValueObject
      */
     protected ?string $prioritizedLanguageCode;
 
+    /**
+     * Tag priority.
+     *
+     * Position of the Tag among its siblings when sorted by priority.
+     */
+    protected int $priority;
+
     /**
      * Construct object optionally with a set of properties.
      *

bundle/Controller/Admin/TagController.php

@@ -8,6 +8,7 @@
 use Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException;
 use Netgen\TagsBundle\API\Repository\TagsService;
 use Netgen\TagsBundle\API\Repository\Values\Tags\Tag;
+use Netgen\TagsBundle\Core\Pagination\Pagerfanta\ChildrenTagsAdapter;
 use Netgen\TagsBundle\Core\Pagination\Pagerfanta\SearchTagsAdapter;
 use Netgen\TagsBundle\Form\Type\CopyTagsType;
 use Netgen\TagsBundle\Form\Type\LanguageSelectType;
@@ -16,7 +17,6 @@
 use Netgen\TagsBundle\Form\Type\TagCreateType;
 use Netgen\TagsBundle\Form\Type\TagMergeType;
 use Netgen\TagsBundle\Form\Type\TagUpdateType;
-use Pagerfanta\Adapter\AdapterInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
@@ -29,7 +29,7 @@ final class TagController extends Controller
     public function __construct(
         private TagsService $tagsService,
         private ContentTypeService $contentTypeService,
-        private AdapterInterface $tagChildrenAdapter,
+        private ChildrenTagsAdapter $tagChildrenAdapter,
         private SearchTagsAdapter $searchTagsAdapter,
     ) {}
 
@@ -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');
+            $sortOrder = $request->query->get('sort_order');
+            if ($sortBy !== null && $sortOrder !== null) {
+                $this->tagChildrenAdapter->setSorting($sortBy, $sortOrder);
+            }
+
             $currentPage = (int) $request->query->get('page');
             $pager = $this->createPager(
                 $this->tagChildrenAdapter,

bundle/Core/Event/TagsService.php

@@ -38,9 +38,9 @@ public function loadTagByUrl(string $url, array $languages): Tag
         return $this->service->loadTagByUrl($url, $languages);
     }
 
-    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
     {
-        return $this->service->loadTagChildren($tag, $offset, $limit, $languages, $useAlwaysAvailable);
+        return $this->service->loadTagChildren($tag, $offset, $limit, $languages, $useAlwaysAvailable, $sortBy, $sortOrder);
     }
 
     public function getTagChildrenCount(?Tag $tag = null, ?array $languages = null, bool $useAlwaysAvailable = true): int

bundle/Core/Pagination/Pagerfanta/ChildrenTagsAdapter.php

@@ -11,16 +11,23 @@
 final class ChildrenTagsAdapter implements AdapterInterface, TagAdapterInterface
 {
     private ?Tag $tag = null;
-
     private int $nbResults;
+    private ?string $sortBy = null;
+    private ?string $sortOrder = null;
 
-    public function __construct(private TagsService $tagsService) {}
+    public function __construct(private readonly TagsService $tagsService) {}
 
     public function setTag(Tag $tag): void
     {
         $this->tag = $tag;
     }
 
+    public function setSorting(?string $sortBy, ?string $sortOrder): void
+    {
+        $this->sortBy = $sortBy;
+        $this->sortOrder = $sortOrder;
+    }
+
     public function getNbResults(): int
     {
         $this->nbResults = $this->nbResults ?? $this->tagsService->getTagChildrenCount($this->tag);
@@ -30,7 +37,15 @@ public function getNbResults(): int
 
     public function getSlice($offset, $length): iterable
     {
-        $childrenTags = $this->tagsService->loadTagChildren($this->tag, $offset, $length);
+        $childrenTags = $this->tagsService->loadTagChildren(
+            $this->tag,
+            $offset,
+            $length,
+            null,
+            true,
+            $this->sortBy,
+            $this->sortOrder,
+        );
 
         $this->nbResults = $this->nbResults ?? $this->tagsService->getTagChildrenCount($this->tag);
 

bundle/Core/Persistence/Cache/TagsHandler.php

@@ -155,11 +155,11 @@ public function loadTagByKeywordAndParentId(string $keyword, int $parentTagId, ?
         return $this->tagsHandler->loadTagByKeywordAndParentId($keyword, $parentTagId, $translations, $useAlwaysAvailable);
     }
 
-    public function loadChildren(int $tagId, int $offset = 0, int $limit = -1, ?array $translations = null, bool $useAlwaysAvailable = true): array
+    public function loadChildren(int $tagId, int $offset = 0, int $limit = -1, ?array $translations = null, bool $useAlwaysAvailable = true, ?string $sortBy = null, ?string $sortOrder = null): array
     {
         $this->logger->logCall(__METHOD__, ['tag' => $tagId, 'translations' => $translations, 'useAlwaysAvailable' => $useAlwaysAvailable]);
 
-        return $this->tagsHandler->loadChildren($tagId, $offset, $limit, $translations, $useAlwaysAvailable);
+        return $this->tagsHandler->loadChildren($tagId, $offset, $limit, $translations, $useAlwaysAvailable, $sortBy, $sortOrder);
     }
 
     public function getChildrenCount(int $tagId, ?array $translations = null, bool $useAlwaysAvailable = true): int

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

@@ -40,7 +40,7 @@ abstract public function getFullTagDataByKeywordAndParentId(string $keyword, int
      *
      * If $limit = -1 all children starting at $offset are returned.
      */
-    abstract public function getChildren(int $tagId, int $offset = 0, int $limit = -1, ?array $translations = null, bool $useAlwaysAvailable = true): array;
+    abstract public function getChildren(int $tagId, int $offset = 0, int $limit = -1, ?array $translations = null, bool $useAlwaysAvailable = true, ?string $sortBy = null, ?string $sortOrder = null): array;
 
     /**
      * Returns how many tags exist below tag identified by $tagId.

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

@@ -126,7 +126,7 @@ public function getFullTagDataByKeywordAndParentId(string $keyword, int $parentI
         return $query->execute()->fetchAll(FetchMode::ASSOCIATIVE);
     }
 
-    public function getChildren(int $tagId, int $offset = 0, int $limit = -1, ?array $translations = null, bool $useAlwaysAvailable = true): array
+    public function getChildren(int $tagId, int $offset = 0, int $limit = -1, ?array $translations = null, bool $useAlwaysAvailable = true, ?string $sortBy = null, ?string $sortOrder = null): array
     {
         $tagIdsQuery = $this->createTagIdsQuery($translations, $useAlwaysAvailable);
         $tagIdsQuery->andWhere(
@@ -137,10 +137,17 @@ public function getChildren(int $tagId, int $offset = 0, int $limit = -1, ?array
                 ),
                 $tagIdsQuery->expr()->eq('eztags.main_tag_id', 0),
             ),
-        )->setParameter('parent_id', $tagId, Types::INTEGER)
-        ->orderBy('eztags.keyword', 'ASC')
-        ->setFirstResult($offset)
-        ->setMaxResults($limit > 0 ? $limit : PHP_INT_MAX);
+        )->setParameter('parent_id', $tagId, Types::INTEGER);
+
+        if ($sortBy !== null && $sortOrder !== null) {
+            $tagIdsQuery->orderBy('eztags.' . $sortBy, $sortOrder);
+        } else {
+            $tagIdsQuery->orderBy('eztags.keyword', 'ASC');
+        }
+
+        $tagIdsQuery
+            ->setFirstResult($offset)
+            ->setMaxResults($limit > 0 ? $limit : PHP_INT_MAX);
 
         $statement = $tagIdsQuery->execute();
 
@@ -160,8 +167,13 @@ public function getChildren(int $tagId, int $offset = 0, int $limit = -1, ?array
                 [':id'],
             ),
         )
-        ->setParameter('id', $tagIds, Connection::PARAM_INT_ARRAY)
-        ->orderBy('eztags_keyword.keyword', 'ASC');
+        ->setParameter('id', $tagIds, Connection::PARAM_INT_ARRAY);
+
+        if ($sortBy !== null && $sortOrder !== null) {
+            $query->orderBy('eztags.' . $sortBy, $sortOrder);
+        } else {
+            $query->orderBy('eztags_keyword.keyword', 'ASC');
+        }
 
         return $query->execute()->fetchAll(FetchMode::ASSOCIATIVE);
     }
@@ -847,7 +859,7 @@ public function deleteTag(int $tagId): void
     private function createTagIdsQuery(?array $translations = null, bool $useAlwaysAvailable = true): QueryBuilder
     {
         $query = $this->connection->createQueryBuilder();
-        $query->select('DISTINCT eztags.id, eztags.keyword')
+        $query->select('DISTINCT eztags.id, eztags.keyword, eztags.modified, eztags.priority')
         ->from('eztags', 'eztags')
         // @todo: Joining with eztags_keyword is probably a VERY bad way to gather that information
         // since it creates an additional cartesian product with translations.
@@ -930,6 +942,7 @@ private function createTagFindQuery(?array $translations = null, bool $useAlways
             'eztags.remote_id',
             'eztags.main_language_id',
             'eztags.language_mask',
+            'eztags.priority',
             // Tag keywords
             'eztags_keyword.keyword',
             'eztags_keyword.locale',

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

@@ -71,10 +71,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
+    public function getChildren(int $tagId, int $offset = 0, int $limit = -1, ?array $translations = null, bool $useAlwaysAvailable = true, ?string $sortBy = null, ?string $sortOrder = null): array
     {
         try {
-            return $this->innerGateway->getChildren($tagId, $offset, $limit, $translations, $useAlwaysAvailable);
+            return $this->innerGateway->getChildren($tagId, $offset, $limit, $translations, $useAlwaysAvailable, $sortBy, $sortOrder);
         } catch (DBALException $e) {
             throw new RuntimeException('Database error', 0, $e);
         } catch (PDOException $e) {

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

@@ -89,9 +89,9 @@ public function loadTagByKeywordAndParentId(string $keyword, int $parentTagId, ?
         return reset($tag);
     }
 
-    public function loadChildren(int $tagId, int $offset = 0, int $limit = -1, ?array $translations = null, bool $useAlwaysAvailable = true): array
+    public function loadChildren(int $tagId, int $offset = 0, int $limit = -1, ?array $translations = null, bool $useAlwaysAvailable = true, ?string $sortBy = null, ?string $sortOrder = null): array
     {
-        $tags = $this->gateway->getChildren($tagId, $offset, $limit, $translations, $useAlwaysAvailable);
+        $tags = $this->gateway->getChildren($tagId, $offset, $limit, $translations, $useAlwaysAvailable, $sortBy, $sortOrder);
 
         return $this->mapper->extractTagListFromRows($tags);
     }

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

@@ -35,6 +35,7 @@ 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->priority = (int) $row['priority'];
 
         return $tagInfo;
     }
@@ -60,6 +61,7 @@ public function extractTagListFromRows(array $rows): array
                 $tag->alwaysAvailable = (bool) ((int) $row['language_mask'] & 1);
                 $tag->mainLanguageCode = $this->languageHandler->load($row['main_language_id'])->languageCode;
                 $tag->languageIds = $this->languageMaskGenerator->extractLanguageIdsFromMask((int) $row['language_mask']);
+                $tag->priority = (int) $row['priority'];
                 $tagList[$tagId] = $tag;
             }
 

bundle/Core/Repository/TagsMapper.php

@@ -67,6 +67,7 @@ public function buildTagDomainList(array $spiTags, array $prioritizedLanguages =
                     'mainLanguageCode' => $spiTag->mainLanguageCode,
                     'languageCodes' => $languageCodes,
                     'prioritizedLanguageCode' => $prioritizedLanguageCode,
+                    'priority' => $spiTag->priority,
                 ],
             );
         }

bundle/Core/Repository/TagsService.php

@@ -152,7 +152,7 @@ public function loadTagByUrl(string $url, array $languages): Tag
         return $this->mapper->buildTagDomainObject($spiTag, $languages);
     }
 
-    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
     {
         if ($this->hasAccess('tags', 'read') === false) {
             throw new UnauthorizedException('tags', 'read');
@@ -164,6 +164,8 @@ public function loadTagChildren(?Tag $tag = null, int $offset = 0, int $limit =
             $limit,
             $languages,
             $useAlwaysAvailable,
+            $sortBy,
+            $sortOrder,
         );
 
         $tags = [];

bundle/Core/SiteAccessAware/TagsService.php

@@ -52,14 +52,16 @@ public function loadTagByUrl(string $url, array $languages): Tag
         );
     }
 
-    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
     {
         return $this->innerService->loadTagChildren(
             $tag,
             $offset,
             $limit,
             $this->languageResolver->getPrioritizedLanguages($languages),
             $this->languageResolver->getUseAlwaysAvailable($useAlwaysAvailable),
+            $sortBy,
+            $sortOrder,
         );
     }
 

bundle/Resources/sql/mysql/schema.sql

@@ -9,6 +9,7 @@ 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',
+  `priority` int(11) NOT NULL default '0',
   PRIMARY KEY ( `id` ),
   KEY `idx_eztags_keyword` ( `keyword`(191) ),
   KEY `idx_eztags_keyword_id` ( `keyword`(191), `id` ),

bundle/Resources/sql/postgresql/schema.sql

@@ -10,6 +10,7 @@ CREATE TABLE eztags (
    remote_id varchar(100) NOT NULL default '',
    main_language_id integer not null default 0,
    language_mask integer not null default 0,
+   priority integer not null default 0,
    PRIMARY KEY (id),
    CONSTRAINT idx_eztags_remote_id UNIQUE  (remote_id)
 );

bundle/Resources/translations/netgen_tags_admin.en.yml

@@ -11,6 +11,7 @@ tag.remote_id: 'Remote ID'
 tag.tag_name: 'Keyword'
 tag.translations: 'Translations'
 tag.modified: 'Modified'
+tag.priority: 'Priority'
 tag.main_tag: 'Main tag'
 tag.parent_tag: 'Parent tag'
 
@@ -43,6 +44,12 @@ tag.children.no_children: 'No tags found'
 tag.subtree_limitations.title: 'Subtree limitations'
 tag.subtree_limitations.no_limitations: 'No subtree limitations'
 
+tag.subitems.title: 'Subitems'
+tag.subitems.sort_by: 'Sort by'
+tag.subitems.sort_order: 'Sort order'
+tag.subitems.sort_order.ascending: 'Ascending'
+tag.subitems.sort_order.descending: 'Descending'
+
 tag.related_content.title: 'List of content related to tag'
 tag.related_content.filter.content_type: 'Content type filter'
 tag.related_content.filter.sort: 'Sort'

bundle/Resources/translations/netgen_tags_admin.fr.yml

@@ -11,6 +11,7 @@ tag.remote_id: 'Identification à distance'
 tag.tag_name: 'Mot-clé'
 tag.translations: 'Traductions'
 tag.modified: 'Modifié'
+tag.priority: 'Priorité'
 tag.main_tag: 'Tag principale'
 tag.parent_tag: 'Tag parent'
 
@@ -43,6 +44,12 @@ tag.children.no_children: 'Pas de tags trouvés'
 tag.subtree_limitations.title: 'Limites des sous-arbres'
 tag.subtree_limitations.no_limitations: 'Aucune limite de sous-arbre'
 
+tag.subitems.title: 'Sous-éléments'
+tag.subitems.sort_by: 'Trier par'
+tag.subitems.sort_order: 'Ordre de tri'
+tag.subitems.sort_order.ascending: 'Ascendant'
+tag.subitems.sort_order.descending: 'Descendant'
+
 tag.related_content.title: 'Liste des contenus liés au tag'
 
 tag.add.title: 'Nouveau tag'

bundle/Resources/views/admin/tag/children.html.twig

@@ -26,6 +26,7 @@
                     <th>{{ 'tag.tag_name'|trans }}</th>
                     <th>{{ 'tag.translations'|trans }}</th>
                     <th>{{ 'tag.modified'|trans }}</th>
+                    <th>{{ 'tag.priority'|trans }}</th>
                 </tr>
             </thead>
             <tbody>
@@ -48,6 +49,7 @@
                             {% endfor %}
                         </td>
                         <td>{{ child.modificationDate|date }}</td>
+                        <td>{{ child.priority }}</td>
                     </tr>
                 {% endfor %}
             </tbody>
@@ -71,6 +73,10 @@
             {% endif %}
         </div>
     </form>
+
+    {% if tag is defined and not tag.isSynonym %}
+        {% include '@NetgenTags/admin/tag/tabs/subitems.html.twig' %}
+    {% endif %}
 {% else %}
     <p>{{ 'tag.children.no_children'|trans }}</p>
 {% endif %}