[SPIP][PLUGINS] v3.0-->v3.2

[lhc/web/www.git] / www / plugins-dist / sites / formulaires / regler_moderation_site.php

diff --git a/www/plugins-dist/sites/formulaires/regler_moderation_site.php b/www/plugins-dist/sites/formulaires/regler_moderation_site.php
index 9d7d685..5bd5a2e 100644 (file)
--- a/www/plugins-dist/sites/formulaires/regler_moderation_site.php
+++ b/www/plugins-dist/sites/formulaires/regler_moderation_site.php
@@ -10,48 +10,99 @@
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
-if (!defined("_ECRIRE_INC_VERSION")) return;
+/**
+ * Gestion du formulaire de réglage de la modération d'un site
+ *
+ * @package SPIP\Sites\Formulaires
+ **/
+
+if (!defined("_ECRIRE_INC_VERSION")) {
+       return;
+}
 
 include_spip('inc/actions');
 include_spip('inc/editer');
 
-function formulaires_regler_moderation_site_charger_dist($id_syndic,$retour=''){
-       $valeurs = formulaires_editer_objet_charger('site',$id_syndic,0,0,$retour,'');
+
+/**
+ * Chargement du formulaire de réglage de la modération d'un site
+ *
+ * @uses formulaires_editer_objet_charger()
+ *
+ * @param int $id_syndic
+ *     Identifiant du site.
+ * @param string $retour
+ *     URL de redirection après le traitement
+ * @return array
+ *     Environnement du formulaire
+ **/
+function formulaires_regler_moderation_site_charger_dist($id_syndic, $retour = '') {
+       $valeurs = formulaires_editer_objet_charger('site', $id_syndic, 0, 0, $retour, '');
        # pour recuperer le logo issu d'analyse auto
-       foreach(array('moderation','miroir','oubli','resume') as $k)
-               if (!$valeurs[$k])
+       foreach (array('moderation', 'miroir', 'oubli', 'resume') as $k) {
+               if (!$valeurs[$k]) {
                        $valeurs[$k] = 'non';
+               }
+       }
 
        return $valeurs;
 }
 
 /**
- * Identifier le formulaire en faisant abstraction des parametres qui
- * ne representent pas l'objet edite
+ * Identifier le formulaire en faisant abstraction des paramètres qui
+ * ne représentent pas l'objet edité
+ *
+ * @param int $id_syndic
+ *     Identifiant du site
+ * @param string $retour
+ *     URL de redirection après le traitement
+ * @return string
+ *     Hash du formulaire
  */
-function formulaires_regler_moderation_site_identifier_dist($id_syndic,$retour=''){
+function formulaires_regler_moderation_site_identifier_dist($id_syndic, $retour = '') {
        return serialize(array($id_syndic));
 }
 
-
-function formulaires_regler_moderation_site_verifier_dist($id_syndic,$retour=''){
+/**
+ * Vérifications du formulaire de réglage de la modération d'un site
+ *
+ * @param int $id_syndic
+ *     Identifiant du site.
+ * @param string $retour
+ *     URL de redirection après le traitement
+ * @return array
+ *     Erreurs du formulaire
+ **/
+function formulaires_regler_moderation_site_verifier_dist($id_syndic, $retour = '') {
        $erreurs = array();
-       
-       foreach(array('moderation','miroir','oubli','resume') as $k){
-               if (!_request($k) OR !in_array(_request($k),array('oui','non')))
-                       set_request($k,'non');
+
+       foreach (array('moderation', 'miroir', 'oubli', 'resume') as $k) {
+               if (!_request($k) or !in_array(_request($k), array('oui', 'non'))) {
+                       set_request($k, 'non');
+               }
        }
 
        return $erreurs;
 }
 
-function formulaires_regler_moderation_site_traiter_dist($id_syndic,$retour=''){
-       $res = formulaires_editer_objet_traiter('site',$id_syndic,0,0,$retour,'');
-  $res['editable'] = true;
-  if (!isset($res['message_erreur']))
-         $res['message_ok'] = _T('config_info_enregistree');
-  return $res;
-}
-
+/**
+ * Traitements du formulaire de réglage de la modération d'un site
+ *
+ * @uses formulaires_editer_objet_traiter()
+ *
+ * @param int $id_syndic
+ *     Identifiant du site.
+ * @param string $retour
+ *     URL de redirection après le traitement
+ * @return array
+ *     Retours des traitements
+ **/
+function formulaires_regler_moderation_site_traiter_dist($id_syndic, $retour = '') {
+       $res = formulaires_editer_objet_traiter('site', $id_syndic, 0, 0, $retour, '');
+       $res['editable'] = true;
+       if (!isset($res['message_erreur'])) {
+               $res['message_ok'] = _T('config_info_enregistree');
+       }
 
-?>
+       return $res;
+}