Le CMS Ametys met à disposition des intégrateurs de nombreuses méthodes accessibles à partir des fichiers XSLT, facilitant l'intégration des chartes graphique.
Pour plus d'informations, cliquez ici.
- Comment utiliser ces méthodes ?
- Référence
- Préfixes URL / Contexte de l'application
- Skin
- Page
- Contenu
- Explorateur de ressources
- Etiquettes
- Divers
- Paramètres
- Paramètres de vue
- templateParameters
- templateParameter (avec l'argument parameterPath)
- templateParameter (avec les arguments pageId et parameterPath)
- zoneParameters (sans argument)
- zoneParameters (avec l'argument zoneName)
- zoneParameter (avec l'argument parameterPath)
- zoneParameter (avec les arguments zoneName et parameterPath)
- zoneParameter (avec les arguments pageId, zoneName et parameterPath)
- zoneItemParameters (sans argument)
- zoneItemParameters (avec l'argument zoneItemId)
- zoneItemParameter (avec l'argument parameterPath)
- zoneItemParameter (avec les arguments zoneItemId et parameterPath)
- serviceViewParameters
- serviceViewParameter
- contentViewParameters
- contentViewParameter
Comment utiliser ces méthodes ?
Ajouter ce code dans l'entête des fichiers XSL:
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" ... xmlns:ametys="org.ametys.web.transformation.xslt.AmetysXSLTHelper" ... extension-element-prefixes="... ametys ...">
De sorte à pouvoir appeler n'importe quelle fonction définie ci-dessous, en utilisant "ametys:functionName(argument1, argument2)"
Par exemple :
<xsl:if test="ametys:zone() = 'default'"> <!-- We are in the default zone --> ... </xsl:if>
Référence
Préfixes URL / Contexte de l'application
uriPrefix
Description :
Retourne le contexte de l'application en fonction du contexte de rendu, par exemple '/cms', '/cms/preview'.
Cette fonction peut être utilisée pour accéder au serveur via des requêtes AJAX.
Le résultat peut être vide si le contexte de l'application correspond à la racine du domaine.
Signature :
String uriPrefix()
Exemple :
$j.post("<xsl:value-of select="ametys:uriPrefix()"/>/plugins/cms/comments/add-comment", data, result); absoluteUriPrefix
Description :
Identique à uriPrefix mais en ajoutant le protocole et le nom du serveur pour obtenir une adresse aboslue, par exemple 'http://www.ametys.org' or 'http://www.ametys.org/cms' or 'http://www.ametys.org/cms/preview'.
Signature :
String absoluteUriPrefix()
siteUriPrefix
Description :
Retourne le contexte du site indiqué en paramètre (site courant si pas de paramètre) en fonction du contexte de rendu, par exemple '/cms/www', '/cms/preview/www'.
Cette fonction peut être utilisée pour construire un chemin vers une page.
Le résultat peut être vide si le contexte du site correspond à la racine du domaine.
Signature :
String siteUriPrefix()
Exemple :
<a href="{ametys:siteUriPrefix()}/{ametys:lang()}/index.html">Accueil</a> absoluteSiteUriPrefix
Description :
Identique à siteUriPrefix mais renvoie une valeur absolue, par exemple 'http://www.ametys.org' or 'http://www.ametys.org/cms/www' or 'http://www.ametys.org/cms/preview/www'.
Utile pour obtenir l'URL du site (pour créer le bouton "I like facebook" par exemple).
Signature :
String absoluteUriPrefix()
String absoluteUriPrefix(String siteName)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
siteName |
String |
Nom du site |
Skin
skin
Description :
Retourne le nom de la charte graphique utilisée par le site courant.
Comme il n'est pas possible de charger une XSL avec une variable, utiliser le protocole skin : <xsl:import href="skin://stylesheets/common.xsl"/>
Signature :
String skin()
skinURL
Description :
Retourne le chemin vers le fichier ressource de la charte graphique.
Signature :
String skinURL(String path)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
path |
String |
Chemin vers une ressource de la charte graphique |
Exemple :
Insérer une image placée dans le répertoire cms/skins/[skinName]/resources/img/[imageName].png.
<img src="{ametys:skinURL('img/[imageName].png')}"/> skinResources
Description :
Retourne un nœud DOM représentant le sous-répertoire du répertoire resources de la charte graphique en cours d'utilisation.
Cela permet notamment de faire un diaporama de l'ensemble des images d'un répertoire sans connaître les noms de tous les fichiers.
Voir resourcesById pour voir la description du DOM.
Signature :
Node skinResources(String path)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
path |
String |
Chemin dans le répertoire resources de la charte graphique |
Exemple :
<ul>
<xsl:for-each select="ametys:skinResources('img/slideshow')/resource">
<img src="{ametys:skinURL(concat('img/slideshow/', @name))}"/>
</xsl:for-each>
</ul> skinImageBase64
Description :
Retourne une image de la charte graphique encodée en base 64. L'image est alors intégrée directement dans le corps HTML de la page.
Signature :
String skinImageBase64(String path)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
path |
String |
Chemin de l'image dans le répertoire resources de la charte graphique |
Exemple :
<img src="{ametys:skinImageBase64('img/header.jpg')}" /> template
Description :
Retourne le nom du gabarit en cours d'utilisation.
Signature :
String template()
templateURL
Description :
Retourne le chemin vers la ressource mise en argument contenue dans le gabarit courant de la charte graphique.
Signature :
String templateURL(String path)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
path |
String |
Chemin vers une ressource du gabarit de la charte graphique |
Exemple :
Insérer une image placée dans le répertoire cms/skins/[skinName]/templates/[currentTemplateName]/resources/img/[imageName].png".
<img src="ametys:templateURL('img/[imageName].png')"/> zone
Description :
Retourne le nom de la zone en cours d'utilisation. Utile pour le rendu d'un contenu ou d'un service.
Attention, le rendu d'un contenu peut aussi être visualisé en dehors d'une page avec aucune zone associée, il faut donc passer en paramètre une valeur par défaut.
Signature :
String zone (String defaultValue)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
defaultValue |
String |
Valeur par défaut si aucune zone n'est en cours d'utilisation |
Exemple :
<xsl:variable name="zone" select="ametys:zone('default')"/>
<xsl:choose>
<xsl:if test="$zone = 'default'">
<!-- Nous sommes dans la zone 'default' -->
...
</xsl:when>
<xsl:when test="$zone = 'right'">
<!-- Nous sommes dans la zone 'right' -->
...
</xsl:when>
<xsl:otherwise>
<!-- Nous sommes dans la zone 'left' -->
...
</xsl:otherwise>
</xsl:choose> zoneItemId
Description :
Retourne l'identifiant du zoneitem en cours d'utilisation. Utile pour le rendu d'un contenu ou d'un service.
Attention, le rendu d'un contenu peut aussi être visualisé en dehors d'une page avec aucun zoneitem associé.
Signature :
String zoneItemId ()
Page
site
Description :
Retourne l'identifiant du site contenant la page courante.
Signature :
String site()
String site(String pageId)
Arguments :
Aucun
|
Nom |
Type |
Description |
|---|---|---|
|
pageId |
String |
Identifiant unique de page |
lang
Description :
Retourne le code de la langue de la page en cours d'utilisation.
Signature :
String lang()
String lang(String pageId)
Arguments :
Aucun
|
Nom |
Type |
Description |
|---|---|---|
|
pageId |
String |
Identifiant unique de page |
Exemple :
<a href="{ametys:siteUriPrefix()}/{ametys:lang()}/index.html">Accueil</a> pagePath
Description :
Retourne le chemin de la page courante. Ce chemin est relatif au plan du site.
Signature :
String pagePath()
pageId
Description :
Retourne l'identifiant unique de la page courante (sous la forme page://...).
Signature :
String pageId()
pageTitle
Description :
Retourne le titre de la page.
Signature :
String pageTitle(String sitename, String lang, String path)
String pageTitle(String pageId)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
sitename |
String |
Identifiant du site |
|
lang |
String |
Code de la langue du site |
|
path |
String |
Chemin de la page dans le plan du site |
|
Nom |
Type |
Description |
|---|---|---|
|
pageId |
String |
Identifiant unique de page |
Exemple :
Ceci retournera le titre de la page d'accueil : "Home" ou "Accueil".
<xsl:value-of select="ametys:pageTitle(ametys:site(), ametys:lang(), 'index')"/>
pageLongTitle
Description :
Identique à pageTitle excepté qu'il retourne le titre long.
Noter que s'il n'y a pas de titre long, c'est le titre qui est retourné.
Signature :
String longPageTitle(String sitename, String lang, String path)
String longPageTitle(String pageId)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
sitename |
String |
Identifiant du site |
|
lang |
String |
Code de la langue du site |
|
path |
String |
Chemin de la page dans le plan du site |
|
Nom |
Type |
Description |
|---|---|---|
|
pageId |
String |
Identifiant unique de page |
pageType
A partir de Ametys 4.4
Description :
Retourne le type de la page : CONTAINER, NODE ou LINK
Signature :
String pageType(String pageId)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
pageId |
String |
Identifiant de la page |
pageUrlType
A partir de Ametys 4.4
Description :
Retourne le type d'url d'une page de type "LINK" : WEB ou PAGE ou vide si la page n'est pas de type LINK.
Voir #pageType.
Signature :
String pageUrlType(String pageId)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
pageId |
String |
Identifiant de la page |
pageUrl
A partir de Ametys 4.4
Description :
Retourne l'url d'une page de type "LINK" (lien). Voir #pageType.
L'url peut être une url externe (WEB) ou l'identifiant d'une page Ametys (PAGE). Voir #pageUrlType
Signature :
String pageUrl(String pageId)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
pageId |
String |
Identifiant de la page |
Description :
Retourne le type de la page : CONTAINER, NODE ou LINK
Signature :
String pageType(String pageId)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
pageId |
String |
Identifiant de la page |
pageMetadata
Description :
Retourne la valeur d'une métadonnée de page sous forme de chaîne de caractères.
Signature :
String pageMetadata (String sitename, String lang, String path, String metadataName)
String pageMetadata (String pageId, String metadataName)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
sitename |
String |
Identifiant du site |
|
lang |
String |
Code de la langue du site |
|
path |
String |
Chemin de la page dans le plan du site |
|
metadateName |
String |
Nom de la metadonnée. Utiliser le caractère '/' pour accéder à une métadonnée composite. |
|
Nom |
Type |
Description |
|---|---|---|
|
pageId |
String |
Identifiant unique de page |
|
metadataName |
String |
Nom de la metadonnée. Utiliser le caractère '/' pour accéder à une métadonnée composite. |
pageExists
A partir de Ametys 4.2
Description :
Retourne true si la page demandée existe.
Signature :
boolean pageExists(String sitename, String lang, String path)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
sitename |
String |
Identifiant du site |
|
lang |
String |
Code de la langue du site |
|
path |
String |
Chemin de la page dans le plan du site |
pageHasRestrictedAccess
Description :
Retourne le statut de la page selon si elle est restreinte ou non : false si la page est public, sinon true.
Signature :
boolean pageHasRestrictedAccess(String sitename, String lang, String path) // A partir de 3.8.2 seulement
boolean pageHasRestrictedAccess(String pageId)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
sitename |
String |
Identifiant du site |
|
lang |
String |
Code de la langue du site |
|
path |
String |
Chemin de la page dans le plan du site |
|
Nom |
Type |
Description |
|---|---|---|
|
pageId |
String |
Identifiant unique de page |
pageIsVisible
A partir de Ametys 3.8.1
Description :
Détermine si une page est visible. Si false, elle ne doit pas apparaitre des élements de navigation.
Signature :
boolean pageIsVisible (String sitename, String lang, String path) // A partir de 3.8.2 seulement
boolean pageIsVisible (String pageId)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
sitename |
String |
Identifiant du site |
|
lang |
String |
Code de la langue du site |
|
path |
String |
Chemin de la page dans le plan du site |
|
Nom |
Type |
Description |
|---|---|---|
|
pageId |
String |
Identifiant unique de page |
findPagesIdsByTag
Description :
Retour une liste d'identifiant de pages correspondant à une recherche par tag, sous la forme :
<page id="page://xxxx-xxxx-xxxxxxxxx"/> ...
Signature :
Node findPagesIdsByTag(String tag)
Node findPagesIdsByTag(String sitename, String lang, String tag)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
tag |
String |
Identifiant de l'étiquette de page dans le site et la langue courrants |
|
Nom |
Type |
Description |
|---|---|---|
|
sitename |
String |
Nom du site. Par exemple 'www'. |
|
lang |
String |
Code de la langue. Par exemple 'fr'. |
|
tag |
String |
Identifiant de l'étiquette de page. |
Exemple :
Pour créer une liste de lien vers les pages portant l'étiquette TEST.
<xsl:variable name="testPages" select="ametys:findPagesIdsByTag('TEST')"/>
<xsl:if test="$testPages">
<ul>
<xsl:for-each select="$testPages">
<li>
<a href="{resolver:resolve('page', @id)}"><xsl:value-of select="ametys:pageLongTitle(@id)"/></a>
</li>
</xsl:for-each>
</ul>
</xsl:if> isCaptchaRequired
A partir de Ametys 4.6
Description:
Détermine si la protection d'un formulaire par un captha est nécessaire sur la page courante.
La protection par captcha dépend de la configuration du site (politique de protection des formulaires) et si l'accès à la page nécessite d'être authentifié ou non.
Signature:
public static boolean isCaptchaRequired()
isCacheable
Description :
Détermine si le service, le contenu ou la page sur lequel on se trouve est cacheable, c'est à dire peut être mis dans le cache.
Si isCacheable est appelée depuis le rendu d'un service, la méthode retourne le statut du service vis à vis du cache.
Si isCacheable est appelée depuis le rendu d'un contenu, la méthode retourne le statut du contenu vis à vis du cache.
Si isCacheable est appelée dans la skin, la méthode retourne le statut de la page vis à vis du cache.
Signature :
boolean isCacheable()
referencedPages
Description :
Retourne la liste des pages référencés par un contenu, c'est à dire les pages sur lesquelles est affiché le contenu, avec la vue utilisée pour le rendu du contenu
<page id="page://xxxx-xxxx-xxxx" metadataSetName="main"/> <page id="page://yyyy-yyyy-yyyy" metadataSetName="main"/> <page id="page://zzzz-zzzz-zzzz" metadataSetName="abstract"/>
Signature:
NodeList referencedPages (String contentId)
Arguments:
|
Nom |
Type |
Description |
|---|---|---|
|
contentId |
String |
Identifiant unique du contenu |
accessibleReferencedPages
Description :
Retourne la liste des pages référencés par un contenu, c'est à dire les pages sur lesquelles est affiché le contenu, avec la vue utilisée pour le rendu du contenu et pour lesquelles l'utilisateur front-office a les droits d'accès.
<page id="page://xxxx-xxxx-xxxx" metadataSetName="main"/> <page id="page://yyyy-yyyy-yyyy" metadataSetName="main"/> <page id="page://zzzz-zzzz-zzzz" metadataSetName="abstract"/>
Attention
Cette méthode n'est à utiliser que sur des pages ne pouvant être mises en cache
Signature:
NodeList accessibleReferencedPages (String contentId)
Arguments:
|
Nom |
Type |
Description |
|---|---|---|
|
contentId |
String |
Identifiant unique du contenu |
breadcrumb
Description :
Retourne la liste des pages composant le fil d'ariane à l'exclusion de la page courante.
<page>page://xxxx-xxxx-xxxx</page> <page>page://yyyy-yyyy-yyyy</page> <page>page://zzzz-zzzz-zzzz</page>
Signature:
NodeList breadcrumb()
Exemple :
Pour créer un fil d'ariane
<xsl:if test="ametys:pageId() != ''"><!-- No breadcrumb when there is no current page (content view) -->
<ul>
<xsl:if test="ametys:pagePath() != 'index' and ametys:pageExists($site, $lang, 'index')">
<!-- Ajoute la page d'accueil au fil d'ariane, si ce n'est pas la page actuelle)
<li>
<a href="{$site-uri-prefix}/{$lang}/index.html">
<xsl:value-of select="ametys:pageTitle($site, $lang, 'index')"/>
</a>
</li>
</xsl:if>
<xsl:for-each select="ametys:breadcrumb()">
<li>
<a href="{resolver:resolve('page', .)}"><xsl:value-of select="ametys:pageTitle(.)"/></a>
</li>
</xsl:for-each>
</ul>
</xsl:if> Contenu
contentAttachments
Description :
Retourne un nœud DOM correspondant aux fichiers joints du contenu courant ou du contenu spécifié.
Voir resourcesById pour voir la description du DOM.
Signature :
Node contentAttachments()
Node contentAttachments(String contentId)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
contentId |
String |
Identifiant unique du contenu |
contentTags
Description :
Retourne un nœud DOM contenant les étiquettes appliquées au contenu courant ou à un contenu donné
Le nœud renvoyé a la forme suivante :
<tag name="TAGNAME"/> ...
Signature :
NodeList contentTags()
NodeList contentTags(String contentId) (à partir de Ametys 4.2)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
contentId |
String |
Identifiant unique du contenu |
findContentsIdsByTag
A partir de Ametys 4.2
Description :
Retour une liste d'identifiant de contenus correspondant à une recherche par tag, sous la forme :
<content id="defaultWebContent://xxxx-xxxx-xxxxxxxxx"/> ...
Signature :
Node findContentsIdsByTag(String tag)
Node findContentsIdsByTag(String sitename, String lang, String tag)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
tag |
String |
Identifiant de l'étiquette de contenu dans le site et la langue courrante |
|
Nom |
Type |
Description |
|---|---|---|
|
sitename |
String |
Nom du site. Par exemple 'www'. La valeur '+' permet de chercher les contenus de n'importe quel site. La valeur '^' permet de chercher les contenus sans site. |
|
lang |
String |
Code de la langue. Par exemple 'fr'. |
|
tag |
String |
Identifiant de l'étiquette de contenu. |
Exemple :
Pour créer une liste de lien vers les contenus portant l'étiquette TEST.
<xsl:variable name="testContents" select="ametys:findContentsIdsByTag('TEST')"/>
<xsl:if test="$testContents">
<ul>
<xsl:for-each select="$testContents">
<li>
<a href="{resolver:resolve('content', @id)}"><xsl:value-of select="ametys:contentMetadata(@id, 'title', $lang)"/></a>
</li>
</xsl:for-each>
</ul>
</xsl:if> contentMetadata
Préférez l'utilisation de contentAttribute à partir de Ametys 4.3
Description :
Retourne la valeur "string" d'une métadonnée.
2 signatures possibles:
- Pour une métadonnée de type simple (string, date, long, double)
String contentMetadata(String contentId, String metadataPath)
- Pour une métadonnée multlingue (multilingual_string)
String contentMetadata(String contentId, String metadataPath, String lang)
Arguments:
|
Nom |
Type |
Description |
|---|---|---|
|
contentId |
String |
Identifiant du contenu |
|
metadataPath |
String |
Chemin de la métadonnée |
|
lang (optionel) |
String |
Langue à utiliser si la métadonnée est une métadonnée de type multilingue |
hasValue
A partir de Ametys 4.3
Description
Détermine si un attribut existe sur un contenu donné
Signature:
boolean hasValue(String contentId, String dataPath)
Arguments:
|
Nom |
Type |
Description |
|---|---|---|
|
contentId |
String |
Identifiant du contenu |
|
dataPath |
String |
Chemin de l'attribut |
contentAttribute
A partir de Ametys 4.3
Description
Retourne la ou les valeurs d'un attribut, quelque soit son type.
Exemple de valeur retournée pour un attribut de type "string", multiple :
<keyword>Lorem</keyword> <keyword>ipsum</keyword>
Exemple de valeur retournée pour un attribut de type "content":
<orgunit createdat="2014-07-23T10:29:51.120+02:00" creator="Anonymous" id="orgunitContent://7d3d2d45-1c26-4fa6-bfa8-deeac4881950" language="fr" lastmodifiedat="2019-04-01T14:18:16.206+02:00" name="orgunit-0340838b" title="UFR Sciences Economiques, Sociales et de Gestion"></orgunit>
Exemple de valeur retournée pour un attribut de type "content":
<illustration> <image filename="23b.jpg" lastmodified="2019-10-30T14:22:51.00000093Z" mime-type="image/jpeg" path="illustration/image" size="162213" type="metadata"/> </illustration>
2 signatures possibles:
- Pour tout type de métadonnée:
NodeList contentAttribute(String contentId, String dataPath)
- Pour une métadonnée multlingue (multilingual_string), utilisez la signature suivante pour récupérer la valeur pour une langue en particulier
NodeList contentAttribute(String contentId, String dataPath, String lang)
Arguments:
|
Nom |
Type |
Description |
|---|---|---|
|
contentId |
String |
Identifiant du contenu |
|
dataPath |
String |
Chemin de l'attribut |
|
lang (optionel) |
String |
Langue à utiliser si la métadonnée est une métadonnée de type multilingue |
contentExcerpt
A partir de Ametys 4.6
Description:
Permet de récupérer un extrait d'un contenu
Signature:
String contentExcerpt(String contentId, String attributePath, int limit)
Arguments:
|
Nom |
Type |
Description |
|---|---|---|
|
contentId |
string |
Identifiant du contenu |
|
attributePath |
string |
Chemin de l'attribut de type "richtext" à partir duquel sera calculé l'extrait |
|
limit |
number |
Nombre maximun de caractère de l'extrait |
Exemple d'utilisation:
<p class="abstract"><xsl:value-of select="ametys:contentExcerpt(@id,'content', 200)"/></p>
getContentView
A partir de Ametys 4.3
Description:
Permet de récupérer la vue HTML d'un contenu
Exemple :
<content id="defaultWebContent://9936aca4-4933-4daf-a340-8bf3b796aed7" lang="fr" title="Titre du contenu" name="mon_contenu"> <html> <head>...</head> <body>...</body> </html> </content>
Signature:
Tous les paramètres n'étant pas obligatoires, plusieurs signatures existent :
Node getContentView(String contentId)
Node getContentView(String contentId, String viewName)
Node getContentView(String contentId, String viewName, int startHeadingsLevel)
Node getContentView(String contentId, String viewName, int startHeadingsLevel, String lang, boolean checkReadAccess)
|
Nom |
Type |
Description |
|---|---|---|
|
contentId |
String |
Identifiant du contenu à afficher |
|
viewName |
String |
Nom de la vue à utiliser. Par défaut, c'est la vue complète (main) |
|
startHeadingsLevel |
String |
Décalage à appliquer sur les titres (h1, h2, h3, ....). Par exemples: 3 pour que les titres de plus au niveau soit des <h3> (ie. les <h1> seront transformés en <h3>) |
|
lang |
String |
Langue de traduction. N'est utile que si le contenu à afficher est un contenu multilingue. |
|
checkReadAccess |
boolean |
Positionner à true() pour vérifier les droits de lecture sur le contenu. |
Exemple d'utilisation:
<xsl:copy-of select="ametys:getContentView(id)/content/html/body/node()"/>
Attention
Lorsque cette méthode est utilisée avec l'une des 3 premières signatures ou avec la 4e avec checkReadAccess=false, les droits de lecture ne sont pas vérifiés. Assurez-vous d'utiliser cette méthode pour des contenus publics uniquement.
Si vous utilisez la 4e méthode avec checkReadAccess=true, les droits de l'utilisateur courant sont vérifiés mais assurez-vous alors de ne pas utiliser cette méthode dans une page pouvant être mise en cache !
Explorateur de ressources
resourcesById
Description :
Retourne un nœud DOM correspondant à un répertoire de l'explorateur de ressources et son contenu. Le répertoire est récupéré par son identifiant unique.
Le nœud renvoyé a la forme suivante :
<collection name="DIRECTORYNAME" id="DIRECTORYID"> <collection name="SUBDIRECTORY" id="SUBDIRECTORYID"> ... </collection> ... <resource name="FILENAME" id="FILEID" length="LENGTHINBYTES"/> ... </collection>
Optionnellement, une ressource peut avoir la donnée suivante :
last-modified="YYYY-MM-DD'T'hh:mm:ss'Z'"
Signature :
Node resourcesById(String collectionId)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
collectionId |
String |
Identifiant unique d'un répertoire de l'explorateur de ressources |
Exemple :
<xsl:for-each select="ametys:resourcesById($resourcesId)/resource"> ... </xsl:for-each>
resourcesByPath
Description :
Identique à resourcesById mais en utilisant le chemin local (arborescence des répertoires) dans l'explorateur de ressources du site courant.
Voir resourcesById pour voir la description du DOM.
Signature :
Node resourcesByPath(String path)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
path |
String |
Chemin du répertoire de l'explorateur de ressources |
Exemple :
<xsl:if test="ametys:resourcesByPath('Fonds')/resource[@name = 'default.jpg']">
<img src="{resolver:resolve('explorer', ametys:resourcesByPath('Fonds')/resource[@name = 'default.jpg']/@id)}"/>
</xsl:if> Etiquettes
tagLabel
Description :
Retourne le libellé traduit d'une étiquette donnée.
Signature :
String tagLabel(String siteName, String tagName, String lang)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
siteName |
String |
Identifiant du site |
|
tagName |
String |
Nom de l'étiquette |
|
lang |
String |
Code de la langue utilisée pour traduire le libellé si c'est possible. Les étiquettes de contributeur (personnalisées) ne sont disponibles que dans une seule langue, mais les étiquettes apportées par les plugins ou la charte sont en principe internationalisées. |
Exemple :
Ce code renvoi le libellé traduit de l'étiquette SECTION ('Section', 'Rubrique'...)
<xsl:value-of select="ametys:tagLabel(ametys:site(), 'SECTION', ametys:lang())"/>
tagDescription
Description :
Retourne la description traduite d'une étiquette donnée.
Signature :
String tagDescription(String siteName, String tagName, String lang)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
siteName |
String |
Identifiant du site |
|
tagName |
String |
Nom de l'étiquette |
|
lang |
String |
Code de la langue utilisée pour traduire la description si c'est possible. Les étiquettes de contributeur (personnalisées) ne sont disponibles que dans une seule langue, mais les étiquettes apportées par les plugins ou la charte sont en principe internationalisées. |
tagVisibility
Description :
Retourne la visibilité ('private' ou 'public') d'une étiquette donnée.
Signature :
String tagVisibility(String siteName, String tagName)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
siteName |
String |
Identifiant du site |
|
tagName |
String |
Nom de l'étiquette |
tagParent
Description :
Retourne l'identifiant de l'étiquette parente.
Si l'étiquette n'a pas de d'étiquette parente, la chaine vide est retournée.
Signature :
String tagParent(String siteName, String tagName)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
siteName |
String |
Identifiant du site |
|
tagName |
String |
Nom de l'étiquette |
tagPath
Description :
Retourne le chemin de l'étiquette, jusqu'au parent de plus haut niveau.
Le chemin est composé du nom des étiquettes parentes, séparé par '/'
Si l'étiquette n'existe pas, la chaine vide est retournée.
Signature :
String tagPath(String siteName, String tagName)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
siteName |
String |
Identifiant du site |
|
tagName |
String |
Nom de l'étiquette |
tagColor
Description :
Retourne les couleurs associées à l'étiquette.
Le résultat XML sera sous la forme:
<color> <main>#FF66FF</main> <text>#FFFFFF</text> </color>
Si l'étiquette n'existe pas ou qu'il n'est pas possible d'ajouter une couleur à l'étiquette, la chaine vide est retournée.
Signature :
String tagColor(String siteName, String tagName)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
siteName |
String |
Identifiant du site |
|
tagName |
String |
Nom de l'étiquette |
Divers
renderingContext
Description :
Retourne le contexte du rendu courant :
- "back" - si le rendu est fait dans le backoffice
- "preview" - si le rendu est fait en mode preview ou live
- "front" - si le rendu est fait à partir du site
Cela peut permettre d'afficher des messages d'alerte lors de la prévisualisation sans qu'ils soient affichés au visiteur final.
Signature :
String renderingContext()
Exemple :
<xsl:variable name="dest">
<xsl:choose>
<xsl:when test="ametys:renderingContext() = 'back'">
<xsl:text>javascript:alert("Cette fonctionnalité ne peut pas être utilisée dans le back-office. Ouvrez la prévisualisation pour l'utiliser.");</xsl:text>
</xsl:when test>
<xsl:otherwise>
<xsl:value-of select="@href"/>
</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<a href="{$dest}>Ouvrir</a> escapeJS
Description :
Échappe les caractères spéciaux d'une chaîne pour être compatible en JavaScript.
Par exemple, le saut de ligne devient \n, la " devient \", etc.
Signature :
String escapeJS(String value)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
value |
String |
Valeur à échapper |
Exemple :
Pour initialiser une variable JavaScript avec une valeur provenant du XML, ne pas l'affecter directement car certains caractères (comme le guillemet ou le retour à la ligne) ne seront pas valides en JavaScript.
<script type="text/javascript"> var name = "<xsl:value-of select="ametys:escapeJS(@name)"/>"; </script>
splitText
Description:
Scinde le texte à la prochaine occurrence d'un caractère parmi le jeu de caractères donné, en tenant compte d'un taille minimum du texte retourné.
Signature:
String splitText (String textToSplit, String tokenizers, int startIndex)
Arguments:
|
Nom |
Type |
Description |
|---|---|---|
|
textToSplit |
String |
Texte à scinder |
|
tokenizers |
String |
Caractères délimiteurs |
|
startIndex |
int |
Indice dans la chaine de caractères à partir de laquelle commencer la recherche d'un caractère délimiteur. |
Exemple:
<xsl:value-of select="ametys:splitText ('Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quoniam, si dis placet, ab Epicuro loqui discimus.', ',.;', 70)"/> La chaîne retournée est "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quoniam, si dis placet"
getValueFromJsonObject
A partir de Ametys 4.1
Description:
Permet d'extraire la valeur associée à une clé depuis un object Map au format JSON
La valeur attendue doit être une chaine de caractère, un entier, un décimal ou une date.
Signature :
String getValueFromJsonObject(String jsonString, String key)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
jsonString |
String |
représentation JSON de l'objet Map |
|
key |
String |
clé de la valeur à récupérer |
Exemple:
Dans l'exemple ci-dessous, la variable JS 'groupId' vaut 'a27f45sd'
<script type="text/javascript">
<xsl:variable name="group">{"groupId": "a27f45sd", "groupDirectory": "group-sql"}</xsl:variable>
<xsl:variable name="groupId" select="ametys:getValueFromJsonObject($group, 'groupId')"/>
var groupId = "<xsl:value-of select="$groupId"/>"
</script> pluginResourceURL
Description :
Retourne le chemin vers un fichier de ressource stocké dans un plugin.
Signature :
String pluginResourceURL(String plugin, String path)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
plugin |
String |
Nom du plugin |
|
path |
String |
Chemin dans le répertoire de ressources du plugin |
Exemple :
<script type="text/javascript" src="{ametys:pluginResourceURL('web', 'js/jquery.treeview.min.js')}"/> pluginImageBase64
Description :
Retourne une image encodée en base 64 stocké dans un plugin.
Signature :
String pluginImageBase64(String plugin, String path)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
plugin |
String |
Nom du plugin |
|
path |
String |
Chemin de l'image dans le répertoire de ressources du plugin |
Exemple :
<img src="{ametys:pluginResourceURL('myplugin', 'img/image.png')}"/> sitemap
Description :
Retourne le plan du site courant ou le partie de plan du site sous la page indiquée en paramètre. Les pages visibles sont celles que l'utilisateur peut voir s'il y a une limitation d'accès. Les sous-pages invisibles ne sont pas renvoyées (sauf si explicitement demandé à partir de Ametys 4.1.1)
L'arbre DOM retourné a la forme suivante :
<sitemap sitemap:site="www" sitemap:lang="fr" xmlns:sitemap="http://www.ametys.org/inputdata/sitemap/3.0"> <page sitemap:id="page://uniqueid" sitemap:name="index" sitemap:title="Accueil" sitemap:long-title="Accueil" sitemap:path="index"> <page .../> ... </page> ... </sitemap>
Sur la balise page, se trouvent les attributs suivants selon le type de la page :
sitemap:type="CONTAINER" sitemap:container="true" OR sitemap:type="NODE" OR sitemap:type="LINK" sitemap:link="http://www.ametys.org" sitemap:link-type="WEB" OR sitemap:type="LINK" sitemap:link="page://uniqueid" sitemap:link-type="PAGE"
Sur la balise page, se trouvent les attributs suivants qui dépendent de la page en cours de visualisation :
sitemap:in-path="true" // si la page est dans le fil d'ariane (peut être la page courant) sitemap:current="true" // si la page est la page courante
Sur la balise page, se trouvent les étiquettes appliquées à celle-ci préfixées de PLUGIN_TAGS_ :
PLUGIN_TAGS_SECTION="empty" // if the page has the "SECTION" tag
Sur la balise page, si la page est en accès limité, se trouve l'attribut sitemap:restricted
sitemap:restricted="true" // if the page has a restricted access
A partir de v4.1.1, sur la balise page, si la page est invisible (cachée des éléments de navigation), se trouve l'attribut sitemap:invisible
sitemap:invisible="true" // if the page should be hidden from menus
Sur la balise page, se trouvent toutes les méta-données de la page (sauf celles de type composite, binary ou richtext et celles à valeurs multiples)
metadataName="value"
Pour accéder aux attributs, pensez à déclarer le namespace suivant sur votre xsl : xmlns:sitemap="http://www.ametys.org/inputdata/sitemap/3.0"
Signature :
Node sitemap(long depth) - A partir de Ametys 4.3.12
Node sitemap(long depth, boolean includeInvisiblePages)- A partir de Ametys 4.3.12
Node sitemap (String pageId, long depth)- A partir de Ametys 4.3.12
Node sitemap (String pageId, long depth, boolean includeInvisiblePages) - A partir de Ametys 4.3.12
Node sitemap() - Ne plus utiliser à partir de Ametys 4.3.12 pour des raisons de performances ; n'existe plus à partir d'Ametys 4.4.0
Node sitemap(boolean includeInvisiblePages) - Ne plus utiliser à partir de Ametys 4.3.12 pour des raisons de performances ; n'existe plus à partir d'Ametys 4.4.0
Node sitemap (String pageId) - Ne plus utiliser à partir de Ametys 4.3.12 pour des raisons de performances ; n'existe plus à partir d'Ametys 4.4.0
Node sitemap (String pageId, boolean includeInvisiblePages) - Ne plus utiliser à partir de Ametys 4.3.12 pour des raisons de performances ; n'existe plus à partir d'Ametys 4.4.0
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
pageId |
String |
Identifiant de la page |
|
depth |
long |
Profondeur à afficher |
|
includeInvisiblePages |
boolean |
Affiche les sous-pages invisibles |
Exemple :
<ul> <xsl:for-each select="ametys:sitemap(1)/page"> <li><xsl:value-of select="@sitemap:title"/></li> </xsl:for-each> </ul>
Performances
Attention ! L'emploi de ametys:sitemap(-1) est très couteux. Si vous n'avez pas le choix, il est fortement conseillé de ne la déclarer qu'une seule fois en haut d'une XSL qui l'utilise.
Dans la mesure du possible utiliser la version avec pageId ou de faire des recherches par étiquette par exemple.
translate
Description :
Traduction d'une clé i18n
Signature :
String translate(String i18nkey)
String translate(String i18nkey, String lang, NodeList i18nparams)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
i18nkey |
String |
clé i18n avec le nom du catalogue |
|
lang |
String |
langue de traduction. Si null, la langue courante sera utilisée |
|
i18nparams |
NodeList |
Liste des paramètres i18n. Peut être vide ou null |
Exemple d'utilisation :
<xsl:variable name="i18nparams"><count><xsl:value-of select="$count"/></count></xsl:variable>
<xsl:value-of select="ametys:translate(concat('skin.', $skin, ':SKIN_CONTENT_NB_LIKES_TOOLTIP'), $lang, $i18nparams)"/>
user
Description :
Retourne un noeud DOM correspondant à l'utilisateur connecté.
Cette méthode permet de savoir si un utilisateur est connecté.
Cette méthode ne doit pas être appelée dans un environnement cachable (service cachable, contenu, ...).
Le DOM retourné dépend du UsersManager utilisé (LDAP, SQL, autre...).
Voici une description de ce que peut renvoyer le StaticUsersManager (celui utilisé par la demo avec des utilisateurs codés en dur) ou le JDBCUsersManager (celui dont les utilisateurs sont stockés dans une base de données SQL) :
<user login="USERLOGIN" population="USERPOPULATION"> <firstname>FIRSTNAME</firstname> <lastname>LASTNAME</lastname> <email>EMAIL</email> <fullname>FULLNAME</fullname> <sortablename>SORTABLENAME</sortablename> <populationLabel>POPULATIONLABEL</populationLabel> </user>
Signature :
Node user()
Node user(String userIdentity)
Node user(String login, String populationId)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
userIdentity |
String |
Identifiant de l'utilisateur sous la forme: login#populationId |
|
Nom |
Type |
Description |
|---|---|---|
|
login |
String |
Identifiant de l'utilisateur |
|
populationId |
String |
Identifiant de la population de l'utilisateur |
Exemple :
Pour obtenir les valeurs retournées dans environnement donné, exécuter le code suivant sur une page limitée (pour éviter les problèmes de cache et ne pas avoir un résultat vide) et analyser la code source généré.
<MARKER><xsl:copy-of select="ametys:user()"/></MARKER>
groups
Description : Retourne une liste de noeuds DOM correspondant aux groupes de l'utilisateur connecté ou d'un utilisateur donné. Cette méthode ne doit pas être appelée dans un environnement cachable (service cachable, contenu, ...).
<group name="group1" directory="directory1"/> <group name="group2" directory="directory2"/>
Signatures :
NodeList groups()
NodeList groups(String userIdentity)
NodeList groups(String login, String populationId)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
userIdentity |
String |
Identifiant de l'utilisateur sous la forme: login#populationId |
|
Nom |
Type |
Description |
|---|---|---|
|
login |
String |
Identifiant de l'utilisateur |
|
populationId |
String |
Identifiant de la population de l'utilisateur |
Exemple : Pour obtenir les valeurs retournées dans environnement donné, exécuter le code suivant sur une page limitée (pour éviter les problèmes de cache et ne pas avoir un résultat vide) et analyser la code source généré.
<MARKER> <xsl:for-each select="ametys:groups()"> <GROUP><xsl:value-of select="@name"/>#<xsl:value-of select="@directory"/></GROUP> </xsl:for-each> </MARKER>
pagination
A partir de Ametys 4.2
Description : Retourne une structure XML permettant de créer facilement une pagination avec séparateurs du type
|< < 1 2 ... 5 6 7 ... 10 11 > >|
Les types d'éléments renvoyés sont :
<gotofirstpage enabled="true|false">1</gotofirstpage> <gotopreviouspage enabled="true|false">5</gotopreviouspage> <page>1</page> <current>2</current> <space/> <separator/> <gotonextpage enabled="true|false">7</gotonextpage> <gotolastpage enabled="true|false">12</gotolastpage>
On considère que les séparateurs prennent une place (comme un numéro de page) et donc si vous demandez:
2 numéros puis 1 séparateur puis 3 numéros puis 1 séparateur puis 2 numéros
avec 9 pages de résultats vous obtiendrez |< < 1 2 3 4 5 6 7 8 9 > >|
avec 10 pages de résultats vous obtiendrez |< < 1 2 ... 5 6 7 8 9 10 > >|
avec 11 pages de résultats vous obtiendrez |< < 1 2 ... 5 6 7 ... 10 11 > >|
Signatures :
NodeList pagination(int nbPages, int currentPage, int nbFirstPages, int nbCentralPages, int nbLastPages)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
nbPages |
int |
Le nombre total de pages de résultats |
|
currentPage |
int |
Le numéro de la page actuelle de résultats |
|
nbFirstPages |
int |
La taille du premier lot de pages (entre le bouton < et le premier séparateur) |
|
nbCentralPages |
int |
La taille du lot central de pages (entre les deux séparateurs) |
|
nbLastPages |
int |
La taille du dernier lot de pages (après le dernier séparateur) |
Exemple : Pour créer une pagination du type |< < ... 4 5 6 7 8 ... > >|
ametys:pagination(12, 6, 0, 5, 0)
<gotofirstpage enabled="true">1</gotofirstpage> <gotopreviouspage enabled="true">5</gotopreviouspage> <separator/> <page>4</page> <page>5</page> <current>6</current> <page>7</page> <page>8</page> <separator/> <gotonextpage enabled="true">7</gotonextpage> <gotolastpage enabled="true">12</gotolastpage>
ametys:pagination(6, 6, 0, 5, 0)
<gotofirstpage enabled="true">1</gotofirstpage> <gotopreviouspage enabled="true">5</gotopreviouspage > <page>1</page> <page>2</page> <page>3</page> <page>4</page> <page>5</page> <current>6</current> <gotonextpage enabled="false"></gotonextpage> <gotolastpage enabled="false">6</gotolastpage>
isEditionMode
Description :
Détermine si l'affichage actuel est le mode edition sur le front (au sens du plugin Front Edition) ou pas.
Signature :
boolean isEditionMode()
Paramètres
config
Description :
Retourne la valeur d'un paramètre de configuration.
Signature :
String config(String id)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
id |
String |
Identifiant du paramètre |
Exemple :
<script type="text/javascript">
alert("Vous allez recevoir un email de <xsl:value-of select="ametys:config('smtp.mail.from')"/>");
</script> siteLanguages
A partir de Ametys 4.8
Description :
Retourne la liste des langues disponibles pour un site
<lang>fr</lang> <lang>en</lang>
Signature :
NodeList siteLanguages()
NodeList siteLanguages(String siteName)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
siteName |
String |
Nom du site ou site courant si vide |
siteParameter
Description :
Retourne la valeur d'un paramètre de site.
Signature :
String siteParameter(String parameter)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
parameter |
String |
Identifiant du paramètre |
Exemple :
<script type="text/javascript">
var googleAnalyticsIdentifier = "<xsl:value-of select="ametys:siteParameter('site-param-google-web-property-id')"/>";
</script> serviceParameter
Description :
Retourne le nœud DOM représentant la valeur du paramètre de service en cours de rendu.
Cette méthode doit uniquement être appelée lors du rendu d'un service.
Éventuellement, ajouter une valeur par défaut (facultatif).
Signature :
Node serviceParameter (String parameter)
Node serviceParamter (String parameter, String defaultValue)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
parameter |
String |
Identifiant du paramètre de service |
|
Nom |
Type |
Description |
|---|---|---|
|
parameter |
String |
Identifiant du paramètre de service |
|
defaultValue |
String |
Si la valeur est vide, la valeur par défaut est renvoyée (cela peut notamment se produire lorsqu'un nouveau paramètre de service est ajouté pour rester compatible avec les données déjà existantes. Si le paramètre est de type composite, la valeur par défaut ne sera pas utilisée. |
L'arbre DOM retourné pour un paramètre simple a la forme suivante :
<header name="header" type="string">Mon titre de service</header>
L'arbre DOM retourné pour un paramètre composé a la forme suivante :
<search name="search" type="composite"> <_x0031_ name="1" type="composite"> <sites>www</sites> <tags name="tags" type="string">TAG1</tags> <lang-context name="lang-context" type="string">CURRENT</lang-context> </_x0031> </search>
Exemple :
<h1><xsl:value-of select="ametys:serviceParameter('header')"/><h1> <xsl:value-of select="ametys:serviceParameter('search')/*/tags"/> serviceParameters
Description :
Retourne tous les paramètres du service en cours de rendu sous la forme d'un arbre DOM.
Cette méthode doit uniquement être appelée lors du rendu d'un service.
Signature :
Node serviceParameters ()
L'abre DOM retourné a la forme suivante :
<serviceParameters> <header name="header" type="string">My title</header> <nb-max name="nb-max" type="string">5</nb-max> <search name="search" type="composite"> <_x0031_ name="1" type="composite"> <tags name="tags" type="string">TAG1,TAG2</tags> <site name="site" type="string">www</site> </_x0031> <_x0032_ name="2" type="composite"> <tags name="tags" type="string">TAG3</tags> <site name="site" type="string">blog</site> </_x0032> </search> </serviceParameters>
Exemple :
<h1><xsl:value-of select="ametys:serviceParameters()/header"/></h1>
requestParameter
Description :
Retourne la valeur d'un paramètre de requête.
Attention! Ceci ne doit être utilisé que dans des XSL non cachables (comme les services non cachables). Sinon, le résultat du premier visiteur sera utilisé pour tous les autres visiteurs...
Signature :
String requestParameter(String parameter)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
parameter |
String |
Nom du paramètre |
Exemple :
Pour l'URL suivante : http://www.ametys.org/fr/index.html?id=3
<input type="hidden" name="id" value="{ametys:requestParameter('id')}"/> Paramètres de vue
templateParameters
Description :
Renvoie la liste des paramètres de vue, du gabarit courant, qui ont une valeur. Cette liste tient compte de l'héritage des paramètres.
S'il n'y en a pas, la liste est vide.
Signature :
NodeList templateParameters ()
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
La liste de tous les paramètres de vue, du gabarit courant, qui ont une valeur. Cette liste tient compte de l'héritage des paramètres |
Exemple :
<param1>valeur1</param1> <param2>valeur2</param2> // Ce paramètre est multiple <param2>valeur3</param2> <param3> <longitude>0.0<longitude> <latitude>1.0<latitude> </param3>
templateParameter (avec l'argument parameterPath)
Description :
Renvoie la valeur du paramètre de vue donné sur le gabarit courant. Il prendra automatiquement en compte l'héritage si il y en a.
S'il n'y a pas de valeur ou que le chemin du paramètre est invalide, il renvoie null.
Signature :
NodeList templateParameter (String parameterPath)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
parameterPath |
String |
Le chemin du paramètre de vue |
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
Renvoie la valeur du paramètre de vue donné sur le gabarit courant. Il prendra automatiquement en compte l'héritage si il y en a. |
Exemple :
<param>value</param>
templateParameter (avec les arguments pageId et parameterPath)
Description :
Renvoie la valeur du paramètre de vue donné sur le gabarit de la page donnée en argument. Il prendra automatiquement en compte l'héritage si il y en a.
S'il n'y a pas de valeur ou que le chemin du paramètre est invalide ou que l'identifiant de la page est erroné, il renvoie null.
Signature :
NodeList templateParameter (String pageId, String parameterPath)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
pageId |
String |
L'identifiant JCR de la page |
|
parameterPath |
String |
Le chemin du paramètre de vue |
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
Renvoie la valeur du paramètre de vue donné sur le gabarit de la page donnée en argument. Il prendra automatiquement en compte l'héritage si il y en a. |
Exemple :
<param>value</param>
zoneParameters (sans argument)
Description :
Renvoie la liste des paramètres de vue, de la zone courante qui ont une valeur. Cette liste tient compte de l'héritage des paramètres.
S'il n'y en a pas, la liste est vide.
Signature :
NodeList zoneParameters ()
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
Renvoie la liste des paramètres de vue, de la zone courante qui ont une valeur. Cette liste tient compte de l'héritage des paramètres. |
Exemple :
<param1>valeur1</param1> <param2>valeur2</param2> // Ce paramètre est multiple <param2>valeur3</param2> <param3> <longitude>0.0<longitude> <latitude>1.0<latitude> </param3>
zoneParameters (avec l'argument zoneName)
Description :
Renvoie la liste des paramètres de vue, de la page courante sur zone donnée en argument, qui ont une valeur. Cette liste tient compte de l'héritage des paramètres.
S'il n'y en a pas, la liste est vide.
Signature :
NodeList zoneParameters (String zoneName)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
zoneName |
String |
Le nom de la zone |
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
Renvoie la liste des paramètres de vue, de la page courante sur zone donnée en argument, qui ont une valeur. Cette liste tient compte de l'héritage des paramètres. |
Exemple :
<param1>valeur1</param1> <param2>valeur2</param2> // Ce paramètre est multiple <param2>valeur3</param2> <param3> <longitude>0.0<longitude> <latitude>1.0<latitude> </param3>
zoneParameter (avec l'argument parameterPath)
Description :
Renvoie la valeur du paramètre de vue donné sur la zone courante. Il prendra automatiquement en compte l'héritage si il y en a.
S'il n'y a pas de valeur ou que le chemin du paramètre est invalide, il renvoie null.
Signature :
NodeList zoneParameter (String parameterPath)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
parameterPath |
String |
Le chemin du paramètre de vue |
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
Renvoie la valeur du paramètre de vue donné sur la zone courante. Il prendra automatiquement en compte l'héritage si il y en a. |
Exemple :
<param>value</param>
zoneParameter (avec les arguments zoneName et parameterPath)
Description :
Renvoie la valeur du paramètre de vue donné sur la zone donnée en argument de la page courante. Il prendra automatiquement en compte l'héritage si il y en a.
S'il n'y a pas de valeur ou que le chemin du paramètre est invalide ou que la zone n'existe pas, il renvoie null.
Signature :
NodeList zoneParameter (String zoneName, String parameterPath)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
zoneName |
String |
Le nom de la zone |
|
parameterPath |
String |
Le chemin du paramètre de vue |
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
Renvoie la valeur du paramètre de vue donné sur la zone donnée en argument de la page courante. Il prendra automatiquement en compte l'héritage si il y en a. |
Exemple :
<param>value</param>
zoneParameter (avec les arguments pageId, zoneName et parameterPath)
Description :
Renvoie la valeur du paramètre de vue donné sur la page et la zone données en argument. Il prendra automatiquement en compte l'héritage si il y en a.
S'il n'y a pas de valeur ou que le chemin du paramètre est invalide ou que la zone ou la page n'existe pas, il renvoie null.
Signature :
NodeList zoneParameter (String pageId, String zoneName, String parameterPath)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
pageId |
String |
L'identifiant JCR de la page |
|
zoneName |
String |
Le nom de la zone |
|
parameterPath |
String |
Le chemin du paramètre de vue |
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
Renvoie la valeur du paramètre de vue donné sur la page et la zone données en argument. Il prendra automatiquement en compte l'héritage si il y en a. |
Exemple :
<param>value</param>
zoneItemParameters (sans argument)
Description :
Renvoie la liste des paramètres de vue, du zone item courant , qui ont une valeur.
S'il n'y en a pas, la liste est vide.
Signature :
NodeList zoneItemParameters ()
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
Renvoie la liste des paramètres de vue, du zone item courant , qui ont une valeur. |
Exemple :
<param1>valeur1</param1> <param2>valeur2</param2> // Ce paramètre est multiple <param2>valeur3</param2> <param3> <longitude>0.0<longitude> <latitude>1.0<latitude> </param3>
zoneItemParameters (avec l'argument zoneItemId)
Description :
Renvoie la liste des paramètres de vue, du zone item donnée en argument , qui ont une valeur.
S'il n'y en a pas, la liste est vide.
Signature :
NodeList zoneItemParameters (String zoneItemId)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
zoneItemId |
String |
L'identifiant JCR du zone item |
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
Renvoie la liste des paramètres de vue, du zone item donnée en argument , qui ont une valeur. |
Exemple :
<param1>valeur1</param1> <param2>valeur2</param2> // Ce paramètre est multiple <param2>valeur3</param2> <param3> <longitude>0.0<longitude> <latitude>1.0<latitude> </param3>
zoneItemParameter (avec l'argument parameterPath)
Description :
Renvoie la valeur du paramètre de vue donné sur le zone item courant.
S'il n'y a pas de valeur ou que le chemin du paramètre est invalide, il renvoie null.
Signature :
NodeList zoneItemParameter (String parameterPath)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
parameterPath |
String |
Chemin du paramètre de vue |
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
Renvoie la valeur du paramètre de vue donné sur le zone item courant. |
Exemple :
<param>value</param>
zoneItemParameter (avec les arguments zoneItemId et parameterPath)
Description :
Renvoie la valeur du paramètre de vue et du zone item donné.
S'il n'y a pas de valeur ou que le chemin du paramètre est invalide, il renvoie null.
Signature :
NodeList zoneItemParameter (String zoneItemId, String parameterPath)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
zoneItemId |
String |
L'identifiant JCR du zone item |
|
parameterPath |
String |
Le chemin du paramètre de vue |
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
Renvoie la valeur du paramètre de vue et du zone item donné. |
Exemple :
<param>value</param>
serviceViewParameters
Description :
Renvoie la liste des paramètres de vue, du service courant, qui ont une valeur.
S'il n'y en a pas, la liste est vide.
Signature :
NodeList serviceViewParameters()
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
Renvoie la liste des paramètres de vue, du service courant, qui ont une valeur. |
Exemple :
<param1>valeur1</param1> <param2>valeur2</param2> // Ce paramètre est multiple <param2>valeur3</param2> <param3> <longitude>0.0<longitude> <latitude>1.0<latitude> </param3>
serviceViewParameter
Description :
Renvoie la valeur du paramètre de vue donnée sur le service courant
S'il n'y a pas de valeur ou que le chemin du paramètre est invalide, il renvoie null.
Signature :
NodeList serviceViewParameter (String parameterPath)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
parameterPath |
String |
Le chemin du paramètre de vue |
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
Renvoie la valeur du paramètre de vue donnée sur le service courant |
Exemple :
<param>value</param>
contentViewParameters
Description :
Renvoie la liste des paramètres de vue, du contenu courant, qui ont une valeur.
S'il n'y en a pas, la liste est vide.
Signature :
NodeList contentViewParameters()
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
Renvoie la liste des paramètres de vue, du contenu courant, qui ont une valeur. |
Exemple :
<param1>valeur1</param1> <param2>valeur2</param2> // Ce paramètre est multiple <param2>valeur3</param2> <param3> <longitude>0.0<longitude> <latitude>1.0<latitude> </param3>
contentViewParameter
Description :
Renvoie la valeur du paramètre de vue donnée sur le contenu courant
S'il n'y a pas de valeur ou que le chemin du paramètre est invalide, il renvoie null.
Signature :
NodeList contentViewParameter (String parameterPath)
Arguments :
|
Nom |
Type |
Description |
|---|---|---|
|
parameterPath |
String |
Le chemin du paramètre de vue |
Retour:
|
Type |
Description |
|---|---|
|
NodeList |
Renvoie la valeur du paramètre de vue donnée sur le contenu courant |
Exemple :
<param>value</param>
Retour en haut