SPIP Code

Documentation du code de SPIP et de ses plugins

SPIP

filtres_alertes.php

Ce fichier regroupe la gestion des filtres et balises générant le HTML des messages d'alerte.

Table of Contents

Functions

balise_ALERTE_MESSAGE_dist()  : Champ
Compile la balise `#ALERTE_MESSAGE` produisant le HTML d'un message d'alerte complet.
balise_ALERTE_OUVRIR_dist()  : Champ
Compile la balise `#ALERTE_OUVRIR` produisant le HTML ouvrant d'un message d’alerte
balise_ALERTE_FERMER_dist()  : Champ
Compile la balise `#ALERTE_FERMER` produisant le HTML clôturant un message d’alerte
message_alerte()  : string
Générer un message d’alerte
message_alerte_ouvrir()  : string
Ouvrir un message d’alerte
message_alerte_fermer()  : string
Fermer un message d’alerte

Functions

balise_ALERTE_MESSAGE_dist()

Compile la balise `#ALERTE_MESSAGE` produisant le HTML d'un message d'alerte complet.

balise_ALERTE_MESSAGE_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
note

Produit par défaut une alerte avec la classe notice et le role alert, sauf si on passe des chaînes vides en param. Cela permet par exemple de retirer le rôle dans certains cas précis.

balise
example 
#ALERTE_MESSAGE{message[,titre][,classes][,role][,id]}
[(#ALERTE_MESSAGE{<:chaine_langue:>, <:chaine_langue:>, notice, status, mon_alerte})]
Return values
Champ —

Pile complétée par le code à générer

balise_ALERTE_OUVRIR_dist()

Compile la balise `#ALERTE_OUVRIR` produisant le HTML ouvrant d'un message d’alerte

balise_ALERTE_OUVRIR_dist(Champ $p) : Champ

Doit être suivie du texte de l'alerte, puis de la balise #ALERTE_FERMER.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
note

Produit par défaut une alerte avec la classe notice et le role alert, sauf si on passe des chaînes vides en param. Cela permet par exemple de ne pas mettre de rôle dans certains cas précis.

balise
see
balise_ALERTE_FERMER_dist()

Pour clôturer une alerte

example 
#ALERTE_OUVRIR{titre[,classes][,role][,id]}
[(#ALERTE_OUVRIR{<:chaine_langue:>, notice, status, mon_alerte})]
Return values
Champ —

Pile complétée par le code à générer

balise_ALERTE_FERMER_dist()

Compile la balise `#ALERTE_FERMER` produisant le HTML clôturant un message d’alerte

balise_ALERTE_FERMER_dist(Champ $p) : Champ

Doit être précédée du texte de l'alerte et de la balise #ALERTE_OUVRIR.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
see
balise_ALERTE_OUVRIR_dist()

Pour ouvrir une alerte

example 
#ALERTE_FERMER
Return values
Champ —

Pile complétée par le code à générer

message_alerte()

Générer un message d’alerte

message_alerte(string $texte[, string $titre = null ][, string $class = null ][, string $role = null ][, string $id = null ]) : string

Peut-être surchargé par filtre_message_alerte_dist ou filtre_message_alerte

Parameters
$texte : string

Contenu de l'alerte

$titre : string = null

Titre de l'alerte : texte simple, ou autre.

$class : string = null

Classes CSS ajoutées au conteneur Doit contenir le type : notice, error, success, info Défaut = notice (sauf en cas de chaîne vide)

$role : string = null

Attribut role ajouté au conteneur : alert ou status, selon l'importance Défaut = alert (sauf en cas de chaîne vide)

$id : string = null

Identifiant HTML du conteneur

Tags
note

Produit par défaut une alerte avec la classe notice et le rôle alert, sauf si on passe des chaînes vides en param (compat balises). Cela permet par exemple de ne pas mettre de rôle dans certains cas précis.

filtre
see
balise_ALERTE_dist()

qui utilise ce filtre

see
message_alerte_ouvrir()
see
message_alerte_fermer()
Return values
string —

HTML de l'alerte

message_alerte_ouvrir()

Ouvrir un message d’alerte

message_alerte_ouvrir([string $titre = null ][, string $class = null ][, string $role = null ][, string $id = null ]) : string

Peut-être surchargé par filtre_message_alerte_ouvrir_dist ou filtre_message_alerte_ouvrir

Parameters
$titre : string = null

Titre de l'alerte : texte simple, ou autre.

$class : string = null

Classes CSS ajoutées au conteneur Doit contenir le type : notice, error, success, info Défaut = notice (sauf en cas de chaîne vide)

$role : string = null

Attribut role ajouté au conteneur : alert ou status, selon l'importance Défaut = alert (sauf en cas de chaîne vide)

$id : string = null

Identifiant HTML du conteneur

Tags
note

Produit par défaut une alerte avec la classe notice et le role alert, sauf si on passe des chaînes vides en param (compat balises). Cela permet par exemple de ne pas mettre de rôle dans certains cas précis.

filtre
see
balise_ALERTE_OUVRIR_dist()

qui utilise ce filtre

Return values
string —

HTML d'ouverture de l'alerte

message_alerte_fermer()

Fermer un message d’alerte

message_alerte_fermer() : string

Peut-être surchargé par filtre_message_alerte_fermer_dist ou filtre_message_alerte_fermer

Tags
filtre
see
balise_ALERTE_FERMER_dist()

qui utilise ce filtre

Return values
string —

HTML de fin de l'alerte


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results