Documentation du code de SPIP et de ses plugins

Rainette

Documentation

Packages

Application
SPIP
RAINETTEAFFICHAGE

Table of Contents

_RAINETTE_DEBUG  = \false
Activation ou désactivation des traces de debug.
_RAINETTE_DEBUG_CLES_PREVISIONS  = '1'
Clé jour par défaut utilisée pour afficher les prévisions : jour suivant.
_RAINETTE_ICONES_GRANDE_TAILLE  = 110
_RAINETTE_ICONES_PETITE_TAILLE  = 28
_RAINETTE_REGEXP_LIEU_COORDONNEES  = '#([\\-\\+]?\\d+(?:\\.\\d+)?)\\s*,\\s*([\\-\\+]?\\d+(?:\\.\\d+)?)#'
Regexp permettant de reconnaître un lieu au format coordonnées géographiques latitude,longitude.
_RAINETTE_REGEXP_LIEU_INSEE_ID  = '#[0-9ABab]{5}#i'
Regexp permettant de reconnaître un lieu au format Weather ID.
_RAINETTE_REGEXP_LIEU_IP  = '#(?:\\d{1,3}\\.){3}\\d{1,3}#'
Regexp permettant de reconnaître un lieu au format adresse IP.
_RAINETTE_REGEXP_LIEU_WEATHER_ID  = '#[a-zA-Z]{4}\\d{4}#i'
Regexp permettant de reconnaître un lieu au format Weather ID.
_RAINETTE_SERVICE_DEFAUT  = 'owm'
action_recharger_configuration_dist()  : void
Cette action permet à l'utilisateur de recharger la configuration technique de Rainette et celle des services à partir de leur fichier YAML.
rainette_cache_configurer()  : array<string|int, mixed>
Renvoie la configuration spécifique des caches de Rainette.
rainette_meteo_cache_formulaire_charger()  : array<string|int, mixed>
Effectue le chargement du formulaire de vidage des caches de type `meteo` du plugin.
formulaires_configurer_rainette_service_charger()  : array<string|int, mixed>
On surcharge la fonction de chargement par défaut afin de fournir le service, sa configuration et son état d'exécution au formulaire.
inc_meteo_charger_dist()  : array<string|int, mixed>
Renvoyer le contenu du fichier cache des données météos correspondant au lieu et au type de données choisis après l'avoir éventuellement mis à jour.
angle2direction()  : string
indice2risque_uv()  : string
kilometre2mile()  : float
Conversion des kilomètres en miles.
celsius2farenheit()  : float
Conversion des températures celsius en farenheit.
millimetre2inch()  : float
Conversion des millimètres en pouces.
millibar2inch()  : float
Conversion des pressions millibar en pouces.
temperature2ressenti()  : float
Calcul de la température ressentie (refroidissement éolien) en degrés celsius.
metre2kilometre()  : float
Conversion en kilomètres d'une valeur en mètres.
metre_seconde2kilometre_heure()  : float
Conversion en kilomètres par heure d'une valeur en mètres par seconde.
rainette_debug_afficher_cache()  : string
rainette_debug_comparer_services()  : array<string|int, mixed>
rainette_debug_afficher_donnee()  : string
rainette_debug_jeu_defaut()  : array<string|int, mixed>
rainette_debug_afficher_execution()  : array<string|int, mixed>
rainette_debug_verifier_langue_manquante()  : mixed
Fonction permettant de vérifier si la liste des langues de SPIP a changé et qu'il faut modifier la config rainette.
meteo_normaliser()  : array<string|int, mixed>
Normalise les données issues du service dans un tableau standard aux index prédéfinis pour chaque mode.
donnee_typer()  : string
Détermine, en fonction du type PHP configuré, la fonction à appliquer à la valeur d'une donnée.
donnee_formater_date()  : string
Formate une date numérique ou sous une autre forme en une date au format `Y-m-d H:i:s`.
donnee_formater_heure()  : string
Formate une heure numérique ou sous une autre forme en une heure au format `H:i`.
donnee_verifier_indice_uv()  : bool
Vérifie que la valeur de l'indice UV est acceptable.
erreur_normaliser_extras()  : array<string|int, mixed>
erreur_formater_texte()  : array<string|int, mixed>
periodicite_determiner()  : int
periodicite_est_compatible()  : bool
cache_normaliser()  : array<string|int, mixed>
Construit le tableau du cache en fonction du service, du lieu, du type de données, de la langue utilisée par le site et de l'unité des données.
lieu_normaliser()  : string
langue_determiner()  : mixed
Détermine la langue d'affichage du résumé météorologique.
configuration_service_lire()  : array<string|int, mixed>
configuration_donnees_normaliser()  : array<string|int, mixed>
parametrage_normaliser()  : mixed
icone_weather_normaliser()  : string
icone_local_normaliser()  : string
service_est_indisponible()  : string
requeter()  : array<string|int, mixed>
Fait appel au service spécifié en utilisant l'URL fournie et retourne le flux brut JSON ou XML transcodé dans un tableau.
requete_autorisee()  : bool
Vérifie si la requête prévue peut être adressée au service sans excéder les limites d'utilisation fixées dans les conditions d'utilisation du service.
rainette_upgrade()  : void
Fonction d'installation de Rainette limimtée à la création de la configuration en meta.
rainette_vider_tables()  : void
Fonction de désinstallation du plugin Rainette (suppression des metas).
rainette_configurer()  : mixed
configuration_technique_charger()  : array<string|int, mixed>
configuration_service_charger()  : mixed
configuration_service_initialiser()  : array<string|int, mixed>
balise_RAINETTE_INFOS()  : mixed
calculer_infos()  : mixed
rainette_afficher_icone()  : string
Affiche l'icône correspondant au code météo fourni.
rainette_afficher_resume()  : string
Affiche le résumé fourni par le service ou calculé à partir d'un item de langue.
rainette_afficher_direction()  : string
Conversion d'une indication de direction en une chaine traduite pour l'affichage dans les modèles.
rainette_afficher_tendance()  : string
Affiche la tendance de pression selon la méthode demandée (texte en clair, symbole de flèche ou icone).
rainette_afficher_unite()  : string
Affiche toute donnée météorologique au format numérique avec son unité.
rainette_afficher_service()  : mixed|string|null
rainette_service_defaut()  : string
rainette_lister_services()  : array<string|int, mixed>|string
rainette_lister_modeles()  : array<string|int, mixed>
rainette_lister_themes()  : array<string|int, mixed>
rainette_coasser()  : array<string|int, mixed>|string
rainette_ieconfig_metas()  : array<string|int, mixed>
rainette_insert_head_css()  : mixed|string
rainette_insert_head()  : string
accuweather_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...).
accuweather_erreur_verifier()  : bool
accuweather_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.
accuweather_flux2previsions()  : array<string|int, mixed>
Modifie le flux jour des prévisions issu directement du service pour qu'il puisse être conforme à la logique de normalisation qui s'en suivra.
accuweather_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.
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
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 prévisions issu uniquement de la lecture du flux.
owm_service2url()  : string
owm_erreur_verifier()  : bool
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.
weatherapi_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...).
weatherapi_erreur_verifier()  : bool
weatherapi_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.
weatherapi_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.
weatherbit_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...).
weatherbit_erreur_verifier()  : bool
weatherbit_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.
weatherbit_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.
wwo_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...).
wwo_erreur_verifier()  : bool
wwo_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.
wwo_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.

Constants

_RAINETTE_DEBUG

Activation ou désactivation des traces de debug.

public mixed _RAINETTE_DEBUG = \false

_RAINETTE_DEBUG_CLES_PREVISIONS

Clé jour par défaut utilisée pour afficher les prévisions : jour suivant.

public mixed _RAINETTE_DEBUG_CLES_PREVISIONS = '1'

_RAINETTE_REGEXP_LIEU_COORDONNEES

Regexp permettant de reconnaître un lieu au format coordonnées géographiques latitude,longitude.

public mixed _RAINETTE_REGEXP_LIEU_COORDONNEES = '#([\\-\\+]?\\d+(?:\\.\\d+)?)\\s*,\\s*([\\-\\+]?\\d+(?:\\.\\d+)?)#'

_RAINETTE_REGEXP_LIEU_INSEE_ID

Regexp permettant de reconnaître un lieu au format Weather ID.

public mixed _RAINETTE_REGEXP_LIEU_INSEE_ID = '#[0-9ABab]{5}#i'

_RAINETTE_REGEXP_LIEU_IP

Regexp permettant de reconnaître un lieu au format adresse IP.

public mixed _RAINETTE_REGEXP_LIEU_IP = '#(?:\\d{1,3}\\.){3}\\d{1,3}#'

_RAINETTE_REGEXP_LIEU_WEATHER_ID

Regexp permettant de reconnaître un lieu au format Weather ID.

public mixed _RAINETTE_REGEXP_LIEU_WEATHER_ID = '#[a-zA-Z]{4}\\d{4}#i'

Functions

action_recharger_configuration_dist()

Cette action permet à l'utilisateur de recharger la configuration technique de Rainette et celle des services à partir de leur fichier YAML.

action_recharger_configuration_dist() : void

Cette action est réservée aux utilisateurs pouvant accéder à la configuration.

Return values
void

rainette_cache_configurer()

Renvoie la configuration spécifique des caches de Rainette.

rainette_cache_configurer(string $plugin) : array<string|int, mixed>
Parameters
$plugin : string

Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.

Return values
array<string|int, mixed>

Tableau de la configuration des types de cache du plugin.

rainette_meteo_cache_formulaire_charger()

Effectue le chargement du formulaire de vidage des caches de type `meteo` du plugin.

rainette_meteo_cache_formulaire_charger(string $plugin, array<string|int, mixed> $valeurs, array<string|int, mixed> $options, array<string|int, mixed> $configuration) : array<string|int, mixed>

L'intérêt est de permette le rangement des caches par service.

Parameters
$plugin : string

Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.

$valeurs : array<string|int, mixed>

Tableau des valeurs du formulaire à compléter

$options : array<string|int, mixed>

Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre. Le tableau est passé à la fonction de service de chargement du formulaire uniquement.

$configuration : array<string|int, mixed>

Configuration complète des caches du type meteo du plugin utilisateur lue à partir de la meta de stockage.

Tags
uses
rainette_lister_services()
uses
cache_repertorier()
Return values
array<string|int, mixed>

Tableau des caches de type meteo.

formulaires_configurer_rainette_service_charger()

On surcharge la fonction de chargement par défaut afin de fournir le service, sa configuration et son état d'exécution au formulaire.

formulaires_configurer_rainette_service_charger(string $service) : array<string|int, mixed>
Parameters
$service : string

Alias du service.

Return values
array<string|int, mixed>

Tableau des données à charger par le formulaire.

inc_meteo_charger_dist()

Renvoyer le contenu du fichier cache des données météos correspondant au lieu et au type de données choisis après l'avoir éventuellement mis à jour.

inc_meteo_charger_dist(string $lieu[, string $mode = 'conditions' ], int $periodicite[, string $service = '' ]) : array<string|int, mixed>

Si le fichier cache est obsolète ou absent, on le crée après avoir chargé puis phrasé le flux XML ou JSON et stocké les données collectées et transcodées dans un tableau standardisé. L'appelant doit s'assurer que la périodicité est compatible avec le service; cette fonction ne retourne donc que des erreurs de chargement.

Parameters
$lieu : string

Le lieu concerné par la méteo exprimé selon les critères requis par le service.

$mode : string = 'conditions'

Le type de données météorologiques demandé :

  • conditions, la valeur par défaut
  • previsions
  • infos
$periodicite : int

La périodicité horaire des prévisions :

  • 24, les prévisions de la journée
  • 12, les prévisions du jour et de la nuit
  • 6, les prévisions de la journée par période de 6h
  • 3, les prévisions de la journée par période de 3h
  • 1, les prévisions de la journée pour chaque heure
  • 0, pour les modes conditions et infos
$service : string = ''

Le nom abrégé du service :

  • owm pour OpenWeather, la valeur par défaut car elle propose un plan gratuit
  • weatherbit pour Weatherbit.io
  • weatheapi pour WeatherAPI
  • accuweather pour AccuWeather
  • wwo pour World Weather Online
  • meteoc pour Meteo-Concept
Tags
uses
cache_nommer()
uses
meteo_normaliser()
uses
indice2risque_uv()
Return values
array<string|int, mixed>

Le contenu du fichier cache contenant les données à jour demandées.

angle2direction()

angle2direction(int $angle) : string
Parameters
$angle : int

Angle du vent exprimé en degrés.

Return values
string

Direction du vent en abrégée anglais standard selon 16 directions.

indice2risque_uv()

indice2risque_uv(int $indice_uv) : string
Parameters
$indice_uv : int

Entier représentant l'indice UV

Return values
string

Chaine représentant le risque lié à l'indice UV. Cette chaine permet de calculer l'item de langue du risque dans la langue requise.

kilometre2mile()

Conversion des kilomètres en miles.

kilometre2mile(float $kilometre) : float
Parameters
$kilometre : float

La valeur réelle en kilomètres.

Return values
float

La valeur réelle correspondante convertie en miles

celsius2farenheit()

Conversion des températures celsius en farenheit.

celsius2farenheit(int $celsius) : float
Parameters
$celsius : int

La valeur réelle en degrés celsius.

Return values
float

La valeur réelle correspondante convertie en farenheit.

millimetre2inch()

Conversion des millimètres en pouces.

millimetre2inch(float $millimetre) : float
Parameters
$millimetre : float

La valeur réelle en millimètres

Return values
float

La valeur réelle correspondante convertie en pouces.

millibar2inch()

Conversion des pressions millibar en pouces.

millibar2inch(float $millibar) : float
Parameters
$millibar : float

La valeur réelle en millibars

Return values
float

La valeur réelle correspondante convertie en pouces.

temperature2ressenti()

Calcul de la température ressentie (refroidissement éolien) en degrés celsius.

temperature2ressenti(float $temperature, float $vitesse_vent) : float

Le calcul n'a de sens que pour des températures réelles supérieures à -50°C et inférieures à 10°C. Au-delà de ces valeurs, la fonction renvoie la température réelle fournie en entrée.

Parameters
$temperature : float

Température réelle mesurée en celsius.

$vitesse_vent : float

Vitesse du vent en kilomètre par heure.

Return values
float

Température ressentie arrondie en entier et exprimée en degrés celsius.

metre2kilometre()

Conversion en kilomètres d'une valeur en mètres.

metre2kilometre(int $metre) : float
Parameters
$metre : int

La valeur entière en mètres

Return values
float

La valeur correspondante convertie en kilomètres.

metre_seconde2kilometre_heure()

Conversion en kilomètres par heure d'une valeur en mètres par seconde.

metre_seconde2kilometre_heure(float $vitesse_vent) : float
Parameters
$vitesse_vent : float

Vitesse du vent en mètres par seconde.

Return values
float

La valeur correspondante convertie en kilomètres par heure.

rainette_debug_afficher_cache()

rainette_debug_afficher_cache(string $lieu[, string $mode = 'previsions' ][, string $service = '' ]) : string
Parameters
$lieu : string
$mode : string = 'previsions'
$service : string = ''
Return values
string

rainette_debug_comparer_services()

rainette_debug_comparer_services([string $mode = 'conditions' ][, array<string|int, mixed> $jeu = array() ]) : array<string|int, mixed>
Parameters
$mode : string = 'conditions'
$jeu : array<string|int, mixed> = array()
Return values
array<string|int, mixed>

rainette_debug_afficher_donnee()

rainette_debug_afficher_donnee(string $donnee, mixed $valeur, string $type_php, string $type_unite[, string $service = '' ]) : string
Parameters
$donnee : string
$valeur : mixed
$type_php : string
$type_unite : string
$service : string = ''
Return values
string

rainette_debug_jeu_defaut()

rainette_debug_jeu_defaut() : array<string|int, mixed>
Return values
array<string|int, mixed>

rainette_debug_afficher_execution()

rainette_debug_afficher_execution() : array<string|int, mixed>
Return values
array<string|int, mixed>

rainette_debug_verifier_langue_manquante()

Fonction permettant de vérifier si la liste des langues de SPIP a changé et qu'il faut modifier la config rainette.

rainette_debug_verifier_langue_manquante() : mixed
Return values
mixed

meteo_normaliser()

Normalise les données issues du service dans un tableau standard aux index prédéfinis pour chaque mode.

meteo_normaliser(array<string|int, mixed> $configuration_service, string $mode, array<string|int, mixed> $flux, int $periode) : array<string|int, mixed>
Parameters
$configuration_service : array<string|int, mixed>

Configuration statique et utilisateur du service ayant retourné le flux de données.

$mode : string

Le type de données météorologiques demandé :

  • conditions, la valeur par défaut
  • previsions
  • infos
$flux : array<string|int, mixed>

Le tableau brut des données météorologiques issu de l'appel au service.

$periode : int

Valeur de 0 à n pour indiquer qu'on traite les données de prévisions d'une période horaire donnée ou -1 pour indiquer que l'on traite les données jour. La valeur maximale n dépend de la périodicité des prévisions, par exemple, elle vaut 0 pour une périodicité de 24h, 1 pour 12h...

Return values
array<string|int, mixed>

Le tableau standardisé des données météorologiques du service pour la période spécifiée.

donnee_typer()

Détermine, en fonction du type PHP configuré, la fonction à appliquer à la valeur d'une donnée.

donnee_typer(string $type_php) : string
Parameters
$type_php : string

Le type PHP ou chaine vide sinon

Return values
string

La fonction PHP (floatval, intval...) ou spécifique à appliquer à la valeur de la donnée.

donnee_formater_date()

Formate une date numérique ou sous une autre forme en une date au format `Y-m-d H:i:s`.

donnee_formater_date(string $donnee) : string
Parameters
$donnee : string

Correspond à un index du tableau associatif standardisé à formater en date standard.

Return values
string

Date au format Y-m-d H:i:s.

donnee_formater_heure()

Formate une heure numérique ou sous une autre forme en une heure au format `H:i`.

donnee_formater_heure(string $donnee) : string
Parameters
$donnee : string

Correspond à un index du tableau associatif standardisé à formater en heure standard.

Return values
string

Heure au format H:i.

donnee_verifier_indice_uv()

Vérifie que la valeur de l'indice UV est acceptable.

donnee_verifier_indice_uv(int $valeur) : bool
Parameters
$valeur : int

Valeur de l'indice UV à vérifier. Un indice UV est toujours compris entre 0 et 16, bornes comprises.

Return values
bool

true si la valeur est acceptable, false sinon.

erreur_normaliser_extras()

erreur_normaliser_extras( $erreur,  $lieu,  $mode,  $periodicite,  $service[,  $configuration = array() ]) : array<string|int, mixed>
Parameters
$erreur :
$lieu :
$mode :
$periodicite :
$service :
$configuration : = array()
Return values
array<string|int, mixed>

erreur_formater_texte()

erreur_formater_texte( $erreur,  $lieu,  $mode,  $modele,  $service,  $nom_service) : array<string|int, mixed>
Parameters
$erreur :
$lieu :
$mode :
$modele :
$service :
$nom_service :
Return values
array<string|int, mixed>

periodicite_determiner()

periodicite_determiner( $type_modele,  $service) : int
Parameters
$type_modele :
$service :
Return values
int

periodicite_est_compatible()

periodicite_est_compatible( $type_modele,  $periodicite) : bool
Parameters
$type_modele :
$periodicite :
Return values
bool

cache_normaliser()

Construit le tableau du cache en fonction du service, du lieu, du type de données, de la langue utilisée par le site et de l'unité des données.

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

Lieu pour lequel on requiert le nom du cache.

$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, 12, 6, 3 ou 1, pour le mode previsions
  • 0, pour les modes conditions et infos
$configuration_service : array<string|int, mixed>

Configuration complète du service, statique et utilisateur. Contient l'unité choisie pour les données.

Return values
array<string|int, mixed>

Chemin complet du fichier cache.

lieu_normaliser()

lieu_normaliser(string $lieu[, string &$format_lieu = '' ]) : string
Parameters
$lieu : string
$format_lieu : string = ''
Return values
string

langue_determiner()

Détermine la langue d'affichage du résumé météorologique.

langue_determiner( $configuration_service) : mixed

Les services de Rainette peuvent renvoyer la traduction du résumé dans plusieurs langues. Il est donc nécessaire de demander ce résumé dans la bonne langue si elle existe.

Parameters
$configuration_service :
Return values
mixed

configuration_service_lire()

configuration_service_lire( $service,  $bloc) : array<string|int, mixed>
Parameters
$service :
$bloc :
Return values
array<string|int, mixed>

configuration_donnees_normaliser()

configuration_donnees_normaliser( $mode,  $configuration) : array<string|int, mixed>
Parameters
$mode :
$configuration :
Return values
array<string|int, mixed>

parametrage_normaliser()

parametrage_normaliser( $service,  $configuration_defaut) : mixed
Parameters
$service :
$configuration_defaut :
Return values
mixed

icone_weather_normaliser()

icone_weather_normaliser(int|string $code_meteo, string $theme[, array<string|int, mixed> $transcodage = array() ], int $periode) : string
Parameters
$code_meteo : int|string
$theme : string
$transcodage : array<string|int, mixed> = array()
$periode : int
Return values
string

icone_local_normaliser()

icone_local_normaliser(string $icone, string $service[, string $theme = '' ][, string $periode = '' ]) : string
Parameters
$icone : string
$service : string
$theme : string = ''
$periode : string = ''
Return values
string

service_est_indisponible()

service_est_indisponible(string $service) : string
Parameters
$service : string
Return values
string

requeter()

Fait appel au service spécifié en utilisant l'URL fournie et retourne le flux brut JSON ou XML transcodé dans un tableau.

requeter(string $url, array<string|int, mixed> $configuration, string $service) : array<string|int, mixed>

Chaque appel est comptabilisé et logé dans une meta.

Parameters
$url : string

URL complète de la requête formatée en fonction de la demande et du service.

$configuration : array<string|int, mixed>

Configuration statique et utilisateur du service nécessaire pour identifier les seuils de requêtes par période propres au service et le format du flux pour le transcodage.

$service : string

Alias du service.

Return values
array<string|int, mixed>

Tableau des données météorologiques retournées par le service ou tableau limité à l'index erreur en cas d'erreur de transcodage.

requete_autorisee()

Vérifie si la requête prévue peut être adressée au service sans excéder les limites d'utilisation fixées dans les conditions d'utilisation du service.

requete_autorisee(array<string|int, mixed> $limites, string $service) : bool

Si une période est échue, la fonction remet à zéro le compteur associé.

Parameters
$limites : array<string|int, mixed>

Tableau des seuils de requêtes par période (année, mois,..., minute, seconde).

$service : string

Alias du service.

Return values
bool

true si la requête est autorisée, falsesinon.

rainette_upgrade()

Fonction d'installation de Rainette limimtée à la création de la configuration en meta.

rainette_upgrade(string $nom_meta_base_version, string $version_cible) : void
Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

$version_cible : string

Version du schéma de données dans ce plugin (déclaré dans paquet.xml)

Return values
void

rainette_vider_tables()

Fonction de désinstallation du plugin Rainette (suppression des metas).

rainette_vider_tables(string $nom_meta_base_version) : void
Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

Return values
void

configuration_technique_charger()

configuration_technique_charger([ $fichier_config = '' ]) : array<string|int, mixed>
Parameters
$fichier_config : = ''
Return values
array<string|int, mixed>

configuration_service_charger()

configuration_service_charger(mixed $service[, mixed $yaml_service = '' ]) : mixed
Parameters
$service : mixed
$yaml_service : mixed = ''
Return values
mixed

configuration_service_initialiser()

configuration_service_initialiser( $service) : array<string|int, mixed>
Parameters
$service :
Return values
array<string|int, mixed>

calculer_infos()

calculer_infos(string $lieu, string $type, string $service) : mixed
Parameters
$lieu : string
$type : string
$service : string
Return values
mixed

rainette_afficher_icone()

Affiche l'icône correspondant au code météo fourni.

rainette_afficher_icone(array<string|int, mixed> $icone[, int|string $taille = 'petit' ][, array<string|int, mixed> $options = array() ]) : string
Parameters
$icone : array<string|int, mixed>
$taille : int|string = 'petit'
$options : array<string|int, mixed> = array()
Tags
filtre
Return values
string

rainette_afficher_resume()

Affiche le résumé fourni par le service ou calculé à partir d'un item de langue.

rainette_afficher_resume(string $resume) : string

A partir de la version 4.1.0, le résumé est toujours une chaine, le code météo n'est plus passé à la fonction même si le service ne fournit pas de résumé. Dans ce cas, c'est la fonction de complément du service qui calcule le résumé.

Parameters
$resume : string

Résumé météo déjà fourni ou calculé par le service dans la langue de l'interface

Tags
filtre
Return values
string

rainette_afficher_direction()

Conversion d'une indication de direction en une chaine traduite pour l'affichage dans les modèles.

rainette_afficher_direction(mixed $direction) : string
Parameters
$direction : mixed

La direction soit sous forme d'une valeur numérique entre 0 et 360, soit sous forme d'une chaine. Certains services utilisent la chaine "V" pour indiquer une direction variable.

Tags
filtre
Return values
string

La chaine traduite indiquant la direction du vent.

rainette_afficher_tendance()

Affiche la tendance de pression selon la méthode demandée (texte en clair, symbole de flèche ou icone).

rainette_afficher_tendance(string|null $tendance_en[, string $methode = 'texte' ]) : string
Parameters
$tendance_en : string|null

Texte anglais représentant la tendance et récupérée par le service.

$methode : string = 'texte'

Methode d'affichage de la tendance qui prend les valeurs:

  • texte : pour afficher un texte en clair décrivant la tendance (méthode par défaut).
  • symbole : pour afficher un symbole de flèche (1 caractère) décrivant la tendance.
Tags
filtre
Return values
string

rainette_afficher_unite()

Affiche toute donnée météorologique au format numérique avec son unité.

rainette_afficher_unite(int|float $valeur[, string $type_donnee = '' ][, int $precision = -1 ][, string $service = '' ]) : string
Parameters
$valeur : int|float

La valeur à afficher

$type_donnee : string = ''

Type de données à afficher parmi 'temperature', 'pourcentage', 'angle', 'pression', 'distance', 'vitesse', 'population', 'precipitation'.

$precision : int = -1

Nombre de décimales à afficher pour les réels uniquement ou -1 pour utiliser le défaut.

$service : string = ''

Identifiant du service utilisé. Si non fourni, on prend le service par défaut

Tags
filtre
Return values
string

La chaine calculée ou le texte désignant une valeur indéterminée ou vide si la valeur est null.

rainette_afficher_service()

rainette_afficher_service( $service) : mixed|string|null
Parameters
$service :
Return values
mixed|string|null

rainette_lister_services()

rainette_lister_services([string $mode = 'tableau' ][, bool $actif_uniquement = true ]) : array<string|int, mixed>|string
Parameters
$mode : string = 'tableau'
$actif_uniquement : bool = true
Return values
array<string|int, mixed>|string

rainette_lister_modeles()

rainette_lister_modeles([string $mode = 'conditions' ][, int $periodicite = 24 ]) : array<string|int, mixed>
Parameters
$mode : string = 'conditions'
$periodicite : int = 24
Return values
array<string|int, mixed>

rainette_lister_themes()

rainette_lister_themes(string $service[, string $source = 'local' ]) : array<string|int, mixed>
Parameters
$service : string
$source : string = 'local'
Return values
array<string|int, mixed>

rainette_coasser()

rainette_coasser(string $lieu[, string $mode = 'conditions' ][, string $modele = 'conditions_tempsreel' ][, string $service = '' ][, array<string|int, mixed> $options = array() ]) : array<string|int, mixed>|string
Parameters
$lieu : string
$mode : string = 'conditions'
$modele : string = 'conditions_tempsreel'
$service : string = ''
$options : array<string|int, mixed> = array()
Return values
array<string|int, mixed>|string

rainette_ieconfig_metas()

rainette_ieconfig_metas( $table) : array<string|int, mixed>
Parameters
$table :
Return values
array<string|int, mixed>

rainette_insert_head_css()

rainette_insert_head_css( $flux) : mixed|string
Parameters
$flux :
Return values
mixed|string

rainette_insert_head()

rainette_insert_head( $flux) : string
Parameters
$flux :
Return values
string

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

accuweather_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, 12, 6, 3 ou 1, 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
langue_determiner()
uses
lieu_normaliser()
Return values
string

URL complète de la requête.

accuweather_erreur_verifier()

accuweather_erreur_verifier(array<string|int, mixed> $erreur) : bool
Parameters
$erreur : array<string|int, mixed>
Return values
bool

accuweather_complement2conditions()

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

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

Return values
array<string|int, mixed>

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

accuweather_flux2previsions()

Modifie le flux jour des prévisions issu directement du service pour qu'il puisse être conforme à la logique de normalisation qui s'en suivra.

accuweather_flux2previsions(array<string|int, mixed> $flux, int $periodicite, array<string|int, mixed> $configuration) : array<string|int, mixed>

Pour AccuWeather, pour la périodicité 12h on modifie les index 'Day' et 'Night' qui contiennent les flux horaires par un tableau de base 'hourly' dont les index sont numériques : 0 jour et 1 nuit.

Parameters
$flux : array<string|int, mixed>

Flux jour non normalisé provenant du service

$periodicite : int

Périodicité horaire des prévisiosns (24, 12, 6, 3 ou 1)

$configuration : array<string|int, mixed>

Configuration complète du service, statique et utilisateur.

Return values
array<string|int, mixed>

Flux jour modifié

accuweather_complement2previsions()

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

accuweather_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

Return values
array<string|int, mixed>

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

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, 12, 6, 3 ou 1, 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()

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

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 conditions météorologiques 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.

Return values
array<string|int, mixed>

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

meteoc_complement2previsions()

Complète par des données spécifiques au service le tableau des prévisions 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

Return values
array<string|int, mixed>

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

owm_service2url()

owm_service2url( $lieu,  $mode,  $periodicite,  $configuration) : string
Parameters
$lieu :
$mode :
$periodicite :
$configuration :
Return values
string

owm_erreur_verifier()

owm_erreur_verifier(array<string|int, mixed> $erreur) : bool
Parameters
$erreur : array<string|int, mixed>
Return values
bool

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, 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 conditions météorologiques complété par les données spécifiques du 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, 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

Return values
array<string|int, mixed>

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

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

weatherapi_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, 12, 6, 3 ou 1, 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
langue_determiner()
uses
lieu_normaliser()
Return values
string

URL complète de la requête.

weatherapi_erreur_verifier()

weatherapi_erreur_verifier(array<string|int, mixed> $erreur) : bool
Parameters
$erreur : array<string|int, mixed>
Return values
bool

weatherapi_complement2conditions()

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

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

Return values
array<string|int, mixed>

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

weatherapi_complement2previsions()

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

weatherapi_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

Return values
array<string|int, mixed>

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

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

weatherbit_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, 12, 6, 3 ou 1, 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
langue2code_weatherbit()
Return values
string

URL complète de la requête.

weatherbit_erreur_verifier()

weatherbit_erreur_verifier(array<string|int, mixed> $erreur) : bool
Parameters
$erreur : array<string|int, mixed>
Return values
bool

weatherbit_complement2conditions()

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

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

Return values
array<string|int, mixed>

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

weatherbit_complement2previsions()

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

weatherbit_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

Return values
array<string|int, mixed>

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

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

wwo_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, 12, 6, 3 ou 1, 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
langue_determiner()
uses
lieu_normaliser()
Return values
string

URL complète de la requête.

wwo_erreur_verifier()

wwo_erreur_verifier(array<string|int, mixed> $erreur) : bool
Parameters
$erreur : array<string|int, mixed>
Return values
bool

wwo_complement2conditions()

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

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

Return values
array<string|int, mixed>

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

wwo_complement2previsions()

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

wwo_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

Return values
array<string|int, mixed>

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

Search results