ezcheck_dashboard.php
Ce fichier contient l'API de gestion des dashboards.
Table of Contents
Functions
- dashboard_charger() : bool
- Charge ou recharge la configuration des dashboards à partir de leur fichier YAML ou JSON et du pipeline `eztypecontrole_declarer`.
- dashboard_lire() : array<string, mixed>
- Retourne la description complète du dashboard.
- dashboard_repertorier() : array<string, mixed>
- Renvoie l'information brute demandée pour l'ensemble des dashboards utilisés ou toute les descriptions si aucune information n'est explicitement demandée.
- dashboard_contextualiser() : array<string, mixed>
- Renvoie la configuration complète d’un dashboard ainsi que des informations supplémentaires provenant de l'environnement de la page dashboard (groupe et type de contrôle à afficher par défaut).
Functions
dashboard_charger()
Charge ou recharge la configuration des dashboards à partir de leur fichier YAML ou JSON et du pipeline `eztypecontrole_declarer`.
dashboard_charger() : bool
La fonction compile les dashboards dans un cache unique sécurisé. Etant donné que le nombre de dashboards est en général assez faible, l'ensemble du cache est systématiquement recalculé.
Tags
Return values
bool —false si une erreur s'est produite, true sinon.
dashboard_lire()
Retourne la description complète du dashboard.
dashboard_lire(string $id_dashboard[, null|bool $traiter_typo = false ]) : array<string, mixed>
Les champs textuels peuvent subir un traitement typo si demandé.
Parameters
- $id_dashboard : string
-
Identifiant du dashboard.
- $traiter_typo : null|bool = false
-
Indique si les données textuelles doivent être retournées brutes ou si elles doivent être traitées en utilisant la fonction typo.
Tags
Return values
array<string, mixed> —La description complète. Si demandé, les champs textuels peuvent être traités avec la fonction typo().
dashboard_repertorier()
Renvoie l'information brute demandée pour l'ensemble des dashboards utilisés ou toute les descriptions si aucune information n'est explicitement demandée.
dashboard_repertorier([null|string $information = '' ]) : array<string, mixed>
Parameters
- $information : null|string = ''
-
Identifiant d'un champ de la description d'un dashboard. Si l'argument est vide, la fonction renvoie les descriptions complètes et si l'argument est un champ invalide la fonction renvoie un tableau vide.
Tags
Return values
array<string, mixed> —Tableau de la forme [dashboard] = information ou description complète. Les champs textuels
sont retournés en l'état, le timestamp maj n'est pas fourni.
dashboard_contextualiser()
Renvoie la configuration complète d’un dashboard ainsi que des informations supplémentaires provenant de l'environnement de la page dashboard (groupe et type de contrôle à afficher par défaut).
dashboard_contextualiser(string $id_dashboard[, null|string $id_groupe = '' ][, null|string $type_controle = '' ]) : array<string, mixed>
Parameters
- $id_dashboard : string
-
Identifiant du dashboard
- $id_groupe : null|string = ''
-
Identifiant du groupe affiché par défaut ou vide pour afficher le premier
- $type_controle : null|string = ''
-
Identifiant du type de contrôle affiché par défaut ou vide pour afficher le premier
Tags
Return values
array<string, mixed> —Tableau du contexte contenant la description du dashboard