Application
Table of Contents
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_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.
- 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.
- 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_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.
Constants
_RAINETTE_DEBUG
Activation ou désactivation des traces de debug.
public
mixed
_RAINETTE_DEBUG
= \false
_RAINETTE_DEBUG_CLES_PREVISIONS
Clé jour par défaut utilisée pour afficher les prévisions : jour suivant.
public
mixed
_RAINETTE_DEBUG_CLES_PREVISIONS
= '1'
_RAINETTE_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_SERVICE_DEFAUT
public
mixed
_RAINETTE_SERVICE_DEFAUT
= 'owm'
Functions
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.
Tags
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.
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
Tags
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)
Tags
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
stringrainette_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.
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.
Tags
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.
Tags
Return values
mixed —L'information ou le tableau de toutes les informations d'un service
rainette_service_defaut()
Renvoie le nom abrégé du service par défaut de Rainette.
rainette_service_defaut() : string
Tags
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.
Tags
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
Tags
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
ouapi
.
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
Tags
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
Tags
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
Tags
Return values
string —Code html complété.