SPIP Code

Documentation du code de SPIP et de ses plugins

Rainette

meteoc.php

Ce fichier contient la configuration et l'ensemble des fonctions implémentant le service Méteo-Concept (meteoc).

Ce service est capable de fournir des données au format JSON ou XML.

Les fonctions qui suivent définissent l'API standard du service et sont appelées par la fonction unique de chargement des données météorologiques meteo_charger().

Table of Contents

meteoc_service2url()  : string
Construit l'url de la requête correspondant au lieu, au type de données et à la configuration utilisateur du service (par exemple, le code d'inscription, le format des résultats...).
meteoc_erreur_verifier()  : bool
Lit le bloc de réponse potentiellement constitutif d'une erreur pour déterminer si la requête est réellement en échec.
meteoc_complement2infos()  : array<string|int, mixed>
Complète par des données spécifiques au service le tableau des informations issu uniquement de la lecture du flux.
meteoc_complement2conditions()  : array<string|int, mixed>
Complète par des données spécifiques au service le tableau des conditions issu uniquement de la lecture du flux.
meteoc_complement2previsions()  : array<string|int, mixed>
Complète par des données spécifiques au service le tableau des conditions issu uniquement de la lecture du flux.
etat2resume_meteoc()  : array<string|int, mixed>
Calcule les états en fonction des états météorologiques natifs fournis par le service.

Functions

meteoc_service2url()

Construit l'url de la requête correspondant au lieu, au type de données et à la configuration utilisateur du service (par exemple, le code d'inscription, le format des résultats...).

meteoc_service2url(string $lieu, string $mode, int $periodicite, array<string|int, mixed> $configuration) : string
Parameters
$lieu : string

Lieu pour lequel on acquiert les données météorologiques.

$mode : string

Type de données météorologiques. Les valeurs possibles sont infos, conditions ou previsions.

$periodicite : int

La périodicité horaire des prévisions :

  • 24 pour le mode previsions
  • 0, pour les modes conditions et infos
$configuration : array<string|int, mixed>

Configuration complète du service, statique et utilisateur.

Tags
uses
lieu_normaliser()
Return values
string —

URL complète de la requête.

meteoc_erreur_verifier()

Lit le bloc de réponse potentiellement constitutif d'une erreur pour déterminer si la requête est réellement en échec.

meteoc_erreur_verifier(array<string|int, mixed> $erreur) : bool
Parameters
$erreur : array<string|int, mixed>

Sous-tableau de la réponse dans lequel vérifier une erreur de flux.

Return values
bool —

true si une erreur est détectée, false sinon.

meteoc_complement2infos()

Complète par des données spécifiques au service le tableau des informations issu uniquement de la lecture du flux.

meteoc_complement2infos(array<string|int, mixed> $tableau, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$tableau : array<string|int, mixed>

Tableau standardisé des conditions contenant uniquement les données fournies sans traitement par le service.

$configuration : array<string|int, mixed>

Configuration complète du service, statique et utilisateur.

Return values
array<string|int, mixed> —

Tableau standardisé des informations complété par les données spécifiques du service.

meteoc_complement2conditions()

Complète par des données spécifiques au service le tableau des conditions issu uniquement de la lecture du flux.

meteoc_complement2conditions(array<string|int, mixed> $tableau, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$tableau : array<string|int, mixed>

Tableau standardisé des conditions contenant uniquement les données fournies sans traitement par le service.

$configuration : array<string|int, mixed>

Configuration complète du service, statique et utilisateur.

Tags
uses
angle2direction()
uses
temperature2ressenti()
uses
etat2resume_meteoc()
Return values
array<string|int, mixed> —

Tableau standardisé des conditions météorologiques complété par les données spécifiques au service.

meteoc_complement2previsions()

Complète par des données spécifiques au service le tableau des conditions issu uniquement de la lecture du flux.

meteoc_complement2previsions(array<string|int, mixed> $tableau, array<string|int, mixed> $configuration, int $index_periode) : array<string|int, mixed>
Parameters
$tableau : array<string|int, mixed>

Tableau standardisé des conditions contenant uniquement les données fournies sans traitement par le service.

$configuration : array<string|int, mixed>

Configuration complète du service, statique et utilisateur.

$index_periode : int

Index où trouver et ranger les données. Cet index n'est pas utilisé pour les conditions

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

Tableau standardisé des conditions météorologiques complété par les données spécifiques du service.

etat2resume_meteoc()

Calcule les états en fonction des états météorologiques natifs fournis par le service.

etat2resume_meteoc(array<string|int, mixed> $tableau, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$tableau : array<string|int, mixed>

Tableau standardisé des conditions contenant uniquement les données fournies sans traitement par le service. Le tableau est mis à jour et renvoyé à l'appelant.

$configuration : array<string|int, mixed>

Configuration complète du service, statique et utilisateur.

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

Tableau standard mis à jour.

Search results