Création d’un balisage dans des applications AEM

Dans un contexte de programmation par balises ou d’extension de balises dans une application AEM personnalisée, ce document décrit l’utilisation de

qui interagit avec le

Pour plus d’informations sur le balisage :

  • Voir Utilisation des balises pour plus d’informations sur le balisage du contenu en tant qu’auteur de contenu.
  • Consultez Administration des balises pour savoir comment un administrateur peut créer et gérer des balises et déterminer à quel contenu elles ont été appliquées.

Vue d’ensemble de l’API de balisage

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 table de chaînes 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 module com.day.cq.tagging :

  • JcrTagManagerFactory – renvoie une implémentation JCR d’un TagManager. C’est l’implémentation de référence de l’API de balisage.
  • TagManager – permet de résoudre et de créer des balises par chemins et noms.
  • Tag – définit l’objet de balise.

Récupération d’un TagManager basé sur JCR

Pour récupérer une instance de TagManager, vous devez disposer d’une Session JCR 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

Un objet Tag peut être récupéré à l’aide du TagManager, en résolvant une balise existante ou en 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);

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);
REMARQUE

L’adaptation directe de Node à Tag n’est pas possible, car la fonction Node n’implémente pas la méthode Sling Adaptable.adaptTo(Class).

Récupération et définition des balises

// 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 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);
REMARQUE

RangeIterator valide à utiliser :

com.day.cq.commons.RangeIterator

Suppression des balises

tagManager.deleteTag(tag);

Réplication de balises

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

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 inutilisées sont des balises sous /content/cq:tags avec une propriété cq:movedTo qui ne sont pas utilisées sur un noeud de contenu. Elles ont un décompte de zéro. 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://<host>:<port>/system/console/configMgr/com.day.cq.tagging.impl.TagGarbageCollector

Recherche de balises et obtention de la liste des balises

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

  • La recherche de TagID recherche des balises avec la propriété cq:movedTo définie sur TagID et suit les cq:movedTo TagID.
  • La recherche de titre de balise recherche uniquement les balises qui n’ont pas de propriété cq:movedTo.

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 paramètres régionaux ISO en minuscules et utiliser un trait de soulignement (_) au lieu d’un tiret (-), par exemple : de_ch.

Par exemple, lorsque la balise Animals est ajoutée à la page Products, la valeur stockphotography:animals est ajoutée à la propriété cq:tags du nœud /content/wknd/en/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 :

  • com.day.cq.tagging.Tag
    • getLocalizedTitle(Locale locale)
    • getLocalizedTitlePaths()
    • getLocalizedTitles()
    • getTitle(Locale locale)
    • getTitlePath(Locale locale)
  • com.day.cq.tagging.TagManager
    • canCreateTagByTitle(String tagTitlePath, Locale locale)
    • createTagByTitle(String tagTitlePath, Locale locale)
    • resolveByTitle(String tagTitlePath, Locale locale)

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

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

La procédure suivante décrit comment ajouter une langue (par ex : finnois) à la boîte de dialogue Modifier la balise :

  1. Dans CRXDE, modifiez la propriété multi-valeur languages du nœud /content/cq:tags.
  2. Ajoutez fi_fi, qui représente le code de langue pour le finnois, et enregistrez les modifications.

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

REMARQUE

La nouvelle langue doit faire partie de celles reconnues par AEM, c’est-à-dire qu’elle doit être disponible sous /libs/wcm/core/resources/languages.

Sur cette page