Bonux pour SPIP3

Un grand nombre des fonctionnalités apportées par SPIP Bonux ont été intégrées dans SPIP3, mais il en reste quelques unes qui ne l’ont pas été, et qui constituent le nouveau plugin Bonux pour SPIP3.

Cet article a pour but de lister les balises, critères et fonctions définies dans SPIP Bonux, afin qu’on ne les oublie pas, mais la documentation de ces éléments ne figure pas ici (voir pour cela les autres articles de documentation de Spip Bonux, ou le code source).

Rq : Pour éviter les conflits, certaines de ces fonctionnalités ne sont définies par Bonux que si elles ne sont pas déjà définies par ailleurs.

Balises et critères de boucles

Balises

#SET_PUSH Empile un élément dans un tableau déclaré par #SET{tableau,#ARRAY}
#SET_MERGE
#COMPTEUR
#SOMME
#COMPTE
#MOYENNE
#MINIMUM
#MAXIMUM
#STATS

Les balises #COMPTEUR, #COMPTE, #SOMME, #MOYENNE, #MINIMUM, #MAXIMUM, #STATS requièrent l’usage d’un critère qui spécifie le champ sur lequel porte le calcul de la balise.

Contrairement au critère {compteur table}, ces critères ne calculent pas de jointures.

Exemples d’usage :

-  #SET_PUSH :

#SET_PUSH{tableau,valeur}

Critères statistiques

{compteur}
{compteur_left}
{somme}
{compte}
{moyenne}
{minimum}
{maximum}
{stats}

Exemples d’usage

-  Supposons qu’un champ ’distance’ ait été ajouté aux objets ARTICLE.
La boucle suivante calcule la somme des distances des articles de la rubrique 1 :

<BOUCLE_a(ARTICLES){id_rubrique=1}{somme distance}></BOUCLE_a>
#SOMME{distance}
</B_a>

-  Dans le plugin ’abonnement’ le fichier ’abonnements_stats’ donne plusieurs exemples d’utilisation de ces critères.

Par exemple :

<BOUCLE_nombre(AUTEURS_ELARGIS_ABONNEMENTS){id_abonnement}{statut_paiement=ok}{somme montant}{compte montant}{fusion id_abonnement}>
    <td>#COMPTE{montant}</td>
    <td>[(#SOMME{montant}|number_format{2, ',', ' '}|replace{' ','&nbsp;'})]</td>
</BOUCLE_nombre>

Autre critère

{fusion_supprimer}

 : ce critère supprime de la requête sql la condition GROUP BY qui y est présente à cette étape de la compilation. Ce peut être utile pour s’affranchir d’un GROUP BY ajouté par défaut par le compilateur SPIP lors d’une jointure et qui interfère. Il est ensuite possible d’y ajouter le critère d’une fusion désirée (cf #3209)

Dans la boucle suivante il est nécessaire d’ajouter

{fusion_supprimer}

pour obtenir la fusion sur les dates, car le compilateur ajoute ajoute automatiquement un GOUP BY id_article pour la jointure de la table ARTICLES avec la table MOTS :

<BOUCLE_facette_annee(ARTICLES){id_mot=27}{fusion_supprimer}{fusion YEAR(date)}>
    [(#DATE|annee)]<br />
</BOUCLE_facette_annee>

Fonctions php

Bonux définit aussi tout un ensemble de fonctions qui peuvent servir comme filtre, ou pour d’autres plugins.

/** Récupérer les champs date_$suffixe et heure_$suffixe dans l'environnement, 
vérifier leur cohérence et les reformater */
function verifier_corriger_date_saisie($suffixe,$horaire,&$erreurs);
 
/** Renvoie le charset d'une ligne à importer */
function importer_csv_importcharset($texte);
 
/** Enlève les accents des clés sinon ca pose des problemes ... */
function importer_csv_nettoie_key($key);
 
/** Lit un fichier csv et retourne un tableau 
si $head est true, la premiere ligne est utilisee en header pour générer un tableau associatif*/
function inc_importer_csv_dist($file, $head = false, $delim = ",", $enclos = '"', $len = 10000) ;
 
/** Exporter un champ pour un export CSV */
function exporter_csv_champ($champ) ;
 
/** Exporter une ligne complète au format CSV, avec délimiteur spécifié */
function exporter_csv_ligne($ligne, $delim = ',', $importer_charset = null) ;
 
/** exporter au format CSV. $ressource est un array ou une ressource sql ouverte en lecture */
function inc_exporter_csv_dist($titre, $resource, $delim=',', $entetes = null,$envoyer = true);
 
/** generer une balise img a partir d'un nom de fichier */
function tag_img($img,$alt="",$class="");
 
/** générer une clé temporaire valable 12h pour l'url courante */
function previsu_cle_temporaire($date=null);
 
/** vérifier qu'une clé temporaire valable 12h est bien valable */
function previsu_verifier_cle_temporaire($cle);
 
function _T_ou_typo($valeur, $mode_typo='toujours') ;
 
function spip_array_insert($arr1, $cle, $arr2, $avant=false);
 
function array_replace_recursive($array, $array1);
 
function recurse($array, $array1);
 
/** Coupe une chaine à la longueur demandée, sans abîmer les tags HTML , et avec options : texte de fin si coupé, coupe à la longueur exacte ou en respectant les mots... */
function text_truncate($text, $length = 100, $options = array()) 
 
/** retourner un tableau constitué de toutes les valeurs d'une colonne d'un tableau bi-dimensionnel (avec éventuellement les valeurs d'une autre colonne comme index) */
function array_column($input = null, $columnKey = null, $indexKey = null);

filtre text_truncate

function text_truncate($text, $length = 100, $options = array()); 

Le tableau d’options peut contenir plusieurs couples clé-valeur :
-  ’ending’ => la chaine ajoutée à la fin du texte s’il est coupé. Typiquement, c’est ’...’ ou ’lire la suite’.
-  ’exact’ => un booléen indiquant si la coupe se fait à la longueur indiquée exacte, même si c’est au milieu d’un mot, ou si la coupe se fait juste avant ce dernier mot.
-  ’html’ => un booléen indiquant si le texte contient des tags HTML qu’il faut veiller à ne pas couper incorrectement.

fonction array_column

Charge la fonction array_column de PHP 5.5 pour les versions inférieures.

Lire le détail sur : Array_column pour SPIP

Renommés

-  le filtre |aoustrong a disparu : il est devenu |lien_ou_expose et a été intégré dans SPIP.

Discussion

2 discussions

  • J’ai ajouté la doc du critère {fusion_supprimer}

    Répondre à ce message

  • 1

    Je n’arrive pas à trouver l’archive complète du plugin ??... Sur la Zone de téléchargement, je ne peux télécharger que la version 94288 ??...

    • Tu ne donnes pas les infos qui permettraient de t’aider.
      -  Quelle est la version de ton SPIP ?
      -  Qu’est ce qui ne te convient pas avec la version 94288 ?
      -  Que veux tu au juste ?

    Répondre à ce message

Ajouter un commentaire

Qui êtes-vous ?

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom

Dernière modification de cette page le 24 avril 2018