SPIP Code

Documentation du code de SPIP et de ses plugins

Check Factory

Application

Table of Contents

Functions

action_cloturer_observation_dist()  : void
Cette action permet à l'utilisateur de corriger ou d'acquitter de façon sécurisée une anomalie ou, de supprimer toute observation déjà fermée.
action_cloturer_observations_dist()  : void
Cette action permet à l'utilisateur, de façon sécurisée, de passer à l'état poubelle toutes les observations ou les anomalies fermées d'un type de contrôle ou d'acquitter ou de corriger toutes les anomélies ouvertes d'un type de contrôle.
action_executer_type_controle_dist()  : void
Cette action permet à l'utilisateur d'exécuter, de façon sécurisée, les vérifications inhérentes au type de contrôle.
action_inverser_activite_type_controle_dist()  : void
Cette action permet à l'utilisateur d'activer ou de désactiver, de façon sécurisée, un type de contrôle donné.
action_recharger_dashboards_dist()  : void
Cette action permet à l'utilisateur de recharger dans un cache, de façon sécurisée, les dashboards à partir de leur fichier JSON ou YAML.
action_recharger_types_controle_dist()  : void
Cette action permet à l'utilisateur de recharger en base de données, de façon sécurisée, les types de contrôle à partir de leur fichier YAML.
ezcheck_declarer_tables_principales()  : array<string|int, mixed>
Déclaration des nouvelles tables de la base de données propres au plugin et ne correspondant pas à un objet.
ezcheck_declarer_tables_objets_sql()  : array<string|int, mixed>
Déclaration des objets nécessaires au plugin.
ezcheck_declarer_tables_interfaces()  : array<string|int, mixed>
Déclaration des informations tierces (alias, traitements, jointures, etc) sur les tables de la base de données modifiées ou ajoutées par le plugin.
ezcheck_cache_configurer()  : array<string, mixed>
Renvoie la configuration spécifique des caches de Check Factory.
ezcheck_upgrade()  : void
Installation du schéma de données propre au plugin et gestion des migrations suivant les évolutions du schéma.
ezcheck_vider_tables()  : void
Suppression de l'ensemble du schéma de données propre au plugin, c'est-à-dire les tables et les variables de configuration.
ezcheck_autoriser()  : mixed
Fonction appelée par le pipeline.
autoriser_ezcheck_dist()  : bool
Autorisation minimale d'accès à toutes les pages du plugin Check Factory sauf celle de configuration du plugin lui-même (controles, dashboard).
autoriser_ezcheck_menu_dist()  : bool
Autorisation d'affichage du menu d'accès aux dashboards (page=ezcheck).
autoriser_ezcheck_configurer_dist()  : bool
Autorisation d'accès à la page de configuration du plugin Check Factory (page=configurer_ezcheck).
autoriser_dashboard_voir_dist()  : bool
Autorisation d'afficher la page d'un dashboard donné. A partir de cette page il est possible de visualiser les contrôles et les anomalies, d'exécuter un contrôle manuellement, lancer une action corrective.
autoriser_typecontrole_modifier_dist()  : bool
Autorisation d'activation et de désactivation des types de contrôle.
autoriser_typecontrole_executer_dist()  : bool
Autorisation d'exécution d'un type de contrôle.
autoriser_typecontrole_cloturer_dist()  : bool
Autorisation de cloture ou de mise à la poubelle des observations fermées d'un type de contrôle.
autoriser_observation_instituer_dist()  : bool
Autorisation de changement de statut d'une observation.
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.
ezcheck_affiche_milieu()  : array<string|int, mixed>
Ajouter du contenu au centre de la page sur les pages privées.
formulaires_parametrer_controle_charger_dist()  : array<string|int, mixed>
Chargement des données du formaulaire : le formulaire permet d'afficher le descriptif du type de contrôle et d'éventuellement saisir des paramètres pour lancer la fonction de vérification.
formulaires_parametrer_controle_verifier_dist()  : array<string|int, mixed>
Vérification du formulaire : on lance les contrôles des saisies qui intègrent des vérifications.
formulaires_parametrer_controle_traiter_dist()  : array<string, mixed>
Exécution du formulaire : si le bouton d'exécution est affiché lancement de l'exécution de la vérification et affichage des résultats.
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).
observation_ajouter()  : int
Ajoute une observation à la table `spip_observations`.
observation_repertorier()  : array<string|int, mixed>
Renvoie l'information brute demandée pour l'ensemble des observations ou toute les descriptions si aucun champ n'est explicitement demandé.
observation_cloturer()  : bool
Effectue les traitements adéquats pour clore une observation : acquitte une anomalie, corrige une anomalie ou supprime une observation.
type_controle_charger()  : bool
Charge ou recharge les descriptions des types de contrôle à partir des fichiers YAML et du pipeline `eztypecontrole_declarer`.
type_controle_lire()  : array<string|int, mixed>|bool|int|string
Retourne la description complète ou une liste de champs d'un type de contrôle donné.
type_controle_repertorier()  : array<string, mixed>
Renvoie l'information brute demandée pour l'ensemble des contrôles utilisés ou toutes les descriptions si aucune information n'est explicitement demandée.
type_controle_executer()  : bool
Exécute une fonction d'un type de contrôle donné.
type_controle_identifier_liaison()  : string
Renvoie l'identifiant du dashboard auquel est rattaché le type contrôle.

Functions

action_cloturer_observation_dist()

Cette action permet à l'utilisateur de corriger ou d'acquitter de façon sécurisée une anomalie ou, de supprimer toute observation déjà fermée.

action_cloturer_observation_dist([null|string $arguments = null ]) : void

Cette action est réservée aux utilisateurs pouvant instituer une observation. Elle nécessite l'action proprement dite, à savoir, acquitter, corriger ou supprimer, l'id de l'observation et celui de l'auteur.

Parameters
$arguments : null|string = null

Arguments de l'action ou null si l'action est appelée par une URL

Tags
uses
observation_cloturer()

action_cloturer_observations_dist()

Cette action permet à l'utilisateur, de façon sécurisée, de passer à l'état poubelle toutes les observations ou les anomalies fermées d'un type de contrôle ou d'acquitter ou de corriger toutes les anomélies ouvertes d'un type de contrôle.

action_cloturer_observations_dist([null|string $arguments = null ]) : void

Cette action est réservée aux utilisateurs pouvant cloturer les observations d'un type de contrôle. Elle nécessite l'action requise, l'identifiant du type de contrôle, l'indicateur d'anomalie (oui/non) et l'id de l'auteur.

Parameters
$arguments : null|string = null

Arguments de l'action ou null si l'action est appelée par une URL

Tags
uses
observation_repertorier()
uses
observation_cloturer()

action_executer_type_controle_dist()

Cette action permet à l'utilisateur d'exécuter, de façon sécurisée, les vérifications inhérentes au type de contrôle.

action_executer_type_controle_dist([null|string $arguments = null ]) : void
Parameters
$arguments : null|string = null

Arguments de l'action ou null si l'action est appelée par une URL

Tags
uses
type_controle_executer()

Cette action est réservée aux utilisateurs pouvant exécuter un contrôle. Elle nécessite le type de contrôle et l'id de l'auteur comme arguments. Quand elle est appelée via un formulaire de choix de paramètres additionnels à fournir à la fonction de contrôle elle possède un argument options supplémentaires.

action_inverser_activite_type_controle_dist()

Cette action permet à l'utilisateur d'activer ou de désactiver, de façon sécurisée, un type de contrôle donné.

action_inverser_activite_type_controle_dist([null|string $arguments = null ]) : void

Cette action est réservée aux utilisateurs pouvant modifier un type de contrôle. Elle nécessite l'identifiant du type de contrôle et son indicateur d'activité.

Parameters
$arguments : null|string = null

Arguments de l'action ou null si l'action est appelée par une URL

action_recharger_dashboards_dist()

Cette action permet à l'utilisateur de recharger dans un cache, de façon sécurisée, les dashboards à partir de leur fichier JSON ou YAML.

action_recharger_dashboards_dist() : void

Cette action est réservée aux utilisateurs pouvant utiliser le plugin Check Factory. Elle ne nécessite aucun argument.

Tags
uses
dashboard_charger()

action_recharger_types_controle_dist()

Cette action permet à l'utilisateur de recharger en base de données, de façon sécurisée, les types de contrôle à partir de leur fichier YAML.

action_recharger_types_controle_dist() : void

Cette action est réservée aux utilisateurs pouvant utiliser le plugin Check Factory. Elle ne nécessite aucun argument.

Tags
uses
type_controle_charger()

ezcheck_declarer_tables_principales()

Déclaration des nouvelles tables de la base de données propres au plugin et ne correspondant pas à un objet.

ezcheck_declarer_tables_principales(array<string|int, mixed> $tables_principales) : array<string|int, mixed>

Le plugin déclare une nouvelle table de ce type :

  • spip_types_controles, qui contient les éléments descriptifs des types de contrôles disponibles
Parameters
$tables_principales : array<string|int, mixed>

Tableau global décrivant la structure des tables de la base de données

Tags
pipeline

declarer_tables_principales

Return values
array<string|int, mixed> —

Tableau fourni en entrée et mis à jour avec les nouvelles déclarations

ezcheck_declarer_tables_objets_sql()

Déclaration des objets nécessaires au plugin.

ezcheck_declarer_tables_objets_sql(array<string|int, mixed> $tables_objet_sql) : array<string|int, mixed>

Le plugin ajoute :

  • l'objet contrôle qui correspond à une fonction lancée périodiquement ou à la demande. Un contrôle est une instance d'un type de contrôle.
  • l'objet observation, qui résulte des contrôles.
Parameters
$tables_objet_sql : array<string|int, mixed>

Description des tables de la base.

Tags
pipeline

declarer_tables_objets_sql

Return values
array<string|int, mixed> —

Description des tables de la base complétée par celles du plugin.

ezcheck_declarer_tables_interfaces()

Déclaration des informations tierces (alias, traitements, jointures, etc) sur les tables de la base de données modifiées ou ajoutées par le plugin.

ezcheck_declarer_tables_interfaces(array<string|int, mixed> $interface) : array<string|int, mixed>

Le plugin se contente de déclarer les alias des tables et quelques traitements.

Parameters
$interface : array<string|int, mixed>

Tableau global des informations tierces sur les tables de la base de données

Tags
pipeline

declarer_tables_interfaces

Return values
array<string|int, mixed> —

Tableau fourni en entrée et mis à jour avec les nouvelles informations

ezcheck_cache_configurer()

Renvoie la configuration spécifique des caches de Check Factory.

ezcheck_cache_configurer(string $plugin) : array<string, mixed>
Parameters
$plugin : string

Préfixe du plugin, à savoir, ezcheck.

Return values
array<string, mixed> —

Tableau de la configuration brute du plugin Check Factory.

ezcheck_upgrade()

Installation du schéma de données propre au plugin et gestion des migrations suivant les évolutions du schéma.

ezcheck_upgrade(string $nom_meta_base_version, string $version_cible) : void

Le schéma comprend des tables et des variables de configuration.

Parameters
$nom_meta_base_version : string

Nom de la meta dans laquelle sera rangée la version du schéma

$version_cible : string

Version du schéma de données en fin d'upgrade

ezcheck_vider_tables()

Suppression de l'ensemble du schéma de données propre au plugin, c'est-à-dire les tables et les variables de configuration.

ezcheck_vider_tables(string $nom_meta_base_version) : void
Parameters
$nom_meta_base_version : string

Nom de la meta dans laquelle sera rangée la version du schéma

autoriser_ezcheck_dist()

Autorisation minimale d'accès à toutes les pages du plugin Check Factory sauf celle de configuration du plugin lui-même (controles, dashboard).

autoriser_ezcheck_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Par défaut, seuls les administrateurs complets sont autorisés à utiliser ces pages. Cette autorisation est à la base de la plupart des autres autorisations du plugin.

Parameters
$faire : string

L'action : ezcheck

$type : string

Le type d'objet ou nom de table : chaine vide

$id : int

Id de l'objet sur lequel on veut agir : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values
bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_ezcheck_menu_dist()

Autorisation d'affichage du menu d'accès aux dashboards (page=ezcheck).

autoriser_ezcheck_menu_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut être autorisé à utiliser ezcheck.

Parameters
$faire : string

L'action : menu

$type : string

Le type d'objet ou nom de table : ezcheck (ce n'est pas un objet au sens SPIP)

$id : int

Id de l'objet sur lequel on veut agir : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values
bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_ezcheck_configurer_dist()

Autorisation d'accès à la page de configuration du plugin Check Factory (page=configurer_ezcheck).

autoriser_ezcheck_configurer_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut être autorisé :

  • à utiliser le plugin
  • et avoir l'autorisation stabdard de configuration.
Parameters
$faire : string

L'action : configurer

$type : string

Le type d'objet ou nom de table : ezcheck (ce n'est pas un objet au sens SPIP)

$id : int

Id de l'objet sur lequel on veut agir : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values
bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_dashboard_voir_dist()

Autorisation d'afficher la page d'un dashboard donné. A partir de cette page il est possible de visualiser les contrôles et les anomalies, d'exécuter un contrôle manuellement, lancer une action corrective.

autoriser_dashboard_voir_dist(string $faire, string $type, int|string $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool
  • être autorisé à utiliser Check Factory,
  • que l'identifiant du dashboard soit connu.
Parameters
$faire : string

L'action : voir

$type : string

Le type d'objet ou nom de table : dashboard (ce n'est pas un objet au sens SPIP)

$id : int|string

Id de l'objet sur lequel on veut agir : identifiant du dashboard sous forme d'une chaine. C'est un détournement de l'utilisation habituelle pour un objet.

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values
bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_typecontrole_modifier_dist()

Autorisation d'activation et de désactivation des types de contrôle.

autoriser_typecontrole_modifier_dist(string $faire, string $type, int|string $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut :

  • être autorisé à configurer Check Factory
  • que le type de contrôle soit bien chargé
  • et qu'il ne soit pas un état.
Parameters
$faire : string

L'action : modifier

$type : string

Le type d'objet ou nom de table : typecontrole (ce n'est pas un objet au sens SPIP)

$id : int|string

Id de l'objet sur lequel on veut agir : identifiant du type de contrôle sous forme d'une chaine. C'est un détournement de l'utilisation habituelle pour un objet.

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values
bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_typecontrole_executer_dist()

Autorisation d'exécution d'un type de contrôle.

autoriser_typecontrole_executer_dist(string $faire, string $type, int|string $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut :

  • être autorisé à utiliser Check Factory
  • que le type de contrôle soit bien chargé, actif et que ce ne soit pas un état
  • et que soit la fonction de contrôle existe.
Parameters
$faire : string

L'action : executer

$type : string

Le type d'objet ou nom de table : typecontrole (ce n'est pas un objet au sens SPIP)

$id : int|string

Id de l'objet sur lequel on veut agir : identifiant du type de contrôle sous forme d'une chaine. C'est un détournement de l'utilisation habituelle pour un objet.

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values
bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_typecontrole_cloturer_dist()

Autorisation de cloture ou de mise à la poubelle des observations fermées d'un type de contrôle.

autoriser_typecontrole_cloturer_dist(string $faire, string $type, int|string $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut :

  • être autorisé à exécuter le type de contrôle.
Parameters
$faire : string

L'action : cloturer

$type : string

Le type d'objet ou nom de table : typecontrole (ce n'est pas un objet au sens SPIP)

$id : int|string

Id de l'objet sur lequel on veut agir : identifiant du type de contrôle sous forme d'une chaine. C'est un détournement de l'utilisation habituelle pour un objet.

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : action, action de cloture parmi acquitter, corriger ou supprimer

Return values
bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_observation_instituer_dist()

Autorisation de changement de statut d'une observation.

autoriser_observation_instituer_dist(string $faire, string $type, int|string $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut :

  • être autorisé à utiliser Check Factory,
  • que l'observation existe,
  • que l'action soit fournie et corresponde à corriger, acquitter ou supprimer.
Parameters
$faire : string

L'action : instituer

$type : string

Le type d'objet ou nom de table : observation

$id : int|string

Id de l'objet sur lequel on veut agir : identifiant numérique de l'observation.

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : index action qui mène au changement de statut.

Return values
bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

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

ezcheck_affiche_milieu()

Ajouter du contenu au centre de la page sur les pages privées.

ezcheck_affiche_milieu(array<string|int, mixed> $flux) : array<string|int, mixed>

Page d'adminisration des plugins :

  • on recharge les types de contrôle.
  • on recharge les dashboards
Parameters
$flux : array<string|int, mixed>

Flux d'entrée contenant la chaine affichée

Tags
uses
type_controle_charger()
uses
dashboard_charger()
Return values
array<string|int, mixed> —

Flux complétée par Check Factory

formulaires_parametrer_controle_charger_dist()

Chargement des données du formaulaire : le formulaire permet d'afficher le descriptif du type de contrôle et d'éventuellement saisir des paramètres pour lancer la fonction de vérification.

formulaires_parametrer_controle_charger_dist(string $type_controle[, null|int $id_auteur = 0 ][, null|string $redirect = '' ]) : array<string|int, mixed>
Parameters
$type_controle : string

Identifiant du type de contrôle

$id_auteur : null|int = 0

Id de l'auteur ou 0 sinon

$redirect : null|string = ''

URL de la page à afficher suite à l'exécution du formulaire ou vide pour rester sur la même page

Tags
uses
type_controle_lire()
uses
observation_repertorier()
@return

<string, mixed> Tableau des données à charger par le formulaire (affichage et saisie) : - _description : (affichage) descriptif du type de contrôle - _message_inactif : (affichage) message éventuel expliquant l'inactivité du contrôle - _champs_fonction : (saisie) liste des saisies pour les paramètres de la fonction de vérification - _champs_squelette : (saisie) liste des saisies pour les paramètres d'affichage du squelette complémentaire - _bouton_execution : (affichage) indique si le bouton d'exécution doit être affiché ou pas

Return values
array<string|int, mixed>

formulaires_parametrer_controle_verifier_dist()

Vérification du formulaire : on lance les contrôles des saisies qui intègrent des vérifications.

formulaires_parametrer_controle_verifier_dist(string $type_controle[, null|int $id_auteur = 0 ][, null|string $redirect = '' ]) : array<string|int, mixed>
Parameters
$type_controle : string

Identifiant du type de contrôle

$id_auteur : null|int = 0

Id de l'auteur ou 0 sinon

$redirect : null|string = ''

URL de la page à afficher suite à l'exécution du formulaire ou vide pour rester sur la même page

Tags
uses
type_controle_lire()
uses
saisies_verifier()
@return

<string, mixed> Tableau des erreurs indexé par les noms des champs en erreur

Return values
array<string|int, mixed>

formulaires_parametrer_controle_traiter_dist()

Exécution du formulaire : si le bouton d'exécution est affiché lancement de l'exécution de la vérification et affichage des résultats.

formulaires_parametrer_controle_traiter_dist(string $type_controle[, null|int $id_auteur = 0 ][, null|string $redirect = '' ]) : array<string, mixed>
Parameters
$type_controle : string

Identifiant du type de contrôle

$id_auteur : null|int = 0

Id de l'auteur ou 0 sinon

$redirect : null|string = ''

URL de la page à afficher suite à l'exécution du formulaire ou vide pour rester sur la même page

Tags
uses
type_controle_lire()
uses
saisies_lister_champs()
uses
type_controle_executer()
Return values
array<string, mixed> —

Tableau de retour contenant soit le message d'erreur soit le message de bonne exécution et l'url de redirection éventuelle.

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
uses
yaml_decode_file()
uses
cache_ecrire()
used-by
action_recharger_dashboards_dist()
used-by
ezcheck_affiche_milieu()
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
uses
dashboard_repertorier()
used-by
dashboard_contextualiser()
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
uses
cache_lire()
used-by
dashboard_lire()
used-by
type_controle_identifier_liaison()
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
uses
dashboard_lire()
Return values
array<string, mixed> —

Tableau du contexte contenant la description du dashboard

observation_ajouter()

Ajoute une observation à la table `spip_observations`.

observation_ajouter(bool $est_anomalie, int $id_controle[, null|array<string|int, mixed> $valeurs = [] ]) : int
Parameters
$est_anomalie : bool

Indique si l'observation est une anomalie ou pas

$id_controle : int

Identifiant numérique du contrôle

$valeurs : null|array<string|int, mixed> = []

Tableau des valeurs de certains champs de l'observation

Tags
uses
objet_lire()
uses
objet_inserer()
uses
objet_modifier()
Return values
int —

Identifiant numérique de l'observation crée ou 0 si erreur.

observation_repertorier()

Renvoie l'information brute demandée pour l'ensemble des observations ou toute les descriptions si aucun champ n'est explicitement demandé.

observation_repertorier([null|array<string, mixed> $filtres = [] ][, null|string $champ = '' ]) : array<string|int, mixed>

Il est possible de filtrer la liste des observations.

Parameters
$filtres : null|array<string, mixed> = []

Tableau associatif [champ] = valeur ou [champ] = !valeur de critères de filtres sur les champs chaine des types de contrôle. Les opérateurs égalité et inégalité sont possibles.

$champ : null|string = ''

Identifiant d'un champ de la description d'un contrôle. 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
used-by
action_cloturer_observations_dist()
used-by
formulaires_parametrer_controle_charger_dist()
Return values
array<string|int, mixed> —

Tableau de la forme [id_observation] = champ ou description complète. Les champs textuels et les tableaux sérialisés sont retournés en l'état.

observation_cloturer()

Effectue les traitements adéquats pour clore une observation : acquitte une anomalie, corrige une anomalie ou supprime une observation.

observation_cloturer(string $action, int $id_observation, int $id_auteur) : bool

Acquitter et supprimer sont des actions qui ne requièrent que la mise à jour du statut. L'action correction elle nécessite l'appel à la fonction de correction configurée.

Parameters
$action : string

Identifiant de l'action à appliquer à l'observation. Prend les valeurs corriger, acquitter ou supprimer.

$id_observation : int

Identifiant numérique de l'observation.

$id_auteur : int

Id de l'auteur ou 0 sinon.

Tags
uses
objet_lire()
uses
type_controle_lire()
uses
objet_modifier()
used-by
action_cloturer_observation_dist()
used-by
action_cloturer_observations_dist()
Return values
bool

type_controle_charger()

Charge ou recharge les descriptions des types de contrôle à partir des fichiers YAML et du pipeline `eztypecontrole_declarer`.

type_controle_charger([null|bool $recharger = false ]) : bool

La fonction optimise le chargement en effectuant uniquement les traitements nécessaires en fonction des modifications, ajouts et suppressions des contrôles identifiés en comparant les md5 des descriptions.

Parameters
$recharger : null|bool = false

Si true force le rechargement de tous les types de contrôles sinon le chargement se base sur le md5 des fichiers YAML. Par défaut vaut false.

Tags
uses
type_controle_repertorier()
used-by
action_recharger_types_controle_dist()
used-by
ezcheck_affiche_milieu()
Return values
bool —

false si une erreur s'est produite, true sinon.

type_controle_lire()

Retourne la description complète ou une liste de champs d'un type de contrôle donné.

type_controle_lire(string $id_type_controle[, null|array<string|int, mixed> $champs = [] ]) : array<string|int, mixed>|bool|int|string

Les tableaux sont systématiquement désérialisés.

Parameters
$id_type_controle : string

La valeur de l'identifiant du type de contrôle.

$champs : null|array<string|int, mixed> = []

Tableau d'un champ ou de plusieurs champs de la description d'un type de contrôle. Si l'argument est vide, la fonction renvoie la description complète.

Tags
used-by
formulaires_parametrer_controle_charger_dist()
used-by
formulaires_parametrer_controle_verifier_dist()
used-by
formulaires_parametrer_controle_traiter_dist()
used-by
observation_cloturer()
used-by
type_controle_executer()
Return values
array<string|int, mixed>|bool|int|string —

La description brute complète ou partielle du type de contrôle :

  • false : l'objet demandé n'existe pas
  • array vide : l'objet existe, mais aucun champ demandé n'existe
  • array n champs : tableau avec les champs demandés si ils existent sinon tableau vide
  • array 1 champ : valeur du champ demandé si il existe sinon false

type_controle_repertorier()

Renvoie l'information brute demandée pour l'ensemble des contrôles utilisés ou toutes les descriptions si aucune information n'est explicitement demandée.

type_controle_repertorier([null|array<string, mixed> $filtres = [] ][, null|string $champ = '' ]) : array<string, mixed>
Parameters
$filtres : null|array<string, mixed> = []

Tableau associatif [champ] = valeur ou [champ] = !valeur de critères de filtres sur les champs chaine des types de contrôle. Les opérateurs égalité et inégalité sont possibles.

$champ : null|string = ''

Identifiant d'un champ de la description d'un contrôle. 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
used-by
type_controle_charger()
Return values
array<string, mixed> —

Tableau de la forme [identifiant] = champ ou description complète. Les champs textuels et les tableaux sérialisés sont retournés en l'état.

type_controle_executer()

Exécute une fonction d'un type de contrôle donné.

type_controle_executer(string $id_type_controle, int $id_auteur, array<string, mixed> $options) : bool

Si la fonction n'existe pas c'est que l'exécution ne sert qu'à enregistrer les paramètres du formulaire servant uniquement à l'affichage d'un squelette (ce n'est pas un état). Dans ce cas l'exécution ne fait que créer un contrôle en pass thru.

Parameters
$id_type_controle : string

Id tu type de contrôle

$id_auteur : int

Id de l'auteur ayant lancé le contrôle (ou 0 pour le CRON)

$options : array<string, mixed>

Tableau des arguments valorisés de la fonction et/ou du squelette. Peut être vide, sinon possède deux index fonction et squelette. Seul l'index fonction est fourni à la fonction d'exécution si elle existe mais les deux index sont stockés dans le contrôle.

Tags
uses
objet_lire()
uses
type_controle_lire()
uses
objet_modifier()
used-by
action_executer_type_controle_dist()

Cette action est réservée aux utilisateurs pouvant exécuter un contrôle. Elle nécessite le type de contrôle et l'id de l'auteur comme arguments. Quand elle est appelée via un formulaire de choix de paramètres additionnels à fournir à la fonction de contrôle elle possède un argument options supplémentaires.

used-by
formulaires_parametrer_controle_traiter_dist()
Return values
bool —

false si une erreur s'est produite, true sinon.

type_controle_identifier_liaison()

Renvoie l'identifiant du dashboard auquel est rattaché le type contrôle.

type_controle_identifier_liaison(string $id_type_controle[, null|string $liaison = 'dashboard' ]) : string
Parameters
$id_type_controle : string

Identifiant du type de contrôle.

$liaison : null|string = 'dashboard'

Type de liaison à identifier. Prend les valeurs :

  • dashboard pour renvoyer l'id du dashboard
  • groupe pour renvoyer l'id du groupe
Tags
uses
dashboard_repertorier()
Return values
string —

Idenfiant du dashboard de rattachement ou chaine vide sinon.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results