Rainette

rainette_fonctions.php

Constants

_RAINETTE_ICONE_GRANDE_TAILLE = 110
_RAINETTE_ICONE_PETITE_TAILLE = 28
_RAINETTE_SERVICE_DEFAUT = 'owm'

Functions

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_ICONE_GRANDE_TAILLE


    public
        mixed
    _RAINETTE_ICONE_GRANDE_TAILLE
    = 110

_RAINETTE_ICONE_PETITE_TAILLE


    public
        mixed
    _RAINETTE_ICONE_PETITE_TAILLE
    = 28

_RAINETTE_SERVICE_DEFAUT


    public
        mixed
    _RAINETTE_SERVICE_DEFAUT
    = 'owm'

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_fonctions.php

Table of Contents

Constants

Functions

Constants

_RAINETTE_ICONE_GRANDE_TAILLE

_RAINETTE_ICONE_PETITE_TAILLE

_RAINETTE_SERVICE_DEFAUT

Functions

balise_RAINETTE_INFOS()

Parameters

Tags

Return values

calculer_infos()

Parameters

Tags

Return values

rainette_afficher_icone()

Parameters

Tags

Return values

rainette_afficher_resume()

Parameters

Tags

Return values

rainette_afficher_direction()

Parameters

Tags

Return values

rainette_afficher_tendance()

Parameters

Tags

Return values

rainette_afficher_unite()

Parameters

Tags

Return values

rainette_afficher_service()

Parameters

Tags

Return values

rainette_service_defaut()

Tags

Return values

rainette_service_est_indisponible()

Parameters

Tags

Return values

rainette_lister_services()

Parameters

Tags

Return values

rainette_lister_modeles()

Parameters

Return values

rainette_lister_themes()

Parameters

Return values

rainette_coasser()

Parameters

Return values