Utiliser la balise #TRI et le criètre ’tri’ dans les squelettes

Préambule

Le plugin “spip-bonux” améliore et facilite les tris dans les tableaux de résultats. Il met en jeu deux nouveaux outils :
-  un critère tri à placer dans vos boucles, et qui peut éventuellement être utilisé seul
-  une balise #TRI à placer dans vos squelettes, et qui génère des liens permettant de changer le sens des tris d’un tableau

Il s’agit d’une alternative incontournable au système jquery de tri “Table Sorter”.

Utilisation du critère “tri” dans une boucle

Le critère ’tri’ peut être utilisé dans une boucle de la manière suivante :

<BOUCLE_test(ARTICLES){tri #ENV{order,champ},#GET{defaut_tri}}>

Les 2 paramètres principaux à passer au critère tri sont les suivants :
1. le champ sur lequel le tri s’effectue; dans notre cas le tri s’effectue sur la variable “order” contenue dans #ENV (#ENV{order}), et si celle-ci n’existe pas, sur le champ “champ”
2. le sens du tri : cela peut être défini dans un tableau contenant les champs sur lesquels le tri peut s’effectuer et leur sens de tri par défaut

On peut passer un 3ème paramètre qui est le nom de la variable (par défaut : tri_nomboucle).

Utilisation de la balise #TRI dans un squelette

La balise #TRI est remplacée lors du calcul de la page par un lien permettant de changer le paramètre “order” dans le #ENV. Elle s’utilise de la manière suivante (exemple dans une boucle contenant un champ id_commande) :

[(#TRI{id_commande,Numero Commande,ajax})]

Les 3 paramètres à passer à la balise #TRI sont les suivants :
1. le champ sur lequel le tri doit s’opérer
2. le titre du lien sur lequel il faudra cliquer pour recharger la page avec le paramètre order=champ
3. si ’ajax’ est spécifié en tant que 3ème paramètre, on évite un recalcul total de la page lorsqu’on clique sur le lien.

Méthode opératoire : combinaison filtre ’tri’ + balise #TRI

Charger le plugin “spip-bonux”

Une fois le plugin installé [1], bien vérifier que les scripts ont été chargés dans le squelette (une balise #INSERT_HEAD bien placée, suffit la plupart du temps).

Décrire le tri par défaut désiré

Placer au début du squelette la définition du tri par défaut.

Par exemple, pour que le tri du tableau s’effectue, dans l’ordre : sur le id_parent, le id_organisation et le id_rubrique, indiquer :

[(#SET{defaut_tri,#ARRAY{
    id_parent,1,
    id_organisation,1,
    id_rubrique,1
}})
]


-  les clés du tableau sont les noms des champs sur lesquels s’opère le tri
-  les valeurs du tableau valent : 1 pour un tri ascendant, et -1 pour un tri descendant.

Indiquez les critères de tri dans la boucle

Par exemple, pour être en mesure de trier la boucle (complexe...) suivante par parent, organisation et rubrique, indiquez ces champs dans les critères de la boucle :

<BOUCLE_rubriques(RUBRIQUES organisations_liens organisations)
    {recherche ?}
    {id_parent IN 42, 43, 76, 38}
    {id_organisation ?}
    {tri #ENV{order,id_rubrique},#GET{defaut_tri}}
    {pagination #ENV{nb,20}}>

Autre exemple, pour pouvoir trier la boucle «factures» suivante, par date, numéro ou libellé :

<BOUCLE_ff(FACTURES actions)
    {num_facture ?}
    {libelle_facture ?}
    {actions.id_projet}
    {doublons}
    {tri #ENV{order,date_facture},#GET{defaut_tri}}
    {pagination 10}>

Insérez la balise #TRI sur les colonnes pouvant être triées

Si votre liste est contenue par un tableau html, le déclenchement du tri peut être obtenu en cliquant sur le titre des colonnes. Il faut donc placer la balise #TRI dans le <th> de chaque colonne. La balise #TRI, qui génère le lien, s’utilise de la manière suivante :
#TRI{champ[,libelle][,ajax]}.

Pour le cas précédent, où l’on doit trier par parent, id_rubrique ou organisation, voici le code de l’entête du tableau :

<thead>
    <tr>
    	<th>[(#TRI{id_parent,Type,ajax})]</th>
        <th>[(#TRI{id_rubrique,Rubrique,ajax})]</th>
        <th>[(#TRI{id_organisation,Organisation,ajax})]</th>
    </tr>
</thead>

En complément

Les fonctionnalités de la balise #TRI, définies dans BONUX pour SPIP 2, sont inclues en standard dans la version 3.0 de SPIP.

Voici le lien vers des explications complémentaires jointes au commit de la balise et du critère
-  dans BONUX : http://zone.spip.org/trac/spip-zone/changeset/25693
-  dans SPIP3 : http://core.spip.org/projects/spip/repository/revisions/16053

N’hésitez pas à publier d’autres exemples de boucles dans le forum.

Autres exemples :

[(#ENV{sens_reglements}|=={-1}|non)
	[(#TRI{'>',#CHEMIN{img_pack/tri_asc-16.png}|balise_img{up}|inserer_attribut{class,on},ajax})]
]
[(#ENV{sens_reglements}|=={-1}|oui)
	[(#TRI{'<',#CHEMIN{img_pack/tri_desc-16.png}|balise_img{down}|inserer_attribut{class,on},ajax})]
]
 
[(#ENV{tri_factures}|=={num_facture}|oui)
        [(#ENV{sens_factures}|=={-1}|non)[(#TRI{'>',#CHEMIN{img_pack/tri_asc-16.png}|balise_img{up}|inserer_attribut{class,on},ajax})]]
        [(#ENV{sens_factures}|=={-1}|oui)[(#TRI{'<',#CHEMIN{img_pack/tri_desc-16.png}|balise_img{down}|inserer_attribut{class,on},ajax})]]
        ]
[(#ENV{tri_factures}|=={date_facture}|oui)
        [(#ENV{sens_factures}|=={-1}|non)[(#TRI{'>',#CHEMIN{img_pack/tri_asc-16.png}|balise_img{up}|inserer_attribut{class,on},ajax})]]
        [(#ENV{sens_factures}|=={-1}|oui)[(#TRI{'<',#CHEMIN{img_pack/tri_desc-16.png}|balise_img{down}|inserer_attribut{class,on},ajax})]]
        ]
[(#ENV{tri_factures}|=={montant}|oui)
        [(#ENV{sens_factures}|=={-1}|non)[(#TRI{'>',#CHEMIN{img_pack/tri_asc-16.png}|balise_img{up}|inserer_attribut{class,on},ajax})]]
        [(#ENV{sens_factures}|=={-1}|oui)[(#TRI{'<',#CHEMIN{img_pack/tri_desc-16.png}|balise_img{down}|inserer_attribut{class,on},ajax})]]
        ]

Footnotes

[1Pour un SPIP 2, ce fonctionnement est natif en SPIP 3.

updated on 9 February 2019

Discussion

5 discussions

  • latitlolo

    Bonjour,

    Comment vous y prenez vous pour internationaliser le libellé de tri
    [(#TRIid_parent,’Mon critère de tri’,ajax)] ?

    Merci

    Reply to this message

  • Bonjour,

    En reprenant l’exemple :

    [(#SET{defaut_tri,#ARRAY{
        date,1,
        titre,1   
    }})
    ]

    ...Un tri avec date,-1, me donne le même résultat qu’un tri avec date,1. Il n’y a pas d’inversion. Est-ce normal?

    Reply to this message

  • <th>[(#TRI{id_parent,Type,ajax})]</th> : que se passe t-il quand Bonux est désactivé ou désinstallé ? :-$

    Reply to this message

  • En fait j’ai l’impression que c’est une possibilité des tris pour SPIP3 que tu décris là. Il me semble que le plugin pour spip2 est peu plus simple en ce qu’il ne permet pas de passer un tableau en valeur du critère tri, comme tu le fais dans cet exemple.

    C’est spip3 que tu utilises pour ces exemples ?

    Reply to this message

  • Est ce qu’il est possible de se servir de cela pour faire un tri sur un agenda, par exemple, lorsqu’il y a beaucoup de dates en triant sur les rubriques ou sur des mots clés ?

    Reply to this message

Comment on this article

Who are you?
  • [Log in]

To show your avatar with your message, register it first on gravatar.com (free et painless) and don’t forget to indicate your Email addresse here.

Enter your comment here

This form accepts SPIP shortcuts {{bold}} {italic} -*list [text->url] <quote> <code> and HTML code <q> <del> <ins>. To create paragraphs, just leave empty lines.

Add a document

Follow the comments: RSS 2.0 | Atom