Les filtres de sortie MODX [niveau intermédiaire]

• 04 septembre 2016
• Steeve

Les filtres de sortie permettent de faire deux choses bien distinctes, des filtres de condition de sorti et des modificateurs de sortie de chaine.

Filtre de condition de sortie.

Cela permet de vérifier une ou plusieurs valeurs et de renvoyer une chose si la ou les valeurs sont vrai, ou un autre chose si la valeur est fausse. Exemple en français :

Admettons que je veuille afficher l'ID (identifiant unique) de l'utilisateur qui a écrit ce post je vais écrire ce code : [[*publishedby]] ce qui devrait me renvoyer un numéro (normalement 1 car je suis le premier utilisateur du site).

Donc je pourrais tester avec un filtre de valeur si la valeur est de 1 alors j'écrit « oui c'est 1 », si par contre la valeur n'est pas de 1 je revoie « non c'est pas 1 ». Pour réaliser ceci il suffirait d'écrire comme ceci :

[[*publishedby:is=`1`:then=`oui c’est 1`:else=`non c’est pas 1`]]

Comme vous pouvez le voir, il est vraiment facile de tester la ou les valeurs de sortie d’une variable quelles qu’elles soient. Vous pouvez tester les variables d’une ressource telles que : pagetitle, longtitle, menutitle, publishedby, etc…

Et vous pouvez aussi tester les variables de modèle que vous aurez vous même créez.

Comme vous pouvez le voir, il est vraiment facile de tester la ou les valeurs de sortie d’une variable quelles qu’elles soient. Vous pouvez tester les variables d’une ressource telles que : pagetitle, longtitle, menutitle, publishedby, etc…
Et vous pouvez aussi tester les variables de modèle que vous aurez vous même créez.
Ou même des valeurs d’une ressource externe par exemple si vous faites appel a getResources ou Rowboat (extra de MODX).

Voici la liste des modificateurs de sortie conditionnels.

Modificateur de sortie de chaîne.

Le modificateur n'est pas fait pour comparer la valeur de l'élément par rapport à un autre. Il est la comme son nom l'indique pour modifier la valeur elle même. L'exemple le plus simple c'est par exemple de mettre la chaine de caractères retourné en majuscule.
Un autre exemple serait de renvoyer le nombre de caractères que contient la chaine de caractères.
Ou encore de couper la chaine selon une certaine longueur de caractères.

Voici la liste des modificateurs de sortie de chaîne.

Pour aller plus loin vous pouvez créer votre propre filtre de sortie (output filter).

Exemple d'un filtre de sortie (output filter) personnalisé. Ce filtre permet juste de remplacer tous les espace les espaces dans ma variable, par un espace suivi d'une virgule. Exemple simple qui n'a pas trop d'intérêt mais qui vous permettra je l'espère de comprendre comment cela fonctionne.

// Ma variable recherche prend pour valeur un espace
$recherche = ' ';
// Ma variable remplace prend pour valeur un espace suivi d’une virgule
$remplace = ' ,'; 
// On recherche un espace
// et on remplace par un espace suivi d’une virgule
// dans la valeur d’entrée (input)
// dans la variable sortie
$sortie = str_replace($recherche, $remplace, $input);
// On renvoie la variable sortie
return $sortie;

Source en Anglais

N’hésitez pas si vous avez des questions concernant ce tutoriel.
Si vous l'avez apprécié partagez le ;-)