ezcheck_type_controle.php
Ce fichier contient l'API de gestion des types de contrôle.
Table of Contents
Functions
- 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
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
trueforce le rechargement de tous les types de contrôles sinon le chargement se base sur le md5 des fichiers YAML. Par défaut vautfalse.
Tags
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
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 pasarray vide: l'objet existe, mais aucun champ demandé n'existearray n champs: tableau avec les champs demandés si ils existent sinon tableau videarray 1 champ: valeur du champ demandé si il existe sinonfalse
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] = valeurou[champ] = !valeurde 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
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
fonctionetsquelette. Seul l'indexfonctionest fourni à la fonction d'exécution si elle existe mais les deux index sont stockés dans le contrôle.
Tags
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 :
dashboardpour renvoyer l'id du dashboardgroupepour renvoyer l'id du groupe
Tags
Return values
string —Idenfiant du dashboard de rattachement ou chaine vide sinon.