Changeset 108073 in spip-zone


Ignore:
Timestamp:
Dec 17, 2017, 9:55:20 AM (19 months ago)
Author:
eric@…
Message:

PHPDoc et prototype de la fonction lieu_normaliser

Location:
_plugins_/rainette/trunk
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/rainette/trunk/inc/meteo_charger.php

    r108067 r108073  
    3434 *            - `24`, les prévisions de la journée
    3535 *            - `12`, les prévisions du jour et de la nuit
    36  *            - `6`, les prévisions de la journée par période de 4h
     36 *            - `6`, les prévisions de la journée par période de 6h
    3737 *            - `3`, les prévisions de la journée par période de 3h
    3838 *            - `1`, les prévisions de la journée pour chaque heure
  • _plugins_/rainette/trunk/inc/rainette_normaliser.php

    r108067 r108073  
    330330 *
    331331 * @return array
    332  *        Le tableau standardisés des données météorologiques du service pour la période spécifiée.
     332 *        Le tableau standardisé des données météorologiques du service pour la période spécifiée.
    333333 */
    334334function meteo_normaliser($configuration_service, $mode, $flux, $periode) {
     
    564564                        $texte['conseil'] .= _T('rainette:erreur_conseil_limite');
    565565                        break;
    566                 // Cas d'erreur du à une mauvause utilisation des modèles
     566                // Cas d'erreur du à une mauvaise utilisation des modèles
    567567                case 'modele_periodicite':
    568568                        $texte['principal'] .= _T("rainette:erreur_${type_erreur}", array('modele' => $modele));
     
    595595
    596596        if (isset($GLOBALS['rainette_config']['periodicite'][$type_modele])) {
    597                 // Acquérir la configuration statique du service pour connaitre les périodicités horaires supportées
    598                 // pour le mode prévisions
     597                // Acquérir la configuration statique du service pour connaître les périodicités horaires supportées
     598                // pour le mode prévisions.
    599599                include_spip("services/${service}");
    600600                $configurer = "${service}_service2configuration";
     
    623623function periodicite_est_compatible($type_modele, $periodicite) {
    624624
    625         // Périodicité initialisée à "non trouvée"
     625        // Initialisation de la compatibilité à "non compatible".
    626626        $compatible = false;
    627627
     
    663663        $dossier_cache = sous_repertoire($dossier_cache, $configuration_service['alias']);
    664664
    665         // Le nom du fichier cache est composé comme suit, chaque élement étant séparé par un underscore :
     665        // Le nom du fichier cache est composé comme suit, chaque élément étant séparé par un underscore :
    666666        // -- le nom du lieu normalisé (sans espace et dont tous les caractères non alphanumériques sont remplacés par un tiret
    667667        // -- le nom du mode (infos, conditions ou previsions) accolé à la périodicité du cache pour les prévisions uniquement
    668668        // -- la langue du résumé si il existe ou rien si aucune traduction n'est fournie par le service
    669         list($lieu_normalise, ) = lieu_normaliser($lieu);
     669        $lieu_normalise = lieu_normaliser($lieu);
    670670        $fichier_cache = $dossier_cache
    671671                                         . str_replace(array(' ', ',', '+', '.', '/'), '-', $lieu_normalise)
     
    680680
    681681/**
    682  * @param $lieu
    683  *
    684  * @return array
    685  */
    686 function lieu_normaliser($lieu) {
     682 * @param string $lieu
     683 * @param string $format_lieu
     684 *
     685 * @return string
     686 */
     687function lieu_normaliser($lieu, &$format_lieu = '') {
    687688
    688689        $lieu_normalise = trim($lieu);
     
    700701                $format_lieu = 'ville_pays';
    701702                // On détermine la ville et éventuellement le pays (ville[,pays])
    702                 // et on élimine les espaces par un seul +
     703                // et on élimine les espaces par un seul "+".
    703704                $elements = explode(',', $lieu_normalise);
    704705                $lieu_normalise = trim($elements[0]) . (!empty($elements[1]) ? ',' . trim($elements[1]) : '');
     
    706707        }
    707708
    708         return array($lieu_normalise, $format_lieu);
     709        return $lieu_normalise;
    709710}
    710711
  • _plugins_/rainette/trunk/inc/rainette_requeter.php

    r108066 r108073  
    11<?php
     2/**
     3 * Ce fichier contient les fonctions internes de gestion des requêtes vers les services météorologiques.
     4 *
     5 * @package SPIP\RAINETTE\REQUETE
     6 */
    27
    38if (!defined('_ECRIRE_INC_VERSION')) {
     
    5257                $reponse['erreur'] = 'url_indisponible';
    5358        } else {
    54                 // Tranformation de la chaine xml reçue en tableau associatif
     59                // Transformation de la chaîne xml reçue en tableau associatif
    5560                if ($configuration['format_flux'] == 'xml') {
    5661                        $convertir = charger_fonction('simplexml_to_array', 'inc');
     
    7580                        restore_error_handler();
    7681                } else {
    77                         // Tranformation de la chaine json reçue en tableau associatif
     82                        // Transformation de la chaîne json reçue en tableau associatif
    7883                        try {
    7984                                $reponse = json_decode($flux['page'], true);
  • _plugins_/rainette/trunk/services/apixu.php

    r108067 r108073  
    245245        // Le service accepte la format ville,pays, le format latitude,longitude et le format adresse IP.
    246246        // Néanmoins, la query a toujours la même forme; il n'est donc pas nécessaire de gérer le format.
    247         list($lieu_normalise,) = lieu_normaliser($lieu);
     247        $lieu_normalise = lieu_normaliser($lieu);
    248248
    249249        $url = _RAINETTE_APIXU_URL_BASE;
  • _plugins_/rainette/trunk/services/owm.php

    r108066 r108073  
    218218        // On normalise le lieu et on récupère son format.
    219219        // Le service accepte la format ville,pays et le format latitude,longitude
    220         list($lieu_normalise, $format_lieu) = lieu_normaliser($lieu);
     220        $lieu_normalise = lieu_normaliser($lieu, $format_lieu);
    221221        if ($format_lieu == 'latitude_longitude') {
    222222                list($latitude, $longitude) = explode(',', $lieu_normalise);
  • _plugins_/rainette/trunk/services/weather.php

    r108066 r108073  
    176176        // Néanmoins, la query a toujours la même forme; il n'est donc pas nécessaire de gérer le format.
    177177        include_spip('inc/rainette_normaliser');
    178         list($lieu_normalise,) = lieu_normaliser($lieu);
     178        $lieu_normalise = lieu_normaliser($lieu);
    179179
    180180        $url = _RAINETTE_WEATHER_URL_BASE
  • _plugins_/rainette/trunk/services/wunderground.php

    r108066 r108073  
    295295        // et le format weather ID (comme FRXX0076 pour Paris).
    296296        include_spip('inc/rainette_normaliser');
    297         list($lieu_normalise, $format_lieu) = lieu_normaliser($lieu);
     297        $lieu_normalise = lieu_normaliser($lieu, $format_lieu);
    298298        if ($format_lieu == 'weather_id') {
    299299                $query = "locid:${lieu_normalise}";
     
    313313        // Identification de la langue du resume.
    314314        // Le choix de la langue n'a d'interet que si on utilise le resume natif du service. Si ce n'est pas
    315         // le cas on demande à l'API de renvoyer la langue par defaut
     315        // le cas on demande à l'API de renvoyer la langue par défaut
    316316        $code_langue = langue_determiner($configuration);
    317317
     
    453453        if ($tableau['code_meteo'] and $tableau['icon_meteo']) {
    454454                // Determination de l'indicateur jour/nuit qui permet de choisir le bon icone
    455                 // Pour ce service (cas actuel) le nom du fichier icone commence par "nt_" pour la nuit.
     455                // Pour ce service (cas actuel) le nom du fichier icône commence par "nt_" pour la nuit.
    456456                $icone = basename($tableau['icon_meteo']);
    457457                if (strpos($icone, 'nt_') === false) {
     
    466466                if ($configuration['condition'] == $configuration['alias']) {
    467467                        // On affiche les conditions natives fournies par le service.
    468                         // Celles-ci etant deja traduites dans la bonne langue on stocke le texte exact retourne par l'API
     468                        // Celles-ci étant déjà traduites dans la bonne langue on stocke le texte exact retourné par l'API.
    469469                        $tableau['icone']['code'] = $tableau['code_meteo'];
    470470                        $url = _RAINETTE_WUNDERGROUND_URL_BASE_ICONE . '/'
     
    474474                        $tableau['resume'] = ucfirst($tableau['desc_meteo']);
    475475                } else {
    476                         // On affiche les conditions traduites dans le systeme weather.com
    477                         // Pour le resume on stocke le code et non la traduction pour eviter de generer
     476                        // On affiche les conditions traduites dans le système weather.com
     477                        // Pour le resume on stocke le code et non la traduction pour éviter de générer
    478478                        // un cache par langue comme pour le mode natif. La traduction est faite via les fichiers de langue
    479479                        $meteo = meteo_wunderground2weather($tableau['code_meteo'], $tableau['periode']);
  • _plugins_/rainette/trunk/services/wwo.php

    r108066 r108073  
    248248        // Le service accepte la format ville,pays, le format latitude,longitude et le format adresse IP.
    249249        // Néanmoins, la query a toujours la même forme; il n'est donc pas nécessaire de gérer le format.
    250         list($lieu_normalise,) = lieu_normaliser($lieu);
     250        $lieu_normalise = lieu_normaliser($lieu);
    251251
    252252        $url = _RAINETTE_WWO_URL_BASE
Note: See TracChangeset for help on using the changeset viewer.