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 :
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 s’assure que les balises sont saisies en tant que valeurs dans la variable cq:tags
La propriété de tableau de chaînes n’est pas dupliquée. Elle supprime les ID de balise pointant vers des balises non existantes et met à jour les ID de balise 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 :
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.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);
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);
Alors qu’une balise ne peut être convertie qu’à partir d’une ressource (et non d’un noeud), une balise peut être convertie *en *un noeud et une ressource :
Node node = tag.adaptTo(Node.class);
Resource node = tag.adaptTo(Resource.class);
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)
.
// Getting the tags of a Resource:
Tag[] tags = tagManager.getTags(resource);
// Setting tags to a Resource:
tagManager.setTags(resource, 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);
RangeIterator
valide à utiliser :
com.day.cq.commons.RangeIterator
tagManager.deleteTag(tag);
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);
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 est un service d’arrière-plan qui nettoie les balises masquées et inutilisées. Les balises masquées et inutilisées sont les balises ci-dessous. /content/cq:tags
qui ont une cq:movedTo
et ne sont pas utilisées sur un noeud 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
La recherche de balises et l’obtention de la liste des balises fonctionnent comme suit :
La recherche de TagID recherche les balises qui possèdent la propriété . cq:movedTo
Défini sur TagID et suit le cq:movedTo
ID de balise.
La recherche de la balise Titre recherche uniquement les balises qui n’ont pas de cq:movedTo
.
Comme décrit dans la documentation relative à l’administration des balises, dans la section Gestion des balises dans différentes langues, une balise title
peuvent être définies 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 "_" au lieu de "-", par exemple : de_ch
.
Lorsque la variable Animals est ajoutée à la balise Produits page, valeur stockphotography:animals
est ajouté à la propriété cq:tags
du noeud /content/geometrixx/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 :
Dans AEM, la langue peut être identifiée à partir de la langue de la page ou 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.
La procédure suivante décrit comment ajouter une langue (finnois) à la boîte de dialogue Modifier la balise :
Dans CRXDE, modifiez la propriété multi-valeur languages
du nœud /content/cq:tags
.
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.
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
.