Changeset 92685 in spip-zone


Ignore:
Timestamp:
Nov 6, 2015, 3:19:06 PM (4 years ago)
Author:
marcimat@…
Message:

Un peu de phpdoc sur les statistiques encore
(et correction d'un @uses)

Location:
_core_/plugins/statistiques
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • _core_/plugins/statistiques/genie/popularites.php

    r89168 r92685  
    1111\***************************************************************************/
    1212
     13/**
     14 * Gestion du calcul des popularités (cron)
     15 *
     16 * @plugin Statistiques pour SPIP
     17 * @license GNU/GPL
     18 * @package SPIP\Statistiques\Genie
     19**/
     20
    1321if (!defined("_ECRIRE_INC_VERSION")) return;
    1422
    15 //
    16 // Popularite, modele logarithmique
    17 //
     23
     24/**
     25 * Calcule des coefficients de popularité en fonction de l'intervalle
     26 * écoulé depuis le précédent calcul
     27 *
     28 * Popularite, modele logarithmique
     29 *
     30 * @param int $duree Intervalle écoulé depuis le précédent calcul
     31 * @return array {
     32 *     @type float $a Coefficient d'amortissement
     33 *     @type float $b Constante multiplicative
     34 * }
     35**/
    1836function genie_popularite_constantes($duree){
    1937        // duree de demi-vie d'une visite dans le calcul de la popularite (en jours)
     
    3351}
    3452
    35 // http://code.spip.net/@genie_popularites_dist
     53/**
     54 * Cron de calcul des popularités des articles
     55 *
     56 * @uses genie_popularite_constantes()
     57 *
     58 * @param int $t
     59 *     Timestamp de la dernière exécution de cette tâche
     60 * @return int
     61 *     Positif si la tâche a été terminée, négatif pour réexécuter cette tâche
     62**/
    3663function genie_popularites_dist($t) {
    3764
  • _core_/plugins/statistiques/genie/visites.php

    r92396 r92685  
    1515 *
    1616 * @plugin Statistiques pour SPIP
    17  * @license GPL
     17 * @license GNU/GPL
    1818 * @package SPIP\Statistiques\Genie
    1919**/
  • _core_/plugins/statistiques/public/stats.php

    r91227 r92685  
    1111\***************************************************************************/
    1212
     13/**
     14 * Loguer une visite
     15 *
     16 * @plugin Statistiques pour SPIP
     17 * @license GNU/GPL
     18 * @package SPIP\Stats\Public
     19**/
     20
    1321if (!defined("_ECRIRE_INC_VERSION")) return;
    1422
    15 // http://code.spip.net/@public_stats_dist
     23/**
     24 * Logue une visite sur une page
     25 *
     26 * Enregistre le passage d'un visiteur sur la page demandée
     27 * dans `tmp/visites/` qui seront ensuite traitées par une tache cron.
     28 *
     29 * Ne tient pas compte
     30 * - des visites de robots,
     31 * - des 404,
     32 * - des forum
     33 *
     34 * @see genie_visites_dist() Pour la tache cron qui traite les logs.
     35 *
     36 * @param array|null $contexte
     37 *     Contexte d'appel de la page ; retrouvé automatiquement sinon.
     38 * @param string|null $referer
     39 *     Referer de provenance ; retrouvé automatiquement sinon.
     40 * @return null|void
     41**/
    1642function public_stats_dist($contexte = null, $referer = null) {
    1743        if (!is_array($contexte)){
  • _core_/plugins/statistiques/stats_pipelines.php

    r92665 r92685  
    1111if (!defined('_ECRIRE_INC_VERSION')) return;
    1212
    13 // sur les envois html,
    14 // compter les visites.
     13
     14/**
     15 * Compter les visites sur les pages HTML
     16 *
     17 * Uniquement si les statistiques sont activées dans la configuration :
     18 * - permet de compter par défaut toutes les pages de type HTML
     19 * - sauf si on explicite, pour une page donnée, l'entête
     20 *   header `X-Spip-Visites` à `oui` ou `non`.
     21 *   Indiquer `oui` pour forcer le comptage de la page, ou `non` pour au contraire l'éviter
     22 *
     23 * @uses public_stats_dist() si la page doit être comptée.
     24 * @pipeline affichage_entetes_final
     25 * @param array $entetes liste des entêtes de la page
     26 * @return array
     27**/
    1528function stats_affichage_entetes_final($entetes){
    1629        if ($GLOBALS['meta']["activer_statistiques"] != "non") {
     
    2639                        unset($entetes['X-Spip-Visites']);
    2740                }
    28                        
     41
    2942                // Gestion des statistiques du site public
    30                
    3143                if ($spip_compter_visites!='non') {
    3244                        $stats = charger_fonction('stats', 'public');
     
    3850
    3951
    40 // contenus des pages exec
     52/**
     53 * Compléter des pages de l'espace privé
     54 *
     55 * - Ajoute les formulaire de configuration des statistiques dans les configurations avancées
     56 * - Ajoute les formulaire de suppression des statistiques dans la maintenance technique
     57 *
     58 * @pipeline affiche_milieu
     59 * @param array $flux  Données du pipeline
     60 * @return array       Données du pipeline
     61**/
    4162function stats_affiche_milieu($flux){
    4263        // afficher le formulaire de configuration (activer ou desactiver les statistiques).
    43         if ($flux['args']['exec'] == 'configurer_avancees')
     64        if ($flux['args']['exec'] == 'configurer_avancees') {
    4465                $flux['data'] .= recuperer_fond('prive/squelettes/inclure/configurer',array('configurer'=>'configurer_compteur'));
    45 
    46        
     66        }
     67
    4768        // afficher le formulaire de suppression des visites (configuration > maintenance du site).
    4869        if ($flux['args']['exec'] == 'admin_tech') {
    49 
    5070                $flux['data'] .= recuperer_fond('prive/squelettes/inclure/admin_effacer_stats',array());
    51                
    5271        }
    5372        return $flux;
     
    5574
    5675
    57 // les boutons d'administration : ajouter les popularites et visites
     76/**
     77 * Ajoute les boutons d'administration indiquant la popularité et les visites d'un objet
     78 *
     79 * @uses admin_stats()
     80 * @pipeline formulaire_admin
     81 * @param array $flux  Données du pipeline
     82 * @return array       Données du pipeline
     83**/
    5884function stats_formulaire_admin($flux) {
    5985        if (
     
    75101}
    76102
    77 // calculer les visites et popularite d'un objet/id_objet
    78 // (uniquement valable pour les articles) ...
    79 // http://code.spip.net/@admin_stats
    80 function admin_stats($objet, $id_objet, $var_preview)
     103/**
     104 * Calcule les visites et popularite d'un objet éditorial
     105 *
     106 * @note
     107 *     Actuellement uniquement valable pour les articles.
     108 *
     109 * @param string $objet
     110 * @param int $id_objet
     111 * @param string $var_preview
     112 *     Indique si on est en prévisualisation : pas de statistiques dans ce cas.
     113 * @return false|array
     114 *     - false : pas de statistiques disponibles
     115 *     - array : Tableau les stats `[visites, popularité, url]`
     116**/
     117function admin_stats($objet, $id_objet, $var_preview = "")
    81118{
    82119        if ($GLOBALS['meta']["activer_statistiques"] != "non"
     
    96133}
    97134
    98 // http://code.spip.net/@generer_url_ecrire_statistiques
     135/**
     136 * Génère URL de la page dans l'espace privé permettant de visualiser les statistiques d'un article
     137 *
     138 * @param int $id_article
     139 * @return string URL
     140**/
    99141function generer_url_ecrire_statistiques($id_article) {
    100142        return generer_url_ecrire('stats_visites', "id_article=$id_article");
     
    103145
    104146
    105 // les taches crons
     147/**
     148 * Ajoute le cron de traitement des statistiques et calcul des popularités
     149 *
     150 * @pipeline taches_generales_cron
     151 * @param array $taches_generales
     152 *     Tableau `[nom de la tache => intervalle en secondes]`
     153 * @return array
     154 *     Tableau `[nom de la tache => intervalle en secondes]`
     155**/
    106156function stats_taches_generales_cron($taches_generales){
    107157
     
    117167}
    118168
     169/**
     170 * Lister les metas de statistiques et leurs valeurs par défaut
     171 *
     172 * @pipeline configurer_liste_metas
     173 * @param array $metas
     174 *     Couples nom de la méta => valeur par défaut
     175 * @return array
     176 *    Couples nom de la méta => valeur par défaut
     177 */
    119178function stats_configurer_liste_metas($metas){
    120179        $metas['activer_statistiques']='non';
     
    123182}
    124183
     184/**
     185 * Afficher le lien vers la page de statistique sur la vue d'un article dans l'espace privé
     186 *
     187 * @pipeline boite_infos
     188 * @param array $flux  Données du pipeline
     189 * @return array       Données du pipeline
     190 */
    125191function stats_boite_infos($flux){
    126192        if ($GLOBALS['meta']["activer_statistiques"] == "oui") {
Note: See TracChangeset for help on using the changeset viewer.