Documentation du code :

- autosave_clean_value (par Ybbet) : Accents…
- cvtautosave_formulaire_charger (par Ybbet) : Accents…
- cvtautosave_formulaire_traiter (par Ybbet) : Si le formulaire charger a $flux = array(), alors traiter en est de même. Accents…
- En-tête de cvt_autosave.php (par Ybbet) : Pour le @package, j'hésite avec SPIP\Core\CVT\SauvegardeAutomatique … (sur le même principe que SPIP\Core\FiltresImages\ImagesTransformees (d'ailleurs, il manque "es" à ce dernier)
- cvtconf_definir_configurer_conteneur (par Ybbet) : Accents… et formatage markdown.
- En-tête de cvt_configurer.php (par Ybbet) : Oups! On est sur le package SPIP > Core > Formulaires > CVT > Configurer. J'ai fait une erreur sur les SPIP\Core\CVT\xxx


Relecteur : Matthieu Marcillaud

ecrire/inc/cvt_autosave.php

@@ -10,10 +10,16 @@
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
+/**
+ * Sauvegarde automatique des formulaires CVT
+ * 
+ * @package SPIP\Core\CVT\Autosave
+ */
+
 if (!defined('_ECRIRE_INC_VERSION')) return;
 
 /**
- * Nettoyer les echappements
+ * Nettoyer les échappements
  * @param $val
  * @return string
  */
@@ -22,7 +28,7 @@ function autosave_clean_value($val){
 }
 
 /**
- * Reperer une demande de formulaire autosave
+ * Repérer une demande de formulaire autosave
  * et la conditionner
  *
  * @param array $flux
@@ -63,11 +69,14 @@ function cvtautosave_formulaire_charger($flux){
 }
 
 /**
- * Quand on poste definitivement un formulaire autosave,
- * on peut vider la session autosave
- * et on vide aussi toutes les autosave de plus de 72H (delai par defaut) ou sans __timestamp (vieilles sessions)
- * @param $flux
- * @return
+ * Traitement d'un formulaire ayant activé `autosave`
+ *
+ * Quand on poste définitivement un formulaire `autosave`,
+ * on peut vider la session `autosave`
+ * et on vide aussi toutes les `autosave` de plus de 72H (délai par défaut) ou sans `__timestamp` (vieilles sessions)
+ *
+ * @param array $flux
+ * @return array
  */
 function cvtautosave_formulaire_traiter($flux){
 	// si on poste 'autosave' c'est qu'on n'a plus besoin de sauvegarder :

ecrire/inc/cvt_configurer.php

@@ -10,6 +10,15 @@
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
+/**
+ * Les formulaires CVT de configuration.
+ * 
+ * Prendre en compte les `#FORMULAIRE_CONFIGURER_XX` 
+ * dans les squelettes de SPIP
+ * 
+ * @package SPIP\Core\Formulaires\CVT\Configurer
+ */
+
 if (!defined('_ECRIRE_INC_VERSION')) return;
 
 include_spip('inc/config');
@@ -93,12 +102,12 @@ function cvtconf_formulaires_configurer_enregistre($form,$args){
 }
 
 /**
- * Definir la regle de conteneur, en fonction de la presence
- * des
- * _meta_table : nom de la table meta ou stocker (par defaut 'meta')
- * _meta_casier : nom du casier dans lequel serializer (par defaut xx de formulaire_configurer_xx)
- * _meta_prefixe : prefixer les meta (alternative au casier) dans la table des meta (par defaur rien)
- * _meta_stockage : Methode externe de stockage. Aucune n'est fournie par le core.
+ * Définir la règle de conteneur, en fonction de la présence de certaines données
+ * 
+ * - `_meta_table` : nom de la table `spip_metas` ou stocker (par défaut 'meta')
+ * - `_meta_casier` : nom du casier dans lequel sérialiser (par défaut xx de `formulaire_configurer_xx`)
+ * - `_meta_prefixe` : préfixer les `meta` (alternative au casier) dans la table des meta (par defaur rien)
+ * - `_meta_stockage` : Méthode externe de stockage. Aucune n'est fournie par le core.
  *
  * @param string $form
  * @param array $valeurs