ezcheck_observation.php
Ce fichier contient l'API de gestion des observations.
Table of Contents
Functions
- 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.
Functions
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
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] = 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|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,acquitterousupprimer. - $id_observation : int
-
Identifiant numérique de l'observation.
- $id_auteur : int
-
Id de l'auteur ou 0 sinon.