Browse Source

Un peu de phpdoc

svn/root/tags/plugins/statistiques/0.6.12
marcimat@rezo.net 6 years ago
parent
commit
52114c6efd
  1. 16
      action/statistiques_archiver.php
  2. 23
      base/stats.php
  3. 29
      stats_administrations.php
  4. 99
      stats_autoriser.php
  5. 21
      stats_ieconfig.php
  6. 8
      stats_pipelines.php

16
action/statistiques_archiver.php

@ -10,6 +10,14 @@
* Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. *
\***************************************************************************/
/**
* Action d'archivage des statistiques
*
* @plugin Statistiques pour SPIP
* @license GNU/GPL
* @package SPIP\Stats\Actions
**/
if (!defined("_ECRIRE_INC_VERSION")) return;
@ -71,7 +79,7 @@ function action_statistiques_archiver_dist($arg=null){
/**
* Logguer ces informations importantes.
*
* @uses spip_log
* @uses spip_log()
* @param string $texte
**/
function statistiques_archiver_log($texte) {
@ -126,9 +134,9 @@ function statistiques_nettoyer_referers_articles() {
*
* Du coup, on applique par petit bouts d'abord.
*
* @uses statistiques_concatener_visites_entre_jours();
* @uses statistiques_concatener_visites_par_mois();
* @uses statistiques_concatener_visites_par_an();
* @uses statistiques_concatener_visites_entre_jours()
* @uses statistiques_concatener_visites_par_mois()
* @uses statistiques_concatener_visites_par_an()
**/
function statistiques_archiver_visites_articles() {

23
base/stats.php

@ -10,8 +10,31 @@
* Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. *
\***************************************************************************/
/**
* Déclarations relatives à la base de données
*
* @plugin Statistiques pour SPIP
* @license GNU/GPL
* @package SPIP\Stats\Pipelines
**/
if (!defined("_ECRIRE_INC_VERSION")) return;
/**
* Déclarer les tables de statistiques
*
* Déclare les tables :
* - spip_visites
* - spip_visites_articles
* - spip_referers
* - spip_referers_articles
*
* @pipeline declarer_tables_auxiliaires
* @param array $tables_auxiliaires
* Description des tables auxiliaires
* @return array
* Description complétée des tables auxiliaires
*/
function stats_declarer_tables_auxiliaires($tables_auxiliaires){
$spip_visites = array(

29
stats_administrations.php

@ -10,9 +10,26 @@
* Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. *
\***************************************************************************/
/**
* Fichier gérant l'installation et désinstallation du plugin Statistiques
*
* @plugin Statistiques pour SPIP
* @license GNU/GPL
* @package SPIP\Stats\Pipelines
**/
if (!defined("_ECRIRE_INC_VERSION")) return;
function stats_upgrade($nom_meta_base_version,$version_cible){
/**
* Installation et mises à jour du plugin
*
* @param string $nom_meta_base_version
* Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
* @param string $version_cible
* Version du schéma de données dans ce plugin (déclaré dans paquet.xml)
* @return void
**/
function stats_upgrade($nom_meta_base_version, $version_cible){
// cas particulier :
// si plugin pas installe mais que la table existe
// considerer que c'est un upgrade depuis v 1.0.0
@ -37,12 +54,20 @@ function stats_upgrade($nom_meta_base_version,$version_cible){
}
/**
* Désinstallation du plugin
*
* @param string $nom_meta_base_version
* Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
* @return void
**/
function stats_vider_tables($nom_meta_base_version) {
sql_drop_table("spip_visites");
sql_drop_table("spip_visites_articles");
sql_drop_table("spip_referers");
sql_drop_table("spip_referers_articles");
effacer_meta("activer_statistiques");
effacer_meta("activer_captures_referers");

99
stats_autoriser.php

@ -1,35 +1,113 @@
<?php
/**
* Déclaration d'autorisations
*
* @plugin Statistiques pour SPIP
* @license GNU/GPL
* @package SPIP\Stats\Pipelines
**/
if (!defined('_ECRIRE_INC_VERSION')) return;
/**
* Fonction du pipeline autoriser. N'a rien à faire
* @pipeline autoriser
*/
function stats_autoriser(){}
/**
* Autoriser l'affichage du menu de statistiques
*
* @uses autoriser_voirstats_dist()
* @param string $faire Action demandée
* @param string $type Type d'objet sur lequel appliquer l'action
* @param int $id Identifiant de l'objet
* @param array $qui Description de l'auteur demandant l'autorisation
* @param array $opt Options de cette autorisation
* @return bool true s'il a le droit, false sinon
*/
function autoriser_statistiques_menu_dist($faire, $type='', $id=0, $qui = NULL, $opt = NULL){
return autoriser('voirstats', $type, $id, $qui, $opt);
}
/**
* Autoriser l'affichage du menu de referers
*
* @uses autoriser_voirstats_dist()
* @param string $faire Action demandée
* @param string $type Type d'objet sur lequel appliquer l'action
* @param int $id Identifiant de l'objet
* @param array $qui Description de l'auteur demandant l'autorisation
* @param array $opt Options de cette autorisation
* @return bool true s'il a le droit, false sinon
*/
function autoriser_referers_menu_dist($faire, $type='', $id=0, $qui = NULL, $opt = NULL){
return autoriser('voirstats', $type, $id, $qui, $opt);
}
// Lire les stats ?
// = tous les admins
// http://code.spip.net/@autoriser_voirstats_dist
/**
* Autoriser l'affichage des statistiques
*
* Nécessite :
* - les statistiques sont actives dans la configuration
* - d'être administrateur
*
* @param string $faire Action demandée
* @param string $type Type d'objet sur lequel appliquer l'action
* @param int $id Identifiant de l'objet
* @param array $qui Description de l'auteur demandant l'autorisation
* @param array $opt Options de cette autorisation
* @return bool true s'il a le droit, false sinon
*/
function autoriser_voirstats_dist($faire, $type, $id, $qui, $opt) {
return (($GLOBALS['meta']["activer_statistiques"] != 'non')
AND ($qui['statut'] == '0minirezo'));
}
// autorisation des boutons et onglets
/**
* Autoriser l'affichage de l'onglet visites dans les statistiques
*
* @uses autoriser_voirstats_dist()
* @param string $faire Action demandée
* @param string $type Type d'objet sur lequel appliquer l'action
* @param int $id Identifiant de l'objet
* @param array $qui Description de l'auteur demandant l'autorisation
* @param array $opt Options de cette autorisation
* @return bool true s'il a le droit, false sinon
*/
function autoriser_statsvisites_onglet_dist($faire, $type, $id, $qui, $opt) {
return autoriser('voirstats', $type, $id, $qui, $opt);
}
/**
* Autoriser l'affichage de l'onglet répartition par secteur dans les statistiques
*
* @uses autoriser_voirstats_dist()
* @param string $faire Action demandée
* @param string $type Type d'objet sur lequel appliquer l'action
* @param int $id Identifiant de l'objet
* @param array $qui Description de l'auteur demandant l'autorisation
* @param array $opt Options de cette autorisation
* @return bool true s'il a le droit, false sinon
*/
function autoriser_statsrepartition_onglet_dist($faire, $type, $id, $qui, $opt) {
return autoriser('voirstats', $type, $id, $qui, $opt);
}
/**
* Autoriser l'affichage de l'onglet répartition par langue dans les statistiques
*
* @uses autoriser_voirstats_dist()
* @param string $faire Action demandée
* @param string $type Type d'objet sur lequel appliquer l'action
* @param int $id Identifiant de l'objet
* @param array $qui Description de l'auteur demandant l'autorisation
* @param array $opt Options de cette autorisation
* @return bool true s'il a le droit, false sinon
*/
function autoriser_statslang_onglet_dist($faire, $type, $id, $qui, $opt) {
$objets = explode(',', isset($GLOBALS['meta']['multi_objets']) ? $GLOBALS['meta']['multi_objets'] : '');
return (in_array('spip_articles', $objets)
@ -37,6 +115,17 @@ function autoriser_statslang_onglet_dist($faire, $type, $id, $qui, $opt) {
AND autoriser('voirstats', $type, $id, $qui, $opt);
}
/**
* Autoriser l'affichage de l'onglet référers dans les statistiques
*
* @uses autoriser_voirstats_dist()
* @param string $faire Action demandée
* @param string $type Type d'objet sur lequel appliquer l'action
* @param int $id Identifiant de l'objet
* @param array $qui Description de l'auteur demandant l'autorisation
* @param array $opt Options de cette autorisation
* @return bool true s'il a le droit, false sinon
*/
function autoriser_statsreferers_onglet_dist($faire, $type, $id, $qui, $opt) {
return autoriser('voirstats', $type, $id, $qui, $opt);
}

21
stats_ieconfig.php

@ -1,13 +1,30 @@
<?php
/**
* Déclarations des configurations qui peuvent être sauvegardées
*
* @plugin Statistiques pour SPIP
* @license GNU/GPL
* @package SPIP\Stats\Pipelines
**/
if (!defined("_ECRIRE_INC_VERSION")) return;
/**
* Ajoute les metas sauvegardables de Statistiques pour le plugin IEConfig
*
* @pipeline ieconfig_metas
*
* @param array $table
* Déclaration des sauvegardes
* @return array
* Déclaration des sauvegardes complétées
**/
function stats_ieconfig_metas($table){
$table['statistiques']['titre'] = _T('statistiques:info_forum_statistiques');
$table['statistiques']['icone'] = 'statistique-16.png';
$table['statistiques']['metas_brutes'] = 'activer_statistiques,activer_captures_referers';
return $table;
}
?>
?>

8
stats_pipelines.php

@ -1,5 +1,13 @@
<?php
/**
* Déclarations d'autorisations et utilisations de pipelines
*
* @plugin Statistiques pour SPIP
* @license GNU/GPL
* @package SPIP\Stats\Pipelines
**/
if (!defined('_ECRIRE_INC_VERSION')) return;
// sur les envois html,

Loading…
Cancel
Save