SPIP Bonux

API Documentation

Constants

_PREVISU_TEMPORAIRE_ACTIVE = \true
_PREVISU_TEMPORAIRE_VALIDITE = 12
_VAR_PREVIEW_EXCEPTION = \true

Functions

verifier_corriger_date_saisie() : int: Recuperer les champs date_xx et heure_xx, verifier leur coherence et les reformater
exporter_csv_champ() : string: Exporter un champ pour un export CSV : pas de retour a la ligne, et echapper les guillements par des doubles guillemets
exporter_csv_champ_no_lf() : string: Exporter un champ pour un export CSV sans retour a la ligne, (qui sont supportees par le standard CSV et LibreOffice, mais pas par Excel)
exporter_csv_ligne_numerotee() : string: Exporter une ligne complete au format CSV, avec delimiteur fourni
exporter_csv_ligne() : string
inc_exporter_csv_dist() : string: Exporte une ressource sous forme de fichier CSV
exporter_xls_preparer_ligne_numerotee() : string: Preparer une ligne avant export XLS : charset si besoin + callback
inc_exporter_xls_dist() : string: Exporte une ressource sous forme de fichier CSV
importer_csv_importcharset() : array<string|int, mixed>: Importer le charset d'une ligne
importer_csv_nettoie_key() : string: enlever les accents des cles presentes dans le head, sinon ca pose des problemes .
inc_importer_csv_dist() : false|array<string|int, mixed>: Lit un fichier csv et retourne un tableau si $head est true, la premiere ligne est utilisee en header pour generer un tableau associatif
balise_SET_PUSH_dist() : Champ: Empile un element dans un tableau declare par #SET{tableau,#ARRAY} #SET_PUSH{tableau,valeur}
balise_SET_MERGE_dist() : Champ: Si 3 arguments : Cree un tableau nom_tableau de t1 + t2 #SET_MERGE{nom_tableau,t1,t2} #SET_MERGE{nom_tableau,#GET{tableau},#ARRAY{cle,valeur}}
balise_COMPTEUR_dist() : Champ: Balise #COMPTEUR associee au critere compteur
balise_SOMME_dist() : mixed: Balise #SOMME associee au critere somme
balise_COMPTE_dist() : mixed: Balise #COMPTE associee au critere compte
balise_MOYENNE_dist() : mixed: Balise #MOYENNE associee au critere moyenne
balise_MINIMUM_dist() : mixed: Balise #MINIMUM associee au critere moyenne
balise_MAXIMUM_dist() : mixed: Balise #MAXIMUM associee au critere moyenne
balise_STATS_dist() : mixed: Balise #STATS associee au critere stats #STATS{id_article,moyenne}
calculer_balise_criteres() : mixed
tag_img() : string: une fonction pour generer une balise img a partir d'un nom de fichier
previsu_verifier_cle_temporaire() : mixed
previsu_cle_temporaire() : mixed
push_table_valeur() : array<string|int, mixed>|object: Filtre ajoutant une valeur à la fin d'une liste, possiblement dans une clé d'un tableau (comme table_valeur()).
filtre_slugify_dist() : string: Filtre slugify
slugify() : string: Fonction slugify
spip_bonux_affichage_final() : mixed
_T_ou_typo() : mixed: une fonction qui regarde si $texte est une chaine de langue de la forme <:qqch:> si oui applique _T() si non applique typo() suivant le mode choisi
spip_array_insert() : mixed
text_truncate() : string: Truncates text.

_PREVISU_TEMPORAIRE_ACTIVE


    public
        mixed
    _PREVISU_TEMPORAIRE_ACTIVE
    = \true

_PREVISU_TEMPORAIRE_VALIDITE


    public
        mixed
    _PREVISU_TEMPORAIRE_VALIDITE
    = 12

_VAR_PREVIEW_EXCEPTION


    public
        mixed
    _VAR_PREVIEW_EXCEPTION
    = \true

verifier_corriger_date_saisie()

Recuperer les champs date_xx et heure_xx, verifier leur coherence et les reformater


    
                    verifier_corriger_date_saisie(string $suffixe, bool $horaire, array<string|int, mixed> &$erreurs) : int

Parameters

$suffixe : string
$horaire : bool
$erreurs : array<string|int, mixed>

Return values

int

exporter_csv_champ()

Exporter un champ pour un export CSV : pas de retour a la ligne, et echapper les guillements par des doubles guillemets


    
                    exporter_csv_champ(string $champ) : string

NB : on supprime les retours lignes qui sont pourtant supportes par le standard CSV et LibreOffice, mais pas par Excel

Parameters

$champ : string

Return values

string

exporter_csv_champ_no_lf()

Exporter un champ pour un export CSV sans retour a la ligne, (qui sont supportees par le standard CSV et LibreOffice, mais pas par Excel)


    
                    exporter_csv_champ_no_lf(string $champ) : string

et echapper les guillements par des doubles guillemets

Parameters

$champ : string

Return values

string

exporter_csv_ligne_numerotee()

Exporter une ligne complete au format CSV, avec delimiteur fourni


    
                    exporter_csv_ligne_numerotee(int $nb, array<string|int, mixed> $ligne[, string $delim = ',' ][, string|null $importer_charset = null ][, callable $callback = null ][, mixed $fonction_exporter_champ = null ]) : string

Parameters

$nb : int
$ligne : array<string|int, mixed>
$delim : string = ','
$importer_charset : string|null = null: Si défini exporte dans le charset indiqué
$callback : callable = null
$fonction_exporter_champ : mixed = null

Return values

string

exporter_csv_ligne()


    
                    exporter_csv_ligne( $ligne[, string $delim = ',' ][, null $importer_charset = null ]) : string

Parameters

$ligne :
$delim : string = ','
$importer_charset : null = null

Return values

string

inc_exporter_csv_dist()

Exporte une ressource sous forme de fichier CSV


    
                    inc_exporter_csv_dist(string $titre, array<string|int, mixed>|resource $resource[, array<string|int, mixed> $options = [] ]) : string

La ressource peut etre un tableau ou une resource SQL issue d'une requete L'extension est choisie en fonction du delimiteur :

si on utilise ',' c'est un vrai csv avec extension csv
si on utilise ';' ou tabulation c'est pour E*cel, et on exporte en iso-truc, avec une extension .xls

Parameters

$titre : string: titre utilise pour nommer le fichier
$resource : array<string|int, mixed>|resource
$options : array<string|int, mixed> = []: string $delim : delimiteur array $entetes : tableau d'en-tetes pour nommer les colonnes (genere la premiere ligne) bool $envoyer : pour envoyer le fichier exporte (permet le telechargement) string $charset : charset de l'export si different de celui du site callable callback : fonction callback a appeler sur chaque ligne pour mettre en forme/completer les donnees

Return values

string

exporter_xls_preparer_ligne_numerotee()

Preparer une ligne avant export XLS : charset si besoin + callback


    
                    exporter_xls_preparer_ligne_numerotee(int $nb, array<string|int, mixed> $ligne[, string|null $importer_charset = null ][, callable $callback = null ]) : string

Parameters

$nb : int
$ligne : array<string|int, mixed>
$importer_charset : string|null = null: Si défini exporte dans le charset indiqué
$callback : callable = null

Return values

string

inc_exporter_xls_dist()

Exporte une ressource sous forme de fichier CSV


    
                    inc_exporter_xls_dist(string $titre, array<string|int, mixed>|resource $resource[, array<string|int, mixed> $options = [] ]) : string

La ressource peut etre un tableau ou une resource SQL issue d'une requete L'extension est choisie en fonction du delimiteur :

si on utilise ',' c'est un vrai csv avec extension csv
si on utilise ';' ou tabulation c'est pour E*cel, et on exporte en iso-truc, avec une extension .xls

Parameters

$titre : string: titre utilise pour nommer le fichier
$resource : array<string|int, mixed>|resource
$options : array<string|int, mixed> = []: array $entetes : tableau d'en-tetes pour nommer les colonnes (genere la premiere ligne) bool $envoyer : pour envoyer le fichier exporte (permet le telechargement) string $charset : charset de l'export si different de celui du site callable callback : fonction callback a appeler sur chaque ligne pour mettre en forme/completer les donnees

Return values

string

importer_csv_importcharset()

Importer le charset d'une ligne


    
                    importer_csv_importcharset(mixed $texte[, bool|string $definir_charset_source = false ]) : array<string|int, mixed>

Importe un texte de CSV dans un charset et le passe dans le charset du site (utf8 probablement) Les CSV peuvent sous ms@@@ avoir le charset 'iso-8859-1', mais pasfois aussi 'windows-1252' :/

Parameters

$texte : mixed
$definir_charset_source : bool|string = false: false : ne fait rien string : utilisera pour les prochains imports le charset indiqué true : remet le charset d'import par défaut de la fonction

Return values

array<string|int, mixed>

importer_csv_nettoie_key()

enlever les accents des cles presentes dans le head, sinon ca pose des problemes .


    
                    importer_csv_nettoie_key(string $key) : string

Parameters

$key : string

Return values

string

inc_importer_csv_dist()

Lit un fichier csv et retourne un tableau si $head est true, la premiere ligne est utilisee en header pour generer un tableau associatif


    
                    inc_importer_csv_dist(string $file[, array<string|int, mixed> $options = [] ]) : false|array<string|int, mixed>

Parameters

$file : string
$options : array<string|int, mixed> = []: bool $head string $delim string $enclos int $len string $charset_source : Permet de définir un charset source du CSV, si différent de utf-8 ou iso-8859-1

Return values

false|array<string|int, mixed>

balise_SET_PUSH_dist()

Empile un element dans un tableau declare par #SET{tableau,#ARRAY} #SET_PUSH{tableau,valeur}


    
                    balise_SET_PUSH_dist(Champ $p) : Champ

Parameters

$p : Champ: : objet balise

Return values

Champ —

La balise ne retourne rien ("")

balise_SET_MERGE_dist()

Si 3 arguments : Cree un tableau nom_tableau de t1 + t2 #SET_MERGE{nom_tableau,t1,t2} #SET_MERGE{nom_tableau,#GET{tableau},#ARRAY{cle,valeur}}


    
                    balise_SET_MERGE_dist(Champ $p) : Champ

Si 2 arguments : Merge t1 dans nom_tableau #SET_MERGE{nom_tableau,t1} #SET_MERGE{nom_tableau,#GET{tableau}}

Parameters

$p : Champ: : objet balise

Return values

Champ —

La balise ne retourne rien ("")

balise_COMPTEUR_dist()

Balise #COMPTEUR associee au critere compteur


    
                    balise_COMPTEUR_dist(Champ $p) : Champ

Parameters

$p : Champ

Return values

Champ

balise_SOMME_dist()

Balise #SOMME associee au critere somme


    
                    balise_SOMME_dist(mixed $p) : mixed

Parameters

$p : mixed

balise_COMPTE_dist()

Balise #COMPTE associee au critere compte


    
                    balise_COMPTE_dist(mixed $p) : mixed

Parameters

$p : mixed

balise_MOYENNE_dist()

Balise #MOYENNE associee au critere moyenne


    
                    balise_MOYENNE_dist(mixed $p) : mixed

Parameters

$p : mixed

balise_MINIMUM_dist()

Balise #MINIMUM associee au critere moyenne


    
                    balise_MINIMUM_dist(mixed $p) : mixed

Parameters

$p : mixed

balise_MAXIMUM_dist()

Balise #MAXIMUM associee au critere moyenne


    
                    balise_MAXIMUM_dist(mixed $p) : mixed

Parameters

$p : mixed

balise_STATS_dist()

Balise #STATS associee au critere stats #STATS{id_article,moyenne}


    
                    balise_STATS_dist(mixed $p) : mixed

Parameters

$p : mixed

calculer_balise_criteres()


    
                    calculer_balise_criteres(mixed $nom, mixed $p[, mixed $motif = '' ]) : mixed

Parameters

$nom : mixed
$p : mixed
$motif : mixed = ''

tag_img()

une fonction pour generer une balise img a partir d'un nom de fichier


    
                    tag_img(string $img[, string $alt = '' ][, string $class = '' ]) : string

Parameters

$img : string
$alt : string = ''
$class : string = ''

Return values

string

previsu_verifier_cle_temporaire()


    
                    previsu_verifier_cle_temporaire(mixed $cle) : mixed

Parameters

$cle : mixed

previsu_cle_temporaire()


    
                    previsu_cle_temporaire([mixed $date = null ]) : mixed

Parameters

$date : mixed = null

push_table_valeur()

Filtre ajoutant une valeur à la fin d'une liste, possiblement dans une clé d'un tableau (comme table_valeur()).


    
                    push_table_valeur(array<string|int, mixed>|object|string $table, string $chemin, mixed $valeur[, mixed $condition = true ][, string $cle_finale = false ]) : array<string|int, mixed>|object

Attention, cette fonction est bien un "push", c'est-à-dire qu'elle ajoute un élément à la fin d'une liste.

#TABLEAU|push_table_valeur{a/b/c, valeur, #CONDITION}

si la clé "c" est une liste : on ajoute "valeur" à la fin
si la clé "c" n'existe pas : on crée une liste et on met la première valeur dedans
si la clé "c" est un scalaire : on ne fait rien
si les clés autres que la dernière n'existent pas : on en fait des tableaux en cascade

Parameters

$table : array<string|int, mixed>|object|string: Table ou objet dont on veut modifier ou augmenter une des clés/propriétés. Peut être une chaîne à désérialiser contenant ce tableau ou cet objet.
$chemin : string: Une suite de clés ou de propriétés d'objet, séparées par le caractère "/" : un/element/ici
$valeur : mixed: Une valeur à ajouter au paramètre précédent.
$condition : mixed = true: =true Une valeur quelconque qui sera testée de manière booléenne pour savoir si on fait le traitement ou pas. Cela allège l'écriture si l'ajout de valeur ne doit se faire que sous condition, notamment que s'il y a une valeur à ajouter.
$cle_finale : string = false: Une clé dans laquelle placer la valeur si précisée

Return values

array<string|int, mixed>|object —

Retourne le tableau ou l'objet initial, modifié suivant les paramètres.

filtre_slugify_dist()

Filtre slugify


    
                    filtre_slugify_dist(string $texte[, string $type = '' ][, array<string|int, mixed> $options = [] ]) : string

Parameters

$texte : string
$type : string = ''
$options : array<string|int, mixed> = []

Return values

string

slugify()

Fonction slugify


    
                    slugify(string $texte[, string $type = '' ][, array<string|int, mixed> $options = [] ]) : string

Parameters

$texte : string
$type : string = ''
$options : array<string|int, mixed> = []

Return values

string

spip_bonux_affichage_final()


    
                    spip_bonux_affichage_final(mixed $flux) : mixed

Parameters

$flux : mixed

_T_ou_typo()

une fonction qui regarde si $texte est une chaine de langue de la forme <:qqch:> si oui applique _T() si non applique typo() suivant le mode choisi


    
                    _T_ou_typo(mixed $valeur[, string $mode_typo = 'toujours' ][, mixed $connect = null ][, mixed $env = [] ]) : mixed

Parameters

$valeur : mixed: Une valeur à tester. Si c'est un tableau, la fonction s'appliquera récursivement dessus.
$mode_typo : string = 'toujours': Le mode d'application de la fonction typo(), avec trois valeurs possibles "toujours", "jamais" ou "multi".
$connect : mixed = null
$env : mixed = []

Return values

mixed —

Retourne la valeur éventuellement modifiée.

spip_array_insert()


    
                    spip_array_insert(mixed $arr1, mixed $cle, mixed $arr2[, mixed $avant = false ]) : mixed

Parameters

$arr1 : mixed
$cle : mixed
$arr2 : mixed
$avant : mixed = false

text_truncate()

Truncates text.


    
                    text_truncate(string $text[, int $length = 100 ][, array<string|int, mixed> $options = [] ]) : string

Cuts a string to the length of $length and replaces the last characters with the ending if the text is longer than length.

Options:

ending Will be used as Ending and appended to the trimmed string
exact If false, $text will not be cut mid-word
html If true, HTML tags would be handled correctly

Parameters

$text : string: String to truncate.
$length : int = 100: Length of returned string, including ellipsis.
$options : array<string|int, mixed> = []: An array of html attributes and options.

Return values

string —

Trimmed string.

API Documentation

Table of Contents

Constants

Functions

Constants

_PREVISU_TEMPORAIRE_ACTIVE

_PREVISU_TEMPORAIRE_VALIDITE

_VAR_PREVIEW_EXCEPTION

Functions

verifier_corriger_date_saisie()

Parameters

Return values

exporter_csv_champ()

Parameters

Return values

exporter_csv_champ_no_lf()

Parameters

Return values

exporter_csv_ligne_numerotee()

Parameters

Tags

Return values

exporter_csv_ligne()

Parameters

Tags

Return values

inc_exporter_csv_dist()

Parameters

Tags

Return values

exporter_xls_preparer_ligne_numerotee()

Parameters

Return values

inc_exporter_xls_dist()

Parameters

Tags

Return values

importer_csv_importcharset()

Parameters

Return values

importer_csv_nettoie_key()

Parameters

Return values

inc_importer_csv_dist()

Parameters

Return values

balise_SET_PUSH_dist()

Parameters

Return values

balise_SET_MERGE_dist()

Parameters

Return values

balise_COMPTEUR_dist()

Parameters

Return values

balise_SOMME_dist()

Parameters

balise_COMPTE_dist()

Parameters

balise_MOYENNE_dist()

Parameters

balise_MINIMUM_dist()

Parameters

balise_MAXIMUM_dist()

Parameters

balise_STATS_dist()

Parameters

calculer_balise_criteres()

Parameters

tag_img()

Parameters

Return values

previsu_verifier_cle_temporaire()

Parameters

previsu_cle_temporaire()

Parameters

push_table_valeur()

Parameters

Tags

Return values