Créer le balisage dans une application AEM building-tagging-into-an-aem-application

Dans le but d’utiliser par programmation des balises ou d’étendre des balises dans une application d’AEM personnalisée, cette page décrit l’utilisation de la fonction

qui interagit avec le

Pour plus d’informations sur le balisage, consultez :

Vue d’ensemble de l’API de balisage overview-of-the-tagging-api

L’implémentation du cadre de balisage dans AEM permet la gestion des balises et du contenu des balises à l’aide de l’API JCR. TagManager garantit que les balises saisies en tant que valeurs dans la propriété de tableau de chaîne de caractères cq:tags ne sont pas dupliquées, supprime les TagID pointant vers des balises non existantes et met à jour les TagID pour les balises déplacées ou fusionnées. TagManager utilise un écouteur d’observation JCR qui annule les modifications incorrectes. Les principales classes sont stockées dans le package com.day.cq.tagging :

Récupération d’un TagManager basé sur JCR getting-a-jcr-based-tagmanager

Pour récupérer une instance de TagManager, vous devez disposer d’une Session JRC et appeler getTagManager(Session) :

@Reference
JcrTagManagerFactory jcrTagManagerFactory;

TagManager tagManager = jcrTagManagerFactory.getTagManager(session);

Dans le contexte standard de Sling, vous pouvez également effectuer une adaptation à un TagManager à partir du ResourceResolver :

TagManager tagManager = resourceResolver.adaptTo(TagManager.class);

Récupération d’un objet Tag retrieving-a-tag-object

Un objet Tag peut être récupéré à l’aide du TagManager, en résolvant une balise existante ou en créant une autre :

Tag tag = tagManager.resolve("my/tag"); // for existing tags

Tag tag = tagManager.createTag("my/tag"); // for new tags

Pour l’implémentation basée sur JCR, qui mappe les Tags à des Nodes JCR, vous pouvez directement utiliser le mécanisme adaptTo de Sling si vous disposez de la ressource (par exemple, /content/cq:tags/default/my/tag) :

Tag tag = resource.adaptTo(Tag.class);

Même si une balise peut seulement être convertie à partir d’une ressource (et non d’un nœud), une balise peut être convertie à la fois en un nœud et une ressource :

Node node = tag.adaptTo(Node.class);
Resource node = tag.adaptTo(Resource.class);

Récupération et définition des balises getting-and-setting-tags

// Getting the tags of a Resource:
Tag[] tags = tagManager.getTags(resource);

// Setting tags to a Resource:
tagManager.setTags(resource, tags);

Recherche de balises searching-for-tags

// Searching for the Resource objects that are tagged with the tag object:
Iterator<Resource> it = tag.find();

// Retrieving the usage count of the tag object:
long count = tag.getCount();

// Searching for the Resource objects that are tagged with the tagID String:
 RangeIterator<Resource> it = tagManager.find(tagID);

Suppression des balises deleting-tags

tagManager.deleteTag(tag);

Réplication de balises replicating-tags

Il est possible d’utiliser le service de réplication (Replicator) avec des balises dans la mesure où elles sont de type nt:hierarchyNode :

replicator.replicate(session, replicationActionType, tagPath);

Balisage du côté client tagging-on-the-client-side

CQ.tagging.TagInputField est un widget de formulaire qui permet de saisir des balises. Il dispose d’un menu contextuel permettant de faire une sélection parmi les balises existantes, et inclut la saisie semi-automatique, ainsi que bien d’autres fonctions. Son xtype est tags.

Tag Garbage Collector the-tag-garbage-collector

Tag Garbage Collector est un service d’arrière-plan qui nettoie les balises masquées et inutilisées. Les balises masquées et non utilisées sont des balises /content/cq:tags qui ont une propriété cq:movedTo et ne sont pas appliquées à un nœud de contenu. Leur nombre est nul. Avec ce processus de suppression à l’arrière-plan, le nœud de contenu (c’est-à-dire la propriété cq:tags) n’a pas besoin d’être mis à jour lors du déplacement ou de la fusion. Les références de la propriété cq:tags sont automatiquement mises à jour lorsque la propriété cq:tags est mise à jour, par ex. via la boîte de dialogue des propriétés de la page.

Tag Garbage Collector s’exécute par défaut une fois par jour. Cette fréquence peut être configurée sur :

http://localhost:4502/system/console/configMgr/com.day.cq.tagging.impl.TagGarbageCollector

Recherche de balises et obtention de la liste des balises tag-search-and-tag-listing

La recherche de balises et l’obtention de la liste des balises fonctionnent comme suit :

Balises dans différentes langues tags-in-different-languages

Comme le décrit la documentation relative à la gestion des balises, dans la section Gestion des balises dans différentes langues, une balise title peut être définie dans différentes langues. Une propriété sensible à la langue est ensuite ajoutée au nœud de la balise. Cette propriété a le format jcr:title.<locale>, par ex. jcr:title.fr pour la traduction en français. <locale> doit être une chaîne de caractères ISO du code langue en minuscules et utiliser "_" au lieu de "-", par exemple : de_ch.

Lorsque la balise Animals est ajoutée à la page Produits, la valeur stockphotography:animals est ajoutée à la propriété cq:tags du nœud /content/geometrixx/fr/products/jcr:content. La traduction est référencée à partir du nœud de balise.

L’API côté serveur dispose de méthodes liées à title localisées :

Dans AEM, la langue peut être identifiée à partir de la langue de la page ou de l’utilisateur :

currentPage et slingRequest sont disponibles dans un JSP via la balise <cq:definedObjects>.

Pour le balisage, la localisation dépend du contexte, car la balise titles peut être affichée dans la langue de la page, dans la langue de l’utilisateur ou dans toute autre langue.

Ajout d’une langue à la boîte de dialogue Modifier la balise adding-a-new-language-to-the-edit-tag-dialog

La procédure suivante décrit l’ajout d’une nouvelle langue (finnois) au Modification de balise dialog :

La nouvelle langue (finnois) est désormais disponible dans la boîte de dialogue des propriétés de la page et dans la boîte de dialogue Modifier la balise lors de la modification d’une balise dans la console Balisage.