Changeset 108067 in spip-zone


Ignore:
Timestamp:
Dec 16, 2017, 6:02:55 PM (17 months ago)
Author:
eric@…
Message:

PHPDoc en masse.

Location:
_plugins_/rainette/trunk
Files:
3 edited

Legend:

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

    r108066 r108067  
    2929 *            - `conditions`, la valeur par défaut
    3030 *            - `previsions`
    31  *            - `conditions`
    3231 *            - `infos`
    3332 * @param int $periodicite
     
    187186                                                        // - celles du jour indépendamment de la période horaire
    188187                                                        // - celles correspondant à une période horaire choisie (24, 12, 6, 3, 1)
    189                                                         //   Ces donnnées sont stockées à un index horaire de 0 à n qui représente la période horaire.
     188                                                        //   Ces données sont stockées à un index horaire de 0 à n qui représente la période horaire.
    190189                                                        // Pour avoir un traitement identique pour les deux types de données on considère que l'index horaire
    191190                                                        // des données jour est égal à -1.
     
    205204                                                        }
    206205
    207                                                         // On boucle sur chaque periode horaire pour remplir le tableau complet.
     206                                                        // On boucle sur chaque période horaire pour remplir le tableau complet.
    208207                                                        foreach ($periodes_horaires as $_periode) {
    209208                                                                // 1- Initialiser le tableau normalisé des informations à partir des données brutes
  • _plugins_/rainette/trunk/inc/rainette_normaliser.php

    r108066 r108067  
    77if (!defined('_RAINETTE_REGEXP_LIEU_IP')) {
    88        /**
    9          * Regexp permettant de reconnaitre un lieu au format adresse IP
     9         * Regexp permettant de reconnaître un lieu au format adresse IP
    1010         */
    1111        define('_RAINETTE_REGEXP_LIEU_IP', '#(?:\d{1,3}\.){3}\d{1,3}#');
     
    1313if (!defined('_RAINETTE_REGEXP_LIEU_COORDONNEES')) {
    1414        /**
    15          * Regexp permettant de reconnaitre un lieu au format coordonnées géographiques latitude,longitude
     15         * Regexp permettant de reconnaître un lieu au format coordonnées géographiques latitude,longitude
    1616         */
    1717        define('_RAINETTE_REGEXP_LIEU_COORDONNEES', '#([\-\+]?\d+(?:\.\d+)?)\s*,\s*([\-\+]?\d+(?:\.\d+)?)#');
     
    1919if (!defined('_RAINETTE_REGEXP_LIEU_WEATHER_ID')) {
    2020        /**
    21          * Regexp permettant de reconnaitre un lieu au format Weather ID
     21         * Regexp permettant de reconnaître un lieu au format Weather ID
    2222         */
    2323        define('_RAINETTE_REGEXP_LIEU_WEATHER_ID', '#[a-zA-Z]{4}\d{4}#i');
     
    313313
    314314/**
    315  * @param $configuration_service
    316  * @param $mode
    317  * @param $flux
    318  * @param $periode
     315 * Normalise les données issues du service dans un tableau standard aux index prédéfinis pour chaque mode.
     316 *
     317 * @param array  $configuration_service
     318 *        Configuration statique et utilisateur du service ayant retourné le flux de données.
     319 * @param string $mode
     320 *        Le type de données météorologiques demandé :
     321 *        - `conditions`, la valeur par défaut
     322 *        - `previsions`
     323 *        - `infos`
     324 * @param array  $flux
     325 *        Le tableau brut des données météorologiques issu de l'appel au service.
     326 * @param int    $periode
     327 *        Valeur de 0 à n pour indiquer qu'on traite les données de prévisions d'une période horaire donnée
     328 *        ou -1 pour indiquer que l'on traite les données jour. La valeur maximale n dépend de la périodicité
     329 *        des prévisions, par exemple, elle vaut 0 pour une périodicité de 24h, 1 pour 12h...
    319330 *
    320331 * @return array
     332 *        Le tableau standardisés des données météorologiques du service pour la période spécifiée.
    321333 */
    322334function meteo_normaliser($configuration_service, $mode, $flux, $periode) {
     
    391403
    392404/**
    393  * @param $mode
    394  * @param $donnee
     405 * Détermine, en fonction du type PHP configuré, la fonction à appliquer à la valeur d'une donnée.
     406 *
     407 * @param string $mode
     408 *        Le type de données météorologiques demandé :
     409 *        - `conditions`, la valeur par défaut
     410 *        - `previsions`
     411 *        - `infos`
     412 * @param string $donnee
     413 *        Correspond à l'index du tableau associatif standardisé comme `temperature`, `humidite`, `precipitation`...
    395414 *
    396415 * @return string
     416 *        La fonction PHP (floatval, intval...) ou spécifique à appliquer à la valeur de la donnée.
    397417 */
    398418function donnee_typer($mode, $donnee) {
     
    429449
    430450/**
    431  * @param $donnee
     451 * Formate une date numérique ou sous une autre forme en une date au format `Y-m-d H:i:s`.
     452 *
     453 * @param string $donnee
     454 *        Correspond à un index du tableau associatif standardisé à formater en date standard.
    432455 *
    433456 * @return string
     457 *        Date au format `Y-m-d H:i:s`.
    434458 */
    435459function donnee_formater_date($donnee) {
     
    451475
    452476/**
    453  * @param $donnee
     477 * Formate une heure numérique ou sous une autre forme en une heure au format `H:i`.
     478 *
     479 * @param string $donnee
     480 *        Correspond à un index du tableau associatif standardisé à formater en heure standard.
    454481 *
    455482 * @return string
     483 *        Heure au format `H:i`.
    456484 */
    457485function donnee_formater_heure($donnee) {
     
    476504
    477505/**
    478  * @param $valeur
     506 * Vérifie que la valeur de l'indice UV est acceptable.
     507 *
     508 * @param int $valeur
     509 *        Valeur de l'indice UV à vérifier. Un indice UV est toujours compris entre 0 et 16, bornes comprises.
    479510 *
    480511 * @return bool
     512 *        `true` si la valeur est acceptable, `false` sinon.
    481513 */
    482514function donnee_verifier_indice_uv($valeur) {
     
    510542                case 'analyse_xml':
    511543                case 'analyse_json':
    512                 // Cas d'erreur où le service renvoie aucune donnée sans pour autant monter une erreur.
     544                        // Cas d'erreur où le service renvoie aucune donnée sans pour autant monter une erreur.
    513545                case 'aucune_donnee':
    514                 // Cas d'erreur où le nombre de requêtes maximal a été atteint.
     546                        // Cas d'erreur où le nombre de requêtes maximal a été atteint.
    515547                        $texte['principal'] .= _T("rainette:erreur_${type_erreur}", array('service' => $titre_service));
    516548                        $texte['conseil'] .= _T('rainette:erreur_conseil_equipe');
     
    635667        // -- le nom du mode (infos, conditions ou previsions) accolé à la périodicité du cache pour les prévisions uniquement
    636668        // -- la langue du résumé si il existe ou rien si aucune traduction n'est fournie par le service
    637         list($lieu_normalise,) = lieu_normaliser($lieu);
     669        list($lieu_normalise, ) = lieu_normaliser($lieu);
    638670        $fichier_cache = $dossier_cache
    639671                                         . str_replace(array(' ', ',', '+', '.', '/'), '-', $lieu_normalise)
  • _plugins_/rainette/trunk/services/apixu.php

    r108066 r108067  
    33 * Ce fichier contient la configuration et l'ensemble des fonctions implémentant le service APIXU (apixu).
    44 * Ce service est capable de fournir des données au format XML ou JSON. Néanmoins, l'API actuelle du plugin utilise
    5  * uniquemement le format JSON.
     5 * uniquement le format JSON.
    66 *
    77 * @package SPIP\RAINETTE\SERVICES\APIXU
     
    2727        ),
    2828        'credits' => array(
    29                 'titre'       => 'APIXU',
    30                 'logo'        => 'apixu.png',
    31                 'lien'        => 'https://www.apixu.com/',
     29                'titre' => 'APIXU',
     30                'logo'  => 'apixu.png',
     31                'lien'  => 'https://www.apixu.com/',
    3232        ),
    3333        'langues' => array(
     
    7474        ),
    7575        'limites' => array(
    76                 'month'       => 5000
     76                'month' => 5000
    7777        )
    7878);
     
    137137        'periodicites'       => array(
    138138                24 => array('max_jours' => 10),
    139 //              1 => array('max_jours' => 10)
     139                //              1 => array('max_jours' => 10)
    140140        ),
    141141        'periodicite_defaut' => 24,
     
    180180// -- Seules les données non calculées sont configurées.
    181181$GLOBALS['rainette_apixu_config']['erreurs'] = array(
    182         'cle_base'    => array('error'),
    183         'donnees'     => array(
     182        'cle_base' => array('error'),
     183        'donnees'  => array(
    184184                // Erreur
    185                 'code'     => array('cle' => array('code')),
    186                 'message'  => array('cle' => array('message')),
     185                'code'    => array('cle' => array('code')),
     186                'message' => array('cle' => array('message')),
    187187        ),
    188188);
     
    397397                        // On affiche les conditions natives fournies par le service.
    398398                        // Pour le resume, apixu fournit la traduction dans un item différent que pour les autres services.
    399                         // Cet item est stocké dans trad_meteo.
     399                        // Cet item est stocké dans 'trad_meteo'.
    400400                        $tableau['icone']['code'] = $tableau['code_meteo'];
    401401                        $tableau['icone']['url'] = copie_locale($tableau['icon_meteo']);
    402402                        $tableau['resume'] = ucfirst($tableau['desc_meteo']);
    403403                } else {
    404                         // On affiche les conditions traduites dans le systeme weather.com
     404                        // On affiche les conditions traduites dans le système weather.com
    405405                        $meteo = meteo_apixu2weather($tableau['code_meteo'], $tableau['periode']);
    406406                        $tableau['icone'] = $meteo;
Note: See TracChangeset for help on using the changeset viewer.