SPIP Code

Documentation du code de SPIP et de ses plugins

Check Factory

ezcheck_fonctions.php

Ce fichier contient les filtres et les balises du plugin.

Table of Contents

Functions

balise_DASHBOARD_dist()  : Champ
Compile la balise `#DASHBOARD` qui fournit la configuration complète d'un dashboard ou de tous les dashboards.
balise_DASHBOARD_CONTEXTE_dist()  : Champ
Compile la balise `#DASHBOARD_CONTEXTE` qui fournit la configuration complète d'un dashboard ainsi que des informations supplémentaires provenant de l'environnement de la page dashboard.
balise_TYPE_CONTROLE_DASHBOARD_dist()  : Champ
Compile la balise `#TYPE_CONTROLE_DASHBOARD` qui renvoie l'identifiant du dashboard auquel le type de contrôle est rattaché.
balise_TYPE_CONTROLE_GROUPE_dist()  : Champ
Compile la balise `#TYPE_CONTROLE_GROUPE` qui renvoie l'identifiant du dashboard auquel le type de contrôle est rattaché.
generer_titre_controle()  : string
Construit le titre d'un contrôle.
generer_titre_observation()  : string
Construit le titre d'une observation.
parametre_preparer_pour_env()  : mixed
Passe la fonction `typo()` si la valeur du paramètre est un idiome, sinon ne rien faire.

Functions

balise_DASHBOARD_dist()

Compile la balise `#DASHBOARD` qui fournit la configuration complète d'un dashboard ou de tous les dashboards.

balise_DASHBOARD_dist(Champ $p) : Champ

La signature de la balise est : #DASHBOARD{dashboard_id}.

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
example 
#DASHBOARD{contrib}, renvoie la description complète du dashboard d'id `contrib`
#DASHBOARD, renvoie la description de tous les dashboards
Return values
Champ —

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

balise_DASHBOARD_CONTEXTE_dist()

Compile la balise `#DASHBOARD_CONTEXTE` qui fournit la configuration complète d'un dashboard ainsi que des informations supplémentaires provenant de l'environnement de la page dashboard.

balise_DASHBOARD_CONTEXTE_dist(Champ $p) : Champ

La signature de la balise est : #DASHBOARD_CONTEXTE{dashboard_id, groupe_id, type_controle}.

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
example 
#DASHBOARD_CONTEXTE{contrib, '', ''}, renvoie la description complète du dashboard d'id `contrib` ainsi que
l'id du premier groupe et le premier type de contrôle listé dans le groupe.
#DASHBOARD_CONTEXTE{contrib, article, ''}, renvoie la description complète du dashboard d'id `contrib` ainsi que
l'id du groupe précisé et le premier type de contrôle listé dans le groupe.
#DASHBOARD_CONTEXTE{contrib, 'article', 'article_prepa'}, renvoie la description complète du dashboard d'id `contrib` ainsi que
l'id du groupe et du type de contrôle précisés.
Return values
Champ —

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

balise_TYPE_CONTROLE_DASHBOARD_dist()

Compile la balise `#TYPE_CONTROLE_DASHBOARD` qui renvoie l'identifiant du dashboard auquel le type de contrôle est rattaché.

balise_TYPE_CONTROLE_DASHBOARD_dist(Champ $p) : Champ

La signature de la balise est : #TYPE_CONTROLE_DASHBOARD{identifiant_type_controle}.

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
Return values
Champ —

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

balise_TYPE_CONTROLE_GROUPE_dist()

Compile la balise `#TYPE_CONTROLE_GROUPE` qui renvoie l'identifiant du dashboard auquel le type de contrôle est rattaché.

balise_TYPE_CONTROLE_GROUPE_dist(Champ $p) : Champ

La signature de la balise est : #TYPE_CONTROLE_GROUPE{identifiant_type_controle}.

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
Return values
Champ —

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

generer_titre_controle()

Construit le titre d'un contrôle.

generer_titre_controle(int $id_objet, array<string, mixed> $champs) : string
Parameters
$id_objet : int

Identifiant du contrôle

$champs : array<string, mixed>

Liste des champs de l'objet concerné

Return values
string

generer_titre_observation()

Construit le titre d'une observation.

generer_titre_observation(int $id_objet, array<string, mixed> $champs) : string
Parameters
$id_objet : int

Identifiant de l'observation

$champs : array<string, mixed>

Liste des champs de l'objet concerné

Return values
string

parametre_preparer_pour_env()

Passe la fonction `typo()` si la valeur du paramètre est un idiome, sinon ne rien faire.

parametre_preparer_pour_env(mixed $valeur) : mixed

Cette fonction est nécessaire pour passer le paramètre dans l'environnement.

Parameters
$valeur : mixed

Chaine représentant une valeur à afficher

Return values
mixed —

Chaine à afficher


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results