SPIP Code

Documentation du code de SPIP et de ses plugins

Rainette

owm.php

Ce fichier contient l'ensemble des constantes et fonctions implémentant le service Open Weather Map (owm).

Ce service fournit des données au format XML ou JSON mais Rainette utilise uniquement le JSON.

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

Functions

owm_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...).
owm_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.
owm_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.
owm_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_owm()  : array<string|int, mixed>
Calcule les états en fonction des états météorologiques natifs fournis par le service.

Functions

owm_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...).

owm_service2url(array<string|int, mixed> $lieu_normalise, string $mode, int $periodicite, string $langue, array<string|int, mixed> $configuration) : string
Parameters
$lieu_normalise : array<string|int, mixed>

Lieu normalisé avec son format 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
$langue : string

Code de langue spip indiquant langue choisie pour afficher les données météo.

$configuration : array<string|int, mixed>

Configuration complète du service, statique et utilisateur.

Tags
uses
langue_service_determiner()
Return values
string —

URL complète de la requête.

owm_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.

owm_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.

owm_complement2conditions()

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

owm_complement2conditions(array<string|int, mixed> $tableau, string $langue, 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.

$langue : string

Code de langue spip indiquant langue choisie pour afficher les données météo.

$configuration : array<string|int, mixed>

Configuration complète du service, statique et utilisateur.

Tags
uses
angle2direction()
uses
metre2kilometre()
uses
metre_seconde2kilometre_heure()
uses
etat2resume_owm()
Return values
array<string|int, mixed> —

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

owm_complement2previsions()

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

owm_complement2previsions(array<string|int, mixed> $tableau, string $langue, 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.

$langue : string

Code de langue spip indiquant langue choisie pour afficher les données météo.

$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
angle2direction()
uses
metre_seconde2kilometre_heure()
uses
etat2resume_owm()
Return values
array<string|int, mixed> —

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

etat2resume_owm()

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

etat2resume_owm(array<string|int, mixed> $tableau, string $langue, 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.

$langue : string

Code de langue spip indiquant langue choisie pour afficher les données météo.

$configuration : array<string|int, mixed>

Configuration complète du service, statique et utilisateur.

Tags
uses
icone_normaliser_chemin()
uses
icone_weather_normaliser_chemin()
used-by
owm_complement2conditions()
used-by
owm_complement2previsions()
Return values
array<string|int, mixed> —

Tableau standard mis à jour.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results