Filtres HubL

Les filtres affectent le résultat final de votre HubL. Ils peuvent être appliqués à diverses annonces et expressions HubL pour modifier le balisage du modèle produit par le serveur.

La syntaxe de base d'un filtre est |filtername. Le filtre est ajouté directement après l'annonce ou l'expression, à l'intérieur de ses séparateurs. Certains filtres ont des paramètres supplémentaires qui peuvent être ajoutés entre parenthèses. La syntaxe de base d'un filtre avec un paramètre de type chaîne, nombre et booléen est : |filtername("stringParameter", 10, true). Notez que les paramètres de type chaîne doivent être écrits entre guillemets. Notez également que les filtres HubL ont un alias qui peut être utilisé pour servir le même objectif que le filtre principal.

L'article suivant contient tous les filtres HubL pris en charge.

Obtient la valeur absolue d'un nombre. Vous pouvez utiliser ce filtre pour vérifier qu'un nombre est positif.

Dans l'exemple ci-dessous, il existe une variable contenant une séquence de types de fruits. Le filtre de lot est appliqué à une boucle qui parcourt la séquence. La boucle imbriquée s'exécute trois fois pour imprimer 3 types de fruits par ligne, avant que la boucle externe ne s'exécute à nouveau. Remarquez dans la sortie finale, puisqu'il n'y a que 5 types de fruits, le dernier élément est remplacé par un &nbsp (le deuxième paramètre).

L'exemple ci-dessous montre un filtre center appliqué à une variable dans une pré-balise, de sorte que les espaces blancs ne sont pas supprimés.

Échappe le contenu d'une entrée d'attribut HTML. Accepte une chaîne et convertit les caractères &, <, ‘, ” et escape_jinjava en séquences conformes à HTML. Utilisez ce filtre pour les variables HubL qui sont ajoutées aux attributs HTML.

Notez que lorsque vous échappez des valeurs d'attributs qui acceptent les URL, telles que href, vous devez utiliser le filtre escape_url à la place.

Calcule la distance ellipsoïdale 2D entre deux points sur la Terre.

Le filtre groupby regroupe une séquence d'objets selon un attribut commun. Le paramètre définit l'attribut commun pour le regroupement.

Le filtre indent utilise les espaces blancs pour indenter le texte dans une longueur de champ donnée. Ce filtre n'est pas recommandé et n'est pas particulièrement utile, car le compilateur HTML de HubSpot élimine automatiquement les espaces blancs ; cependant, il est inclus ici par souci d'exhaustivité. L'exemple ci-dessous montre un filtre center appliqué à une variable dans une pré-balise, de sorte que les espaces blancs ne sont pas supprimés. Le premier paramètre contrôle la quantité d'espaces blancs et le second booléen permet d'indenter ou non la première ligne.

Convertir la valeur en un nombre entier. Si la conversion ne fonctionne pas, elle renvoie 0. Vous pouvez remplacer cette valeur par défaut en utilisant le premier paramètre.

Ce filtre renvoie l'intersection de deux ensembles ou listes. La liste renvoyée par le filtre contient tous les éléments uniques qui sont contenus dans les deux listes.

Évalue comme true si la valeur est une adresse IPv4 ou IPv6 valide.

Renvoie une chaîne qui est la concaténation des chaînes de la séquence. Le séparateur entre les éléments est une chaîne vide par défaut, vous pouvez le définir avec le paramètre facultatif. Le deuxième paramètre peut être utilisé pour indiquer un attribut à joindre.

Renvoie le dernier élément d'une séquence.

Renvoie le nombre d'éléments d'une séquence ou d'un mappage.

Convertit les valeurs numériques en une liste. S'il s'agit d'une chaîne, la liste renvoyée sera une liste de caractères. Pour ajouter des chaînes à une séquence, il suffit de les ajouter aux variables de chaîne des délimiteurs de séquence [ ].

Calcule le logarithme naturel d'un nombre.

Convertit une valeur en lettres minuscules.

Applique un filtre sur une séquence d'objets ou recherche un attribut. C'est utile lorsque vous traitez des listes d'objets, mais que vous n'êtes réellement intéressé que par une certaine valeur de celle-ci.

L'utilisation de base est le mappage d'un attribut. Par exemple, si vous voulez utiliser la logique conditionnelle pour vérifier si une valeur est présente dans un attribut particulier d'un dictionnaire. Vous pouvez également le laisser utiliser un filtre en transmettant le nom du filtre et les arguments après.

Calcule le hachage md5 de l'objet donné

Soustrait un nombre d'heures à un objet datetime.

Multiplie une valeur par un nombre. Fonctionne de la même manière que l'opérateur *.

Ajoute un nombre d'heures à un objet datetime.

Impression d'une variable avec mise en forme. Ceci imprime le type de variable et d'autres informations utiles pour le débogage.

Renvoie un élément aléatoire de la séquence.

Recherche un motif regex et le remplace par une séquence de caractères. Le premier argument est un motif regex de style RE2, le second est la chaîne de remplacement.

Des informations sur la syntaxe des regex RE2 sont disponibles ici.

Filtre une séquence d'objets en appliquant un test d'expression à l'objet et en rejetant ceux dont le test a réussi.

Filtre une séquence d'objets en appliquant un test à l'attribut d'un objet et en rejetant ceux dont le test a réussi. 

Rend les chaînes contenant HubL au début afin que la sortie puisse être transmise dans d'autres filtres.

Remplace toutes les instances d'une sous-chaîne par une nouvelle. 

Inverse l'objet ou renvoie un itérateur qui parcours dans l'autre sens. Pour inverser une liste, utilisez .reverse()

Calcule la racine carrée d'une valeur

Arrondit le nombre à une précision donnée.

Marquer la valeur comme sûre, ce qui signifie que dans un environnement où l'échappement automatique est activé, cette variable ne sera pas échappée.

Nettoie le contenu d'une entrée HTML pour la sortie de contenu en texte enrichi. Accepte une chaîne, puis supprime les balises HTML qui ne sont pas autorisées. Utilisez ce filtre pour les variables HubL utilisées en HTML qui devraient permettre un HTML sécurisé.

Lorsque vous utilisez ce filtre, vous pouvez inclure les paramètres suivants pour autoriser des types spécifiques de balises HTML : FORMATTING, BLOCKS, STYLES, LINKS, TABLES, IMAGES. Par exemple : sanitize_html(IMAGES).

L'utilisation de sanitize_html inclura tous les paramètres dans le filtre.

Vous pouvez également inclure un paramètre STRIP pour supprimer tout le HTML. Tout le contenu est également exécuté via escape_jinjava pour empêcher l'interprétation imbriquée.

Filtre une séquence d'objets en appliquant un test à l'objet et en ne sélectionnant que ceux dont le test a réussi.

Filtre une séquence d'objets en appliquant un test à un attribut d'un objet et en ne sélectionnant que ceux dont le test a réussi.

Rend aléatoire l'ordre d'itération d'une séquence. L'exemple ci-dessous mélange une boucle de blog standard.

Découpe un itérateur et renvoie une liste de listes contenant ces éléments. Le premier paramètre indique le nombre d'éléments qui seront découpés, et le second paramètre indique les caractères à utiliser pour remplir les tranches vides.

Trie une table itérative. Ce filtre nécessite que tous les paramètres soient triés en utilisant un attribut dans HubSpot. Le premier paramètre est un booléen pour inverser l'ordre de tri. Le deuxième paramètre détermine si le tri prend en compte la casse. Et le dernier paramètre indique l'attribut à utiliser pour le tri. Dans l'exemple ci-dessous, les articles d'un blog sont rendus et classés par ordre alphabétique de leur nom.

Divise la chaîne d'entrée en une liste selon le séparateur donné. Le premier paramètre indique le séparateur avec lequel la variable doit être divisée. Le deuxième paramètre détermine combien de fois la variable doit être divisée. Tous les autres éléments resteraient groupés. Dans l'exemple ci-dessous, une chaîne de noms est séparée au niveau du « ; » pour les 4 premiers noms.

Convertit un type de variable différent en une chaîne. Dans l'exemple ci-dessous, un entier est converti en chaîne (pprint est utilisé pour confirmer le changement de type de variable).

Efface les balises SGML/XML et remplace les espaces blancs adjacents par un espace. Ce filtre peut être utilisé pour supprimer toutes les balises HTML d'une variable.

Convertit une chaîne datetime et un format datetime en un objet datetime.

Ajoute des valeurs numériques dans une séquence. Le premier paramètre peut indiquer un attribut facultatif et le second paramètre définit une valeur à renvoyer s'il n'y a rien dans la variable à additionner.

Ce filtre renvoie la différence symétrique de deux ensembles ou listes. La liste renvoyée par le filtre contient tous les éléments uniques qui figurent dans la première liste, mais pas dans la seconde, ou qui figurent dans la seconde liste, mais pas dans la première.

Renvoie une version titlecased de la valeur. C'est-à-dire que les mots commencent par des lettres majuscules, tous les autres caractères sont des minuscules.

Écrit un objet sous forme de chaîne JSON.

Supprime les espaces blancs de début et de fin. HubSpot supprime déjà les espaces blancs du balisage, mais ce filtre est documenté par souci d'exhaustivité.

Coupe le texte après un certain nombre de caractères. La valeur par défaut est 255. Veuillez noter que les caractères HTML sont inclus dans ce décompte. La longueur est indiquée avec le premier paramètre qui a la valeur 255 par défaut. Si le deuxième paramètre est true, le filtre coupera le texte en longueur. Sinon, le dernier mot est rejeté. Si le texte a été tronqué, il ajoutera un signe d'ellipse (« ... »). Si vous souhaitez un autre signe d'ellipse que « ... », vous pouvez l'indiquer en utilisant le troisième paramètre.

Tronque une chaîne donnée, en respectant le balisage html (c'est-à-dire qu'il fermera correctement toutes les balises imbriquées). Cela empêchera une balise de rester ouverte après la troncature. Les caractères HTML ne sont pas pris en compte dans le total des caractères. Ce filtre a un paramètre de longueur et un paramètre de symbole de troncature. Il existe un troisième paramètre booléen qui indique si les mots seront cassés en longueur. Ce paramètre est faux par défaut afin de préserver la longueur des mots. Si vous n'utilisez qu'un seul des paramètres facultatifs, utilisez des arguments de type mot-clé, comme truncatehtml(70, breakwords = false).

Ce filtre renvoie l'union de deux ensembles ou listes. La liste renvoyée par le filtre contient tous les éléments uniques qui se trouvent dans l'une ou l'autre des listes.

Ce filtre extrait un ensemble unique d'une séquence ou d'un dictionnaire d'objets. Lors du filtrage d'un dictionnaire, tel qu'une liste d'articles renvoyée par une fonction, vous pouvez indiquer quel attribut est utilisé pour dédupliquer les éléments du dictionnaire.

Ce filtre convertit un objet datetime en un horodatage unix.

Convertit une valeur en lettres majuscules.

Quitte et encode l'URL d'une chaîne utilisant le formatage UTF-8. Accepte à la fois les dictionnaires et les chaînes régulières ainsi que les itérables par paire.

Décode les chaînes d'URL encodées vers l'URL d'origine. Accepte à la fois les dictionnaires et les chaînes régulières ainsi que les itérables par paire.

Convertit les URL en texte brut en liens cliquables. Si vous transmettez au filtre un nombre entier supplémentaire, il raccourcira les URL à ce nombre. Le deuxième paramètre est un booléen qui indique si le lien est rel="no follow". Le dernier paramètre vous permet de préciser si le lien s'ouvrira dans un nouvel onglet.

Compte le nombre de mots dans une chaîne.

Provoque le retour à la ligne des mots après un nombre de caractères donné. Cela fonctionne mieux dans un <pre> car HubSpot supprime les espaces blancs par défaut.

Crée une chaîne d'attributs HTML/XML, basée sur les éléments d'un dictionnaire. Toutes les valeurs qui ne sont ni nulles,
ni indéfinies sont automatiquement échappées. Il ajoute automatiquement un espace devant l'élément si le filtre renvoie quelque chose, sauf si le premier paramètre est false.