ezmashup_dataset_source.php
Ce fichier contient les fonctions d'API des `datasets source` du plugin Mashup Factory.
Table of Contents
Constants
Functions
- dataset_source_extraire() : array<string|int, mixed>
- Extrait le contenu de tous les datasets source basiques ou d'un dataset source addon donné.
- dataset_source_normaliser_configuration() : array<string|int, mixed>
- Normalise la description d'un dataset source donné.
- dataset_source_requeter() : string
- Renvoie, à partir de l'url fournie, le contenu brut récupéré d'une source de type API ou page web, ou une erreur sinon.
- dataset_source_decoder() : array<string|int, mixed>
- Décode un contenu d'une source pour en extraire un tableau de données.
Constants
_EZMASHUP_COEFF_MAX_DISTANT
public
mixed
_EZMASHUP_COEFF_MAX_DISTANT
= 5
Functions
dataset_source_extraire()
Extrait le contenu de tous les datasets source basiques ou d'un dataset source addon donné.
dataset_source_extraire(string $id_source, array<string|int, mixed> $feed[, null|array<string|int, mixed> &$erreur = [] ]) : array<string|int, mixed>
Le contenu est renvoyé sous la forme d'une liste d'items qui seront traités par la suite pour être insérés dans le dataset cible concerné.
Parameters
- $id_source : string
-
Identifiant d'une source addon donnée ou vide pour toutes les sources primaires.
- $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> —Tableau des items extraits de la source. Un tableau vide est constitutif d'une erreur.
dataset_source_normaliser_configuration()
Normalise la description d'un dataset source donné.
dataset_source_normaliser_configuration(array<string|int, mixed> $dataset[, null|array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Il est possible de fournir le dataset par défaut qui servira à la normalisation (cas du dataset '*').
Parameters
- $dataset : array<string|int, mixed>
-
Dataset à normaliser
- $options : null|array<string|int, mixed> = []
-
Options pour compléter la normalisation
- array
dataset_defaut: Dataset par défaut à utiliser. Ce dataset doit déjà être normalisé Si aucun dataset fourni, la fonction utilise le dataset par défaut de base où tous les champs sont 'vides'. - string
dossier_feed: Chemin relatif du dossier de rangement du feed - string
ìnclude_feed: Chemin relatif de l'include des fonctions spécifiques du feed
- array
Return values
array<string|int, mixed> —Dataset normalisé
dataset_source_requeter()
Renvoie, à partir de l'url fournie, le contenu brut récupéré d'une source de type API ou page web, ou une erreur sinon.
dataset_source_requeter(string $url, array<string|int, mixed> $options[, null|array<string|int, mixed> &$erreur = [] ]) : string
Parameters
- $url : string
-
URL complète de la requête
- $options : array<string|int, mixed>
-
Options de la requête
- bool
transcoder: true si on veut transcoder la page dans le charset du site - int
taille_max: Arrêter le contenu au-delà (0 = seulement les entetes ==> requête HEAD). Par defaut taille_max = 1Mo ou 16Mo si copie dans un fichier
- bool
- $erreur : null|array<string|int, mixed> = []
-
Tableau constitutif d'une erreur ou vide si aucune erreur à remonter
Tags
Return values
string —La chaine renvoyée en réponse à la requête ou vide si une erreur s'est produit.
dataset_source_decoder()
Décode un contenu d'une source pour en extraire un tableau de données.
dataset_source_decoder(string $contenu, string $type_source, string $id_source, array<string|int, mixed> $feed[, null|array<string|int, mixed> &$erreur = [] ]) : array<string|int, mixed>
La fonction utilise l'API de décodage fournie par le plugin Encoder Factory.
Parameters
- $contenu : string
-
Chaine extraite de la source à décoder selon le format et les paramètres associés.
- $type_source : string
-
Type de source basique (
sources_basic) ou additionnelle (sources_addon). - $id_source : string
-
Identifiant de la source.
- $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> —Tableau des données résultant du décodage ou vide ce qui est constitutif d'une erreur.