RAINETTEAFFICHAGE
Table of Contents
Functions
- 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.
Functions
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) ougrandou une valeur entière. - $options : null|array<string|int, mixed> = []
-
Liste d'options comme la classe CSS à rajouter à la balise img
Tags
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.
Tags
Return values
stringrainette_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.
Tags
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.
-
Tags
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
Tags
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.
Tags
Return values
string —Texte correspodnant au nom du service