[SPIP][PLUGINS] v3.0-->v3.2
[lhc/web/www.git] / www / plugins-dist / petitions / petitions_autoriser.php
index ba35488..f0973f1 100644 (file)
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
-if (!defined('_ECRIRE_INC_VERSION')) return;
+/**
+ * Définit les autorisations du plugin Pétitions
+ *
+ * @package SPIP\Petitions\Autorisations
+ **/
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
-// fonction pour le pipeline
-function petitions_autoriser() {}
+/**
+ * Fonction d'appel pour le pipeline
+ *
+ * @pipeline autoriser
+ */
+function petitions_autoriser() { }
 
-// Moderer la petition ?
-// = modifier l'article correspondant
-// = droits par defaut sinon (admin complet pour moderation de tout)
-// https://code.spip.net/@autoriser_modererpetition_dist
+
+/**
+ * Autorisation de modérer une pétition
+ *
+ * Il faut avoir droit de modifier l'objet qui reçoit la pétition
+ *
+ * @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_modererpetition_dist($faire, $type, $id, $qui, $opt) {
        return
                autoriser('modifier', $type, $id, $qui, $opt);
 }
 
 /**
- * Pour publier une signature il faut avoir le droit de moderer la petition de l'article en question
- * @return bool
+ * Autorisation de publier une signature
+ *
+ * Il faut avoir le droit de modérer la petition de l'article en question
+ *
+ * @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_signature_publier($faire, $type, $id, $qui, $opt) {
-       $id_article = sql_getfetsel('P.id_article','spip_signatures AS S JOIN spip_petitions AS P ON P.id_petition=S.id_petition','S.id_signature='.intval($id));
+       $id_article = sql_getfetsel('P.id_article',
+               'spip_signatures AS S JOIN spip_petitions AS P ON P.id_petition=S.id_petition', 'S.id_signature=' . intval($id));
+
        return
                autoriser('modererpetition', 'article', $id_article, $qui, $opt);
 }
 
 /**
- * Pour supprimer une signature il faut avoir le droit de moderer la petition de l'article en question
- * @return bool
+ * Autorisation de supprimer une signature
+ *
+ * Il faut avoir le droit de modérer la petition de l'article en question
+ *
+ * @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_signature_supprimer($faire, $type, $id, $qui, $opt) {
-       $id_article = sql_getfetsel('P.id_article','spip_signatures AS S JOIN spip_petitions AS P ON P.id_petition=S.id_petition','S.id_signature='.intval($id));
+       $id_article = sql_getfetsel('P.id_article',
+               'spip_signatures AS S JOIN spip_petitions AS P ON P.id_petition=S.id_petition', 'S.id_signature=' . intval($id));
+
        return
                autoriser('modererpetition', 'article', $id_article, $qui, $opt);
 }
 
 /**
- * Toute personne idenfiee peut relancer une signature non publiee
- * @return bool
+ * Autorisation de relancer une signature
+ *
+ * Toute personne idenfiée peut relancer une signature non publiée
+ *
+ * @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_signature_relancer($faire, $type, $id, $qui, $opt) {
-       $statut = sql_getfetsel('statut','spip_signatures','id_signature='.intval($id));
-       return ($qui['id_auteur'] && !in_array($statut,array('poubelle','publie')));
+       $statut = sql_getfetsel('statut', 'spip_signatures', 'id_signature=' . intval($id));
+
+       return ($qui['id_auteur'] && !in_array($statut, array('poubelle', 'publie')));
 }
 
-// Modifier une signature ?
-// = jamais !
-// https://code.spip.net/@autoriser_signature_modifier_dist
+/**
+ * Autorisation de modifier une signature
+ *
+ * Jamais
+ *
+ * @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_signature_modifier_dist($faire, $type, $id, $qui, $opt) {
        return
                false;
 }
 
-function autoriser_controlerpetition_menu_dist($faire, $type='', $id=0, $qui = NULL, $opt = NULL){
-       return sql_countsel('spip_signatures')>0;
+/**
+ * Autorisation de voir le menu de gestion des signatures
+ *
+ * S'il y a au moins une signature
+ *
+ * @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_controlerpetition_menu_dist($faire, $type = '', $id = 0, $qui = null, $opt = null) {
+       return sql_countsel('spip_signatures') > 0;
 }
 
 /**
- * Auto-association de documents sur des signatures : niet
+ * Autorisation d'auto-association de documents sur des signatures
+ *
+ * Jamais
+ *
+ * @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_signature_autoassocierdocument_dist($faire, $type, $id, $qui, $opts) {
+function autoriser_signature_autoassocierdocument_dist($faire, $type, $id, $qui, $opt) {
        return false;
 }
-
-?>