ezmashup_dataset_target.php
Ce fichier contient l'ensemble des fonctions implémentant l'API du plugin.
Table of Contents
Functions
- dataset_target_peupler() : array<string|int, mixed>
- Constitue, à partir, d'un fichier CSV ou XML ou d'une page HTML au format texte, un tableau des éléments prêt à être inséré dans une table de la base de données.
- dataset_target_supprimer() : bool
- Supprime, une target d'un feed donné.
- dataset_target_stocker() : int
- Stocke les enregistrements du dataset cible dans l'espace indiqué dans la configuration du feed.
- dataset_target_consigner() : void
- Consigne l'exécution d'un feed dans la meta adéquate.
- dataset_target_informer() : array<string|int, mixed>
- Lit la consignation de l'exécution d'un feed ou de tous les feeds d'un plugin utilisateur à partir de sa meta.
- dataset_target_deconsigner() : void
- Supprime la consignation de l'exécution d'un feed.
Functions
dataset_target_peupler()
Constitue, à partir, d'un fichier CSV ou XML ou d'une page HTML au format texte, un tableau des éléments prêt à être inséré dans une table de la base de données.
dataset_target_peupler(string $plugin, array<string|int, mixed> $feed[, null|array<string|int, mixed> &$erreur = [] ]) : array<string|int, mixed>
La fonction utilise le service et le nom de table pour récupérer la configuration permettant l'analyse du fichier et sa traduction en éléments de la table (délimiteur ou regexp, nom des colonnes...). Il est possible, pour chaque élément ou pour l'ensemble d'appliquer une fonction spécifique à la table qui complète l'élément.
Parameters
- $plugin : string
-
Préfixe du plugin utilisateur.
- $feed : array<string|int, mixed>
-
Description complète du feed.
- $erreur : null|array<string|int, mixed> = []
-
Tableau constitutif d'une erreur ou vide si aucune erreur à remonter
Tags
Return values
array<string|int, mixed> —La liste des enregistrements à stocker dans la cible concernée ou vide si erreur
dataset_target_supprimer()
Supprime, une target d'un feed donné.
dataset_target_supprimer(string $plugin, array<string|int, mixed> $feed[, null|array<string|int, mixed> &$erreur = [] ]) : bool
La meta concernant les informations de chargement est aussi effacée.
Parameters
- $plugin : string
-
Préfixe du plugin utilisateur.
- $feed : array<string|int, mixed>
-
Description complète du feed.
- $erreur : null|array<string|int, mixed> = []
-
Tableau constitutif d'une erreur ou vide si aucune erreur à remonter
Tags
Return values
bool —true si la suppression s'est bien passée, false sinon
dataset_target_stocker()
Stocke les enregistrements du dataset cible dans l'espace indiqué dans la configuration du feed.
dataset_target_stocker(string $plugin, array<string|int, mixed> $enregistrements, array<string|int, mixed> $feed[, null|array<string|int, mixed> &$erreur = [] ]) : int
Parameters
- $plugin : string
-
Préfixe du plugin utilisateur.
- $enregistrements : array<string|int, mixed>
-
Liste des enregistrements prêts à être insérés dans la table concernée.
- $feed : array<string|int, mixed>
-
Description complète du feed.
- $erreur : null|array<string|int, mixed> = []
-
Tableau constitutif d'une erreur ou vide si aucune erreur à remonter
Return values
int —Nombre d'enregistrements réellement stocké, si le stockage s'est bien passé, 0 sinon
dataset_target_consigner()
Consigne l'exécution d'un feed dans la meta adéquate.
dataset_target_consigner(string $plugin, array<string|int, mixed> $enregistrements, int $nb_insertions, array<string|int, mixed> $feed) : void
Parameters
- $plugin : string
-
Préfixe du plugin utilisateur.
- $enregistrements : array<string|int, mixed>
-
Liste des enregistrements devant être insérés dans la table concernée (tous ne le seront pas nécessairement).
- $nb_insertions : int
-
Nombre réels d'enregistrements stockés dans la target
- $feed : array<string|int, mixed>
-
Description complète du feed.
dataset_target_informer()
Lit la consignation de l'exécution d'un feed ou de tous les feeds d'un plugin utilisateur à partir de sa meta.
dataset_target_informer(string $plugin[, null|string $id_feed = '' ]) : array<string|int, mixed>
Parameters
- $plugin : string
-
Préfixe du plugin utilisateur.
- $id_feed : null|string = ''
-
Identifiant du feed.
Return values
array<string|int, mixed> —Tableau de la ou des consignations.
dataset_target_deconsigner()
Supprime la consignation de l'exécution d'un feed.
dataset_target_deconsigner(string $plugin, string $id_feed) : void
Parameters
- $plugin : string
-
Préfixe du plugin utilisateur.
- $id_feed : string
-
Identifiant du feed.