Vous consultez actuellement l'aide de la version:

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

qui interagit avec le

Pour plus d’informations sur le balisage, voir :

  • Gestion des balises pour savoir comment créer et gérer des balises et déterminer à quel contenu elles ont été appliquées.
  • Utilisation des balises pour plus d’informations sur le balisage du contenu.

Vue d’ensemble de l’API de balisage

L’implémentation du framework 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é array 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 modules 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.
  • Tage- 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 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

Une balise peut être récupérée à 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 balises à des nœuds JCR, vous pouvez directement utiliser le mécanisme adaptTo de Sling si vous disposez de la ressource (par exemple, /etc/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 en à la fois un nœud et une ressource :

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

Remarque :

L’adaptation directe de nœud à balise n’est pas possible, car la fonction Noden’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 de 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);

Balisage du côté client

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.

Le Tag Garbage Collector

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

Le 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 listing des balises

La recherche de balises et le listing des balises fonctionnent comme suit :

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

Balises dans différentes langues

Comme le décrit la documentation relative à l’ 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é se présente au format jcr:title.<paramètres régionaux>, par exemple jcr:title.fr pour la traduction en français. <paramètres régionaux> 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 a localisé des méthodes liées à title :

  • 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 la langue de l’utilisateur :

  • pour récupérer la langue de la page dans une JSP :
    • currentPage.getLanguage(false)
  • pour récupérer la langue de l’utilisateur dans une JSP :
    • slingRequest.getLocale()

currentPage et slingRequest sont disponibles dans une 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

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

  1. Dans CRXDE, modifiez la propriété multi-valeur languages du nœud /etc/tags.
  2. Ajoutez fi_fi (code langue pour le finlandais) et enregistrez les modifications.

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.

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

Ce produit est distribué sous licence Creative Commons Attribution - Pas d’utilisation commerciale - Partage à l’identique 3.0 non transposé  Les publications Twitter™ et Facebook ne sont pas couvertes par les dispositions Creative Commons.

Mentions légales   |   Politique de confidentialité en ligne