[SPIP][PLUGINS] v3.0-->v3.2
[lhc/web/www.git] / www / plugins-dist / statistiques / stats_autoriser.php
index c81565c..81d65e2 100644 (file)
 <?php
 
-if (!defined('_ECRIRE_INC_VERSION')) return;
+/**
+ * Déclaration d'autorisations
+ *
+ * @plugin Statistiques pour SPIP
+ * @license GNU/GPL
+ * @package SPIP\Stats\Pipelines
+ **/
 
-function stats_autoriser(){}
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
+/**
+ * Fonction du pipeline autoriser. N'a rien à faire
+ *
+ * @pipeline autoriser
+ */
+function stats_autoriser() { }
 
-function autoriser_statistiques_menu_dist($faire, $type='', $id=0, $qui = NULL, $opt = NULL){
+/**
+ * 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);
 }
-function autoriser_referers_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 (!isset($GLOBALS['meta']['activer_referers']) or $GLOBALS['meta']['activer_referers'] == "oui") && autoriser('voirstats', $type, $id, $qui, $opt);
 }
 
 
-// Lire les stats ?
-// = tous les admins
-// https://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'));
+               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(',', $GLOBALS['meta']['multi_objets']);
-       return (in_array('spip_articles',  $objets)
-            OR in_array('spip_rubriques', $objets))
-                       AND autoriser('voirstats', $type, $id, $qui, $opt);
+       $objets = explode(',', isset($GLOBALS['meta']['multi_objets']) ? $GLOBALS['meta']['multi_objets'] : '');
+
+       return (in_array('spip_articles', $objets)
+               or in_array('spip_rubriques', $objets))
+       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);
+       return (!isset($GLOBALS['meta']['activer_referers']) or $GLOBALS['meta']['activer_referers'] == "oui") && autoriser('voirstats', $type, $id, $qui, $opt);
 }
-
-?>