Rainette

API Documentation

Constants

_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_ICONE_EXTENSIONS = ['png', 'svg']: Liste des extensions possibles pour les icones dans l'ordre de préférence.
_RAINETTE_ICONE_GRANDE_TAILLE = 110
_RAINETTE_ICONE_NOM_NA = 'na': Nom de l'icone n/a par défaut si le thème ne le fournit pas.
_RAINETTE_ICONE_NOM_VIDE = 'icone-vide': Nom de l'icone vide par défaut.
_RAINETTE_ICONE_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_PWSID = '#PWS_[\w]+#': Regexp permettant de reconnaître un lieu au format coordonnées géographiques latitude,longitude.
_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'

Functions

action_effacer_parametrage_dist() : void: Cette action permet à l'utilisateur d'effacer le paramétrage utioisateur d'un service.
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.
lister_directions() : array<string|int, mixed>: Lister les 16 directions abrégées en anglais ainsi que la direction variable.
angle2direction() : string: Convertit un angle en degré en une direction sur 16 valeurs.
indice2risque_uv() : string: Convertit un indice UV normalisé en une chaine correspondant à un niveau de risque.
kilometre2mile() : null|float: Convertit des kilomètres en miles.
mile2kilometre() : null|float: Convertit des miles en kilomètres.
celsius2farenheit() : null|float: Convertit des températures celsius en farenheit.
farenheit2celsius() : null|float: Convertit des températures celsius en farenheit.
millimetre2inch() : null|float: Convertit des millimètres en pouces.
millibar2inch() : null|float: Convertit des pressions millibar en pouces.
temperature2pointrosee() : null|float: Calcule la température de rosée en fonction de la température ambiente et de l'humidité (en pourcentage).
temperature2ressenti() : null|float: Calcule la température ressentie par refroidissement éolien ou l'humidex.
metre2kilometre() : null|float: Convertit en kilomètres une valeur en mètres.
metre_seconde2kilometre_heure() : null|float: Convertit en kilomètres par heure une valeur en mètres par seconde.
code_meteo2icone() : string: Calcule le chemin de l'icone local à utiliser.
rainette_debug_afficher_cache() : string: Affiche de façon lisible le cache d'une requête d'un service donné en utilisant la fonction `bel_env()`.
rainette_debug_comparer_services() : array<string|int, mixed>: Construit un tableau comparatif de la météo d'un lieu pour les différents services demandés.
rainette_debug_afficher_donnee() : string: Renvoie la chaine d'une valeur donnée de la façon la plus lisible possible.
rainette_debug_jeu_defaut() : array<string|int, mixed>: Fournit le jeu de données par défaut pour l'ensemble des services.
rainette_debug_afficher_execution() : array<string|int, mixed>: Affiche l'état d'exécution de l'ensemble des services.
rainette_debug_service_est_parametre() : bool: Vérifie pour un service, si le paramétrage utilisateur est valide afin d'utiliser le service.
rainette_debug_verifier_langue_manquante() : string: Vérifie 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_int_string() : int|string: Formate une donnée qui peut soit être une chaine soit un nombre.
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>: Complète et normalise la partie additionnelle du bloc d'erreur.
erreur_formater_texte() : array<string|int, mixed>: Formate le texte d'erreur affiché dans la boite d'alerte.
periodicite_determiner() : int: Détermine la périodicité par défaut d'un type de modèle pour un service donné.
periodicite_est_compatible() : bool: Vérifie, pour un type de modèle, si la périodicité proposée est compatible.
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() : array<string|int, mixed>: Normalise la chaine représentant le lieu et renvoie son format d'expression (lat/lon, adresse IP, etc.).
lieu_format_verifier_compatibilite() : bool: Vérifie que le format du lieu est bien supporté par l'API du service.
langue_service_determiner() : string: Détermine la langue d'acquisition du résumé météorologique via l'API du service.
langue_spip_determiner() : string: Détermine la langue utilisée par spip, à savoir, soit celle de la page qui affiche la météo, soit celle du site.
langue_spip_lister_modules() : array<string|int, mixed>: Collectionne les langues traduites par des modules de langues spip.
configuration_service_lire() : array<string|int, mixed>: Renvoie pour un service, la configuration du bloc général du service et d'un éventuel autre bloc correspondant en général à un mode météo ou toute la configuration.
configuration_donnees_normaliser() : array<string|int, mixed>: Normalise le bloc de configuration des données de service d'un mode donné.
parametrage_service_lire() : array<string|int, mixed>: Renvoie pour un service, le paramétrage utilisateur ou vide si le service n'a pas encore été paramétré.
parametrage_service_est_valide() : bool: Vérifie pour un service, si le paramétrage utilisateur est valide afin d'utiliser le service.
parametrage_service_normaliser() : array<string|int, mixed>: Renvoie la configuration utilisateur d'un service après l'avoir complétée par la configuration par défaut quand cela est nécessaire.
icone_normaliser_chemin() : string: Construit le chemin complet d'un icone disponible localement dans un thème donné.
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. Chaque appel est comptabilisé et logé dans une meta.
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 limité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() : void: Enregistre en meta la configuration générale de Rainette ainsi que celle de tous les services disponibles.
configuration_technique_charger() : array<string|int, mixed>: Renvoie la configuration générale de Rainette extraite de son fichier YAML.
configuration_service_charger() : array<string|int, mixed>: Normalise et renvoie la configuration d'un service donné extraite de son fichier YAML.
configuration_service_initialiser() : array<string|int, mixed>: Initialise la configuration d'un service donné.
balise_RAINETTE_INFOS() : Champ: Compile la balise `#RAINETTE_INFOS` qui renvoie une information ou toutes les informations liées à un lieu pour un service donné.
calculer_infos() : mixed: Renvoie une information sur un lieu pour un service donné ou toutes les informations de ce lieu.
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: Convertit 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() : string: Renvoie le nom littéral du service à partir de sa configuration stockée en meta.
rainette_service_defaut() : string: Renvoie le nom abrégé du service par défaut de Rainette.
rainette_service_est_indisponible() : string: Retourne la disponibilité d'un service donné.
rainette_lister_services() : array<string|int, mixed>|string: Liste des services disponibles.
rainette_lister_modeles() : array<string|int, mixed>: Renvoie la liste des modèles disponibles correspondant à un mode météo et une périodicité donnée.
rainette_lister_themes() : array<string|int, mixed>: Liste les thèmes disponibles pour un service donné.
rainette_coasser() : string: Affiche avec un modèle choisi, en utilisant un service donné, les informations météorologiques d'un lieu.
rainette_ieconfig_metas() : array<string|int, mixed>: Ajoute les metas sauvegardables de Rainette pour utiliser le plugin IEConfig.
rainette_insert_head_css() : string: Inserer la CSS par défaut pour styler les modèles par défaut de Rainette.
rainette_insert_head() : string: Permet d’ajouter des contenus dans la partie `<head>` des pages de l’espace public.
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: Lit le bloc de réponse potentiellement constitutif d'une erreur pour déterminer si la requête est réellement en échec.
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.
etat2resume_accuweather() : array<string|int, mixed>: Calcule les états en fonction des états météorologiques natifs fournis par le service.
aeris_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...).
aeris_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.
aeris_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.
aeris_flux2flux() : array<string|int, mixed>: Modifie le flux des prévisions issu directement du service pour qu'il puisse être conforme à la logique de normalisation qui s'en suivra.
aeris_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_aeris() : array<string|int, mixed>: Calcule les états en fonction des états météorologiques natifs fournis par le service.
meteoconcept_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...).
meteoconcept_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.
meteoconcept_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.
meteoconcept_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.
meteoconcept_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_meteoconcept() : array<string|int, mixed>: Calcule les états en fonction des états météorologiques natifs fournis par le service.
openmeteo_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...).
openmeteo_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.
openmeteo_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.
openmeteo_flux2flux() : array<string|int, mixed>: Modifie le flux des prévisions issu directement du service pour qu'il puisse être conforme à la logique de normalisation qui s'en suivra.
openmeteo_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_openmeteo() : array<string|int, mixed>: Calcule les états en fonction des états météorologiques natifs fournis par le service.
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.
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: Lit le bloc de réponse potentiellement constitutif d'une erreur pour déterminer si la requête est réellement en échec.
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.
etat2resume_weatherapi() : array<string|int, mixed>: Calcule les états en fonction des états météorologiques natifs fournis par le service.
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: Lit le bloc de réponse potentiellement constitutif d'une erreur pour déterminer si la requête est réellement en échec.
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.
etat2resume_weatherbit() : array<string|int, mixed>: Calcule les états en fonction des états météorologiques natifs fournis par le service.
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: Lit le bloc de réponse potentiellement constitutif d'une erreur pour déterminer si la requête est réellement en échec.
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.
etat2resume_wwo() : array<string|int, mixed>: Calcule les états en fonction des états météorologiques natifs fournis par le service.

_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_ICONE_EXTENSIONS

Liste des extensions possibles pour les icones dans l'ordre de préférence.


    public
        mixed
    _RAINETTE_ICONE_EXTENSIONS
    = ['png', 'svg']

_RAINETTE_ICONE_GRANDE_TAILLE


    public
        mixed
    _RAINETTE_ICONE_GRANDE_TAILLE
    = 110

_RAINETTE_ICONE_NOM_NA

Nom de l'icone n/a par défaut si le thème ne le fournit pas.


    public
        mixed
    _RAINETTE_ICONE_NOM_NA
    = 'na'

_RAINETTE_ICONE_NOM_VIDE

Nom de l'icone vide par défaut.


    public
        mixed
    _RAINETTE_ICONE_NOM_VIDE
    = 'icone-vide'

_RAINETTE_ICONE_PETITE_TAILLE


    public
        mixed
    _RAINETTE_ICONE_PETITE_TAILLE
    = 28

_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_PWSID

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


    public
        mixed
    _RAINETTE_REGEXP_LIEU_PWSID
    = '#PWS_[\w]+#'

_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'

_RAINETTE_SERVICE_DEFAUT


    public
        mixed
    _RAINETTE_SERVICE_DEFAUT
    = 'owm'

action_effacer_parametrage_dist()

Cette action permet à l'utilisateur d'effacer le paramétrage utioisateur d'un service.


    
                    action_effacer_parametrage_dist() : void

Cette action est réservée aux utilisateurs pouvant accéder à la configuration. Elle ne nécessite comme argument uniquement l'id du service.

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.

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.

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[, null|string $mode = 'conditions' ][, null|string $service = '' ][, null|array<string|int, mixed> $options = [] ]) : 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 mais non normalisé.

$mode : null|string = 'conditions'

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

conditions, la valeur par défaut
previsions
infos

$service : null|string = ''

Le nom abrégé du service :

owm pour OpenWeather, la valeur par défaut
weatherbit pour Weatherbit.io
weatheapi pour WeatherAPI
accuweather pour AccuWeather
aeris pour AerisWeather
openmeteo pour OpenMeteo
wwo pour World Weather Online
meteoconcept pour Meteo-Concept

$options : null|array<string|int, mixed> = []

Options pour l'acquisition des données météo : La périodicité horaire des prévisions (periodicite) :

24, les prévisions de la journée (défaut pour le mode prévisions)
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 La langue du résumé méteo (langue) : par défaut la langue spip de la page L'indicateur du mode de lancement du chargement (via_job) : Prend les valeurs 'on' pour indiquer que l'appel vient d'un job et '' sinon (défaut). Cette information ne sert qu'au pipeline post_chargement_meteo

Return values

array<string|int, mixed> —

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

lister_directions()

Lister les 16 directions abrégées en anglais ainsi que la direction variable.


    
                    lister_directions() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Liste des directions abrégées.

angle2direction()

Convertit un angle en degré en une direction sur 16 valeurs.


    
                    angle2direction([null|int $angle = null ]) : string

Parameters

$angle : null|int = null: Angle du vent exprimé en degrés.

Return values

string —

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

indice2risque_uv()

Convertit un indice UV normalisé en une chaine correspondant à un niveau de risque.


    
                    indice2risque_uv([null|float $indice_uv = null ]) : string

Parameters

$indice_uv : null|float = null: 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()

Convertit des kilomètres en miles.


    
                    kilometre2mile([null|float $kilometre = null ]) : null|float

Parameters

$kilometre : null|float = null: La valeur réelle en kilomètres.

Return values

null|float —

La valeur réelle correspondante convertie en miles

mile2kilometre()

Convertit des miles en kilomètres.


    
                    mile2kilometre([null|float $miles = null ]) : null|float

Parameters

$miles : null|float = null: La valeur réelle en miles.

Return values

null|float —

La valeur réelle correspondante convertie en kilomètres

celsius2farenheit()

Convertit des températures celsius en farenheit.


    
                    celsius2farenheit([null|int $celsius = null ]) : null|float

Parameters

$celsius : null|int = null: La valeur réelle en degrés celsius.

Return values

null|float —

La valeur réelle correspondante convertie en farenheit.

farenheit2celsius()

Convertit des températures celsius en farenheit.


    
                    farenheit2celsius([null|int $farenheit = null ]) : null|float

Parameters

$farenheit : null|int = null: La valeur réelle en degrés celsius.

Return values

null|float —

La valeur réelle correspondante convertie en farenheit.

millimetre2inch()

Convertit des millimètres en pouces.


    
                    millimetre2inch([null|float $millimetre = null ]) : null|float

Parameters

$millimetre : null|float = null: La valeur réelle en millimètres

Return values

null|float —

La valeur réelle correspondante convertie en pouces.

millibar2inch()

Convertit des pressions millibar en pouces.


    
                    millibar2inch([null|float $millibar = null ]) : null|float

Parameters

$millibar : null|float = null: La valeur réelle en millibars

Return values

null|float —

La valeur réelle correspondante convertie en pouces.

temperature2pointrosee()

Calcule la température de rosée en fonction de la température ambiente et de l'humidité (en pourcentage).


    
                    temperature2pointrosee([null|float $temperature = null ][, null|float $humidite = null ][, null|string $unite = 'm' ]) : null|float

On utilise la formule de Heinrich Gustav Magnus-Tetens.

Parameters

$temperature : null|float = null: Température réelle mesurée en celsius.
$humidite : null|float = null: Pourcentage d'humidité.
$unite : null|string = 'm': Système d'unité métrique (m, défaut) ou impérial (s)

Return values

null|float —

La température du point de rosée.

temperature2ressenti()

Calcule la température ressentie par refroidissement éolien ou l'humidex.


    
                    temperature2ressenti([null|float $temperature = null ][, null|float $vitesse_vent = null ][, null|float $point_rosee = null ][, null|string $unite = 'm' ]) : null|float

Le calcul par refroidissement éolien 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 l'indice humidex la température réelle fournie en entrée. Les calculs nécessitent des données en système métrique.

Parameters

$temperature : null|float = null: Température réelle.
$vitesse_vent : null|float = null: Vitesse du vent.
$point_rosee : null|float = null: Température de rosée.
$unite : null|string = 'm': Système d'unité métrique (m, défaut) ou impérial (s)

Return values

null|float —

'Température ressentie' (indice) arrondie à la première décimale

metre2kilometre()

Convertit en kilomètres une valeur en mètres.


    
                    metre2kilometre([null|int $metre = null ]) : null|float

Parameters

$metre : null|int = null: La valeur entière en mètres

Return values

null|float —

La valeur correspondante convertie en kilomètres.

metre_seconde2kilometre_heure()

Convertit en kilomètres par heure une valeur en mètres par seconde.


    
                    metre_seconde2kilometre_heure([null|float $vitesse_vent = null ]) : null|float

Parameters

$vitesse_vent : null|float = null: Vitesse du vent en mètres par seconde.

Return values

null|float —

La valeur correspondante convertie en kilomètres par heure.

code_meteo2icone()

Calcule le chemin de l'icone local à utiliser.


    
                    code_meteo2icone(int|string $code, int $periode, array<string|int, mixed> $parametres_icone) : string

La fonction considère qu'au moment où elle est appelée, les données code et periode sont correctement remplis par le service (nativement ou par complétion).

Parameters

$code : int|string

Code méteo retourné par le service et servant d'index pour définir l'icone.

$periode : int

Indicateur jour (0) ou nuit (1) et utilisé si les icones différent suivant la période.

$parametres_icone : array<string|int, mixed>

Tableau de paramètres identifiant comment choisir l'icone :

service : le nom du service dont est issu le code.
transcodages : les tableaux de transcodages code / icone du service
theme_origine : le type de thème parmi 'local', 'weather', 'wmo' (index de transcodage)
theme_id : l'id du thème
periode_stricte : indique qu'on ne cherche que l'icone de la période (défaut false)

Return values

string —

Le chemin de l'icone

rainette_debug_afficher_cache()

Affiche de façon lisible le cache d'une requête d'un service donné en utilisant la fonction `bel_env()`.


    
                    rainette_debug_afficher_cache(string $lieu[, null|string $mode = 'previsions' ][, null|string $service = '' ][, null|string $langue = '' ]) : string

Parameters

$lieu : string: Le lieu concerné par la méteo exprimé selon les critères requis par le service.
$mode : null|string = 'previsions': Le type de données météorologiques demandé.
$service : null|string = '': Le nom abrégé du service.
$langue : null|string = '': Code de langue spip indiquant langue choisie pour afficher les données météo.

Return values

string

rainette_debug_comparer_services()

Construit un tableau comparatif de la météo d'un lieu pour les différents services demandés.


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

Parameters

$mode : null|string = 'conditions': Le type de données météorologiques demandé.
$langue : null|string = '': Code de langue spip indiquant langue choisie pour afficher les données météo.
$jeu : null|array<string|int, mixed> = []: Jeu de données sous la forme [service] = lieu. Le lieu doit être le même exprimé sous la forme recommandée par le service.

Return values

array<string|int, mixed> —

Le tableau de comparaison indexé par chaque service

rainette_debug_afficher_donnee()

Renvoie la chaine d'une valeur donnée de la façon la plus lisible possible.


    
                    rainette_debug_afficher_donnee(string $donnee, array<string|int, mixed> $valeur[, null|string $service = '' ]) : string

Parameters

$donnee : string: Type de la donnée
$valeur : array<string|int, mixed>: Valeur de la donnée
$service : null|string = '': Le nom abrégé du service.

Return values

string —

Chaine à afficher pour fournir l'information la plus précise possible sur la donnée.

rainette_debug_jeu_defaut()

Fournit le jeu de données par défaut pour l'ensemble des services.


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

Paris est utilisé comme le lieu par défaut.

Return values

array<string|int, mixed>

rainette_debug_afficher_execution()

Affiche l'état d'exécution de l'ensemble des services.


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

Return values

array<string|int, mixed>

rainette_debug_service_est_parametre()

Vérifie pour un service, si le paramétrage utilisateur est valide afin d'utiliser le service.


    
                    rainette_debug_service_est_parametre(string $service) : bool

Encapsule la fonction parametrage_service_est_valide().

Parameters

$service : string: Le nom abrégé du service.

Return values

bool —

true si valide, false sinon.

rainette_debug_verifier_langue_manquante()

Vérifie si la liste des langues de SPIP a changé et qu'il faut modifier la config rainette.


    
                    rainette_debug_verifier_langue_manquante() : string

Return values

string —

Texte fournissant la liste des langues manquantes.

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> $flux, string $langue, array<string|int, mixed> $configuration_mode, array<string|int, mixed> $configuration_service[, null|int $periode = -1 ]) : array<string|int, mixed>

Parameters

$flux : array<string|int, mixed>: Le tableau brut des données météorologiques issu de l'appel au service.
$langue : string: Code de langue spip indiquant langue choisie pour afficher les données météo. Suivant le service il est possible que cette langue ne soit pas disponible nativement.
$configuration_mode : array<string|int, mixed>: Configuration technique des données pour le mode concerné
$configuration_service : array<string|int, mixed>: Configuration statique et utilisateur du service ayant retourné le flux de données.
$periode : null|int = -1: 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_int_string()

Formate une donnée qui peut soit être une chaine soit un nombre.


    
                    donnee_formater_int_string(string $donnee) : int|string

C'est le cas du code méteo.

Parameters

$donnee : string: Correspond à un index du tableau associatif standardisé à formater en date standard.

Return values

int|string —

Donnée nombre ou chaine.

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(float $donnee) : bool

Parameters

$donnee : float: 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()

Complète et normalise la partie additionnelle du bloc d'erreur.


    
                    erreur_normaliser_extras(array<string|int, mixed> $erreur, string $lieu_id, string $mode, string $service, int $periodicite[, null|array<string|int, mixed> $configuration = [] ]) : array<string|int, mixed>

Parameters

$erreur : array<string|int, mixed>: Bloc d'erreur brut fourni par la fonction de chargement
$lieu_id : string: L'id normalisé du lieu concerné par la méteo exprimé selon les critères requis par le service.
$mode : string: Le type de données météorologiques demandé.
$service : string: Le nom abrégé du service.
$periodicite : int: La périodicité horaire des prévisions uniquement (0 si le mode est différent).
$configuration : null|array<string|int, mixed> = []: Configuration du service

Return values

array<string|int, mixed> —

Bloc d'erreur complété

erreur_formater_texte()

Formate le texte d'erreur affiché dans la boite d'alerte.


    
                    erreur_formater_texte(array<string|int, mixed> $erreur, string $lieu_id, string $mode, string $service, string $modele, string $nom_service) : array<string|int, mixed>

Parameters

$erreur : array<string|int, mixed>: Bloc d'erreur brut fourni par la fonction de chargement
$lieu_id : string: L'id normalisé du lieu concerné par la méteo exprimé selon les critères requis par le service.
$mode : string: Le type de données météorologiques demandé.
$service : string: Le nom abrégé du service.
$modele : string: Le modèle utilisé pour afficher la météo.
$nom_service : string: Nom littéral du service

Return values

array<string|int, mixed> —

Texte de l'erreur pour affichage sous la forme d'un tableau à 3 index, service, principal et conseil.

periodicite_determiner()

Détermine la périodicité par défaut d'un type de modèle pour un service donné.


    
                    periodicite_determiner(string $type_modele, string $service) : int

Parameters

$type_modele : string: Type de modèle.
$service : string: Le nom abrégé du service.

Return values

int —

Périodicité calculée.

periodicite_est_compatible()

Vérifie, pour un type de modèle, si la périodicité proposée est compatible.


    
                    periodicite_est_compatible(string $type_modele, int $periodicite) : bool

Parameters

$type_modele : string: Type de modèle.
$periodicite : int: La périodicité horaire des prévisions uniquement (0 si le ode est différent).

Return values

bool —

true si compatible, false sinon.

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_id, string $mode, int $periodicite, string $langue, array<string|int, mixed> $configuration_service) : array<string|int, mixed>

Parameters

$lieu_id : string

Id normalisé du 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

$langue : string

Code de langue spip représentant la langue dans laquelle le résumé calculé sera fournit.

$configuration_service : array<string|int, mixed>

Configuration complète du service, statique et utilisateur.

Return values

array<string|int, mixed> —

Chemin complet du fichier cache.

lieu_normaliser()

Normalise la chaine représentant le lieu et renvoie son format d'expression (lat/lon, adresse IP, etc.).


    
                    lieu_normaliser(string $lieu) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed> —

La chaine du lieu prête à être utilisée dans une requête et le format du lieu

lieu_format_verifier_compatibilite()

Vérifie que le format du lieu est bien supporté par l'API du service.


    
                    lieu_format_verifier_compatibilite(string $format, string $service) : bool

Parameters

$format : string: Identifiant du format de lieu.
$service : string: Identifiant du service.

Return values

bool —

true si la format est supporté, false sinon.

langue_service_determiner()

Détermine la langue d'acquisition du résumé météorologique via l'API du service.


    
                    langue_service_determiner(string $langue, array<string|int, mixed> $configuration_service) : string

Ce n'est pas forcément la langue d'affichage du résumé si le service ne fournit pas la traduction demandée.

Parameters

$langue : string: Code de langue spip indiquant langue choisie pour afficher les données météo. Suivant le service il est possible que cette langue ne soit pas disponible nativement, la fonction se rabat alors sur un backup.
$configuration_service : array<string|int, mixed>: Configuration complète du service, statique et utilisateur.

Return values

string —

Code de langue spip

langue_spip_determiner()

Détermine la langue utilisée par spip, à savoir, soit celle de la page qui affiche la météo, soit celle du site.


    
                    langue_spip_determiner() : string

Return values

string —

Code de langue spip

langue_spip_lister_modules()

Collectionne les langues traduites par des modules de langues spip.


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

Pour un service donné, le module de langue coincide avec l'identifiant du service.

Parameters

$service : string: Identifiant du service.

Return values

array<string|int, mixed> —

Liste des codes de langue spip

configuration_service_lire()

Renvoie pour un service, la configuration du bloc général du service et d'un éventuel autre bloc correspondant en général à un mode météo ou toute la configuration.


    
                    configuration_service_lire(string $service[, null|string $bloc = '' ]) : array<string|int, mixed>

Parameters

$service : string: Le nom abrégé du service.
$bloc : null|string = '': Index désignant le bloc de configuration à retourner. Si infos, conditions, prévisions ou erreurs, on retourne ce bloc en plus du bloc service. Si service, seul le bloc service est retourné. Si vide ou incorrect toute la configuration est retournée.

Return values

array<string|int, mixed> —

Extrait de la configuration demandé.

configuration_donnees_normaliser()

Normalise le bloc de configuration des données de service d'un mode donné.


    
                    configuration_donnees_normaliser(string $mode, array<string|int, mixed> $configuration_service) : array<string|int, mixed>

Parameters

$mode : string: Le type de données météorologiques demandé.
$configuration_service : array<string|int, mixed>: Configuration de la source des données.

Return values

array<string|int, mixed> —

Bloc de configuration normalisé.

parametrage_service_lire()

Renvoie pour un service, le paramétrage utilisateur ou vide si le service n'a pas encore été paramétré.


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

Parameters

$service : string: Le nom abrégé du service.

Return values

array<string|int, mixed> —

Paramétrage utilisateur d'un service.

parametrage_service_est_valide()

Vérifie pour un service, si le paramétrage utilisateur est valide afin d'utiliser le service.


    
                    parametrage_service_est_valide(string $service) : bool

Parameters

$service : string: Le nom abrégé du service.

Return values

bool —

true si valide, false sinon.

parametrage_service_normaliser()

Renvoie la configuration utilisateur d'un service après l'avoir complétée par la configuration par défaut quand cela est nécessaire.


    
                    parametrage_service_normaliser(string $service, array<string|int, mixed> $configuration_defaut) : array<string|int, mixed>

Parameters

$service : string: Le nom abrégé du service.
$configuration_defaut : array<string|int, mixed>: La configuration par défaut du service.

Return values

array<string|int, mixed> —

Configuration utilisateur d'un service normalisée.

icone_normaliser_chemin()

Construit le chemin complet d'un icone disponible localement dans un thème donné.


    
                    icone_normaliser_chemin(string $icone[, null|string $service = '' ][, null|string $theme = '' ]) : string

Parameters

$icone : string: nom de l'icone
$service : null|string = '': Le nom abrégé du service.
$theme : null|string = '': Le nom d'un thème d'icones : sert aussi de sous-dossier

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. Chaque appel est comptabilisé et logé dans une meta.


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

Parameters

$url : string: URL complète de la requête formatée en fonction de la demande et du service.
$service : string: Alias 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.

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 limité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)

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

rainette_configurer()

Enregistre en meta la configuration générale de Rainette ainsi que celle de tous les services disponibles.


    
                    rainette_configurer() : void

configuration_technique_charger()

Renvoie la configuration générale de Rainette extraite de son fichier YAML.


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

Parameters

$fichier_config : null|string = '': Fichier de configuration YAML de Rainette pour optimiser le traitement. Si vide on le cherche dans le path.

Return values

array<string|int, mixed> —

Tableau de configuration de Rainette.

configuration_service_charger()

Normalise et renvoie la configuration d'un service donné extraite de son fichier YAML.


    
                    configuration_service_charger(string $service[, null|string $fichier_config = '' ]) : array<string|int, mixed>

Parameters

$service : string: Le nom abrégé du service
$fichier_config : null|string = '': Fichier de configuration YAML de Rainette pour optimiser le traitement. Si vide on le cherche dans le path.

Return values

array<string|int, mixed>

configuration_service_initialiser()

Initialise la configuration d'un service donné.


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

Parameters

$service : string: Le nom abrégé du service

Return values

array<string|int, mixed>

balise_RAINETTE_INFOS()

Compile la balise `#RAINETTE_INFOS` qui renvoie une information ou toutes les informations liées à un lieu pour un service donné.


    
                    balise_RAINETTE_INFOS(Champ $p) : Champ

La signature de la balise est : #RAINETTE_INFOS{lieu[, info, service, langue]}.

Parameters

$p : Champ: Pile au niveau de la balise.

Return values

Champ —

Pile complétée par le code à générer.

calculer_infos()

Renvoie une information sur un lieu pour un service donné ou toutes les informations de ce lieu.


    
                    calculer_infos(string $lieu, string $type, string $service, string $langue) : mixed

Parameters

$lieu : string: Le lieu concerné par la méteo exprimé selon les critères requis par le service.
$type : string: Le type d'information à retourner ou vide si on veut toute les informations
$service : string: Le nom abrégé du service.
$langue : string: Code de langue spip indiquant langue choisie pour afficher les données météo. Pour l'instant non utilisé car aucune donnée d'infos n'est traduite.

Return values

mixed —

L'information ou le tableau de toutes les informations d'un service

rainette_afficher_icone()

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


    
                    rainette_afficher_icone(array<string|int, mixed> $icone[, null|int|string $taille = 'petit' ][, null|array<string|int, mixed> $options = [] ]) : string

Parameters

$icone : array<string|int, mixed>: Tableau informatif sur l'icone
$taille : null|int|string = 'petit': Taille de l'icone : prend les valeurs petit (défaut) ou grand ou une valeur entière.
$options : null|array<string|int, mixed> = []: Liste d'options comme la classe CSS à rajouter à la balise img

Return values

string —

Balise img correspondant à l'affichage de l'icone

rainette_afficher_resume()

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


    
                    rainette_afficher_resume([null|string $resume = null ]) : 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 : null|string = null: Résumé météo déjà fourni ou calculé par le service dans la langue de l'interface. Peut-être null si le service ne renvoie aucun résumé affichable.

Return values

string

rainette_afficher_direction()

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


    
                    rainette_afficher_direction(string $direction) : string

Parameters

$direction : string: 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.

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(null|string $tendance_en[, null|string $methode = 'texte' ]) : string

Parameters

$tendance_en : null|string

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

$methode : null|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.

Return values

string —

Texte de la tendance conforme à la méthode prescrite.

rainette_afficher_unite()

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


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

Parameters

$valeur : null|float|int: La valeur à afficher
$type_donnee : null|string = '': Type de données à afficher parmi 'temperature', 'pourcentage', 'angle', 'pression', 'distance', 'vitesse', 'population', 'precipitation'.
$precision : null|int = -1: Nombre de décimales à afficher pour les réels uniquement ou -1 pour utiliser le défaut.
$service : null|string = '': Identifiant du service utilisé. Si non fourni, on prend le service par défaut

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()

Renvoie le nom littéral du service à partir de sa configuration stockée en meta.


    
                    rainette_afficher_service(string $service) : string

Par défaut, renvoie le nom abrégé si pas de nom littéral.

Parameters

$service : string: Le nom abrégé du service.

Return values

string —

Texte correspodnant au nom du service

rainette_service_defaut()

Renvoie le nom abrégé du service par défaut de Rainette.


    
                    rainette_service_defaut() : string

Return values

string —

Nom abrégé du service

rainette_service_est_indisponible()

Retourne la disponibilité d'un service donné.


    
                    rainette_service_est_indisponible(string $service) : string

Parameters

$service : string: Le nom abrégé du service.

Return values

string —

Identifiant de l'erreur ou chaine vide si disponible.

rainette_lister_services()

Liste des services disponibles.


    
                    rainette_lister_services([null|string $type_sortie = 'tableau' ][, null|bool $filtre_actif = true ][, null|bool $filtre_parametre = false ]) : array<string|int, mixed>|string

Il est possible de filtrer les services actifs uniquement. La liste est retournée soit sous la forme d'n tableau soit sous la forme d'une chaine dont les services sont séparés par une virgule.

Parameters

$type_sortie : null|string = 'tableau': Sortie de type tableau ou liste séparée par une virgule
$filtre_actif : null|bool = true: Indique si la liste est filtrée sur les seuls services actifs
$filtre_parametre : null|bool = false: Indique si la liste est filtrée sur les seuls services correctement paramétrés

Return values

array<string|int, mixed>|string —

Liste des services

rainette_lister_modeles()

Renvoie la liste des modèles disponibles correspondant à un mode météo et une périodicité donnée.


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

La périodicité n'est disponible que pour les prévisions.

Parameters

$mode : null|string = 'conditions': Le type de données météorologiques demandé.
$periodicite : null|int = 24: La périodicité horaire, pour les prévisions uniquement.

Return values

array<string|int, mixed> —

Liste des modèles

rainette_lister_themes()

Liste les thèmes disponibles pour un service donné.


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

Il est possible de filtrer selon la source des thèmes.

Parameters

$service : string: Le nom abrégé du service.
$source : null|string = 'local': Source des thèmes : local ou api.

Return values

array<string|int, mixed> —

Liste des thèmes

rainette_coasser()

Affiche avec un modèle choisi, en utilisant un service donné, les informations météorologiques d'un lieu.


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

L'affichage peut être modifié par des otpions supplémentaires.

Parameters

$lieu : string: Le lieu concerné par la méteo exprimé selon les critères requis par le service mais non normalisé.
$mode : null|string = 'conditions': Le type de données météorologiques demandé.
$service : null|string = '': Le nom abrégé du service.
$options : null|array<string|int, mixed> = []: Options d'affichage du modèle : modèle, premier jour, nombre de jours, périodicité, etc.

Return values

string —

Code HTML à afficher

rainette_ieconfig_metas()

Ajoute les metas sauvegardables de Rainette pour utiliser le plugin IEConfig.


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

Parameters

$table : array<string|int, mixed>: Table des déclarations des sauvegardes

Return values

array<string|int, mixed> —

Table des déclarations complétée

rainette_insert_head_css()

Inserer la CSS par défaut pour styler les modèles par défaut de Rainette.


    
                    rainette_insert_head_css(string $flux) : string

Parameters

$flux : string: Code html des styles CSS à charger

Return values

string —

Code html complété.

rainette_insert_head()

Permet d’ajouter des contenus dans la partie `<head>` des pages de l’espace public.


    
                    rainette_insert_head(string $flux) : string

Pour le plugin, il permet de charger les CSS.

Parameters

$flux : string: Contenu HTML du header

Return values

string —

Code html complété.

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(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 :

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

Return values

string —

URL complète de la requête.

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


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

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

Return values

array<string|int, mixed> —

Tableau standardisé des conditions météorologiques complété par les données spécifiques au 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évisions (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, 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

Return values

array<string|int, mixed> —

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

etat2resume_accuweather()

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


    
                    etat2resume_accuweather(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.

Return values

array<string|int, mixed> —

Tableau standard mis à jour.

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


    
                    aeris_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 (mettre la bonne liste des périodicités acceptées)
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.

Return values

string —

URL complète de la requête.

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


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

aeris_complement2conditions()

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


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

Return values

array<string|int, mixed> —

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

aeris_flux2flux()

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


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

Parameters

$flux : array<string|int, mixed>: Flux non normalisé provenant du service
$mode : string: Type de données météorologiques. Les valeurs possibles sont infos, conditions ou previsions.
$periodicite : int: Périodicité horaire des prévisions (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é

aeris_complement2previsions()

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


    
                    aeris_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

Return values

array<string|int, mixed> —

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

etat2resume_aeris()

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


    
                    etat2resume_aeris(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.

Return values

array<string|int, mixed> —

Tableau standard mis à jour.

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


    
                    meteoconcept_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 (mettre la bonne liste des périodicités acceptées)
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. *

Return values

string —

URL complète de la requête.

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


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

meteoconcept_complement2infos()

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


    
                    meteoconcept_complement2infos(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.

Return values

array<string|int, mixed> —

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

meteoconcept_complement2conditions()

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


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

Return values

array<string|int, mixed> —

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

meteoconcept_complement2previsions()

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


    
                    meteoconcept_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

Return values

array<string|int, mixed> —

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

etat2resume_meteoconcept()

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


    
                    etat2resume_meteoconcept(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.

Return values

array<string|int, mixed> —

Tableau standard mis à jour.

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


    
                    openmeteo_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 (mettre la bonne liste des périodicités acceptées)
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. *

Return values

string —

URL complète de la requête.

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


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

openmeteo_complement2conditions()

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


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

Return values

array<string|int, mixed> —

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

openmeteo_flux2flux()

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


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

Parameters

$flux : array<string|int, mixed>: Flux non normalisé provenant du service
$mode : string: Type de données météorologiques. Les valeurs possibles sont infos, conditions ou previsions.
$periodicite : int: Périodicité horaire des prévisions (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é

openmeteo_complement2previsions()

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


    
                    openmeteo_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

Return values

array<string|int, mixed> —

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

etat2resume_openmeteo()

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


    
                    etat2resume_openmeteo(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.

Return values

array<string|int, mixed> —

Tableau standard mis à jour.

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.

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.

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

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.

Return values

array<string|int, mixed> —

Tableau standard mis à jour.

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

Return values

string —

URL complète de la requête.

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


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

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

Return values

array<string|int, mixed> —

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

Return values

array<string|int, mixed> —

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

etat2resume_weatherapi()

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


    
                    etat2resume_weatherapi(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.

Return values

array<string|int, mixed> —

Tableau standard mis à jour.

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(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, 3 ou 1 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.

Return values

string —

URL complète de la requête.

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


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

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

Return values

array<string|int, mixed> —

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

Return values

array<string|int, mixed> —

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

etat2resume_weatherbit()

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


    
                    etat2resume_weatherbit(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.

Return values

array<string|int, mixed> —

Tableau standard mis à jour.

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(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, 12, 3, 1 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.

Return values

string —

URL complète de la requête.

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


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

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

Return values

array<string|int, mixed> —

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

Return values

array<string|int, mixed> —

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

etat2resume_wwo()

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


    
                    etat2resume_wwo(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.

Return values

array<string|int, mixed> —

Tableau standard mis à jour.

API Documentation

Table of Contents

Constants

Functions

Constants

_RAINETTE_DEBUG

_RAINETTE_DEBUG_CLES_PREVISIONS

_RAINETTE_ICONE_EXTENSIONS

_RAINETTE_ICONE_GRANDE_TAILLE

_RAINETTE_ICONE_NOM_NA

_RAINETTE_ICONE_NOM_VIDE

_RAINETTE_ICONE_PETITE_TAILLE

_RAINETTE_REGEXP_LIEU_COORDONNEES

_RAINETTE_REGEXP_LIEU_INSEE_ID

_RAINETTE_REGEXP_LIEU_IP

_RAINETTE_REGEXP_LIEU_PWSID

_RAINETTE_REGEXP_LIEU_WEATHER_ID

_RAINETTE_SERVICE_DEFAUT

Functions

action_effacer_parametrage_dist()

action_recharger_configuration_dist()

rainette_cache_configurer()

Parameters

Return values

rainette_meteo_cache_formulaire_charger()

Parameters

Tags

Return values

formulaires_configurer_rainette_service_charger()

Parameters

Return values

inc_meteo_charger_dist()

Parameters

Tags

Return values

lister_directions()

Return values

angle2direction()

Parameters

Return values

indice2risque_uv()

Parameters

Tags

Return values

kilometre2mile()

Parameters

Return values

mile2kilometre()

Parameters

Return values

celsius2farenheit()

Parameters

Return values

farenheit2celsius()

Parameters

Return values

millimetre2inch()

Parameters

Return values

millibar2inch()

Parameters

Return values

temperature2pointrosee()

Parameters

Return values

temperature2ressenti()

Parameters

Return values

metre2kilometre()

Parameters

Return values

metre_seconde2kilometre_heure()

Parameters

Return values

code_meteo2icone()

Parameters

Tags

Return values

rainette_debug_afficher_cache()

Parameters