From 7a3e442e33d8abe804572e83b20fd020ed87b10d Mon Sep 17 00:00:00 2001
From: amemo <amemo@rezo.net>
Date: Mon, 2 Jun 2014 07:08:33 +0000
Subject: [PATCH] =?UTF-8?q?Documentation=20du=20code=20:=20-=20En-t=C3=AAt?=
=?UTF-8?q?e=20de=20maintenance.php=20(par=20Ybbet)=20:=C2=A0=20-=20En-t?=
=?UTF-8?q?=C3=AAte=20de=20mise=5Fa=5Fjour.php=20(par=20Ybbet)=20:=C2=A0Mi?=
=?UTF-8?q?se=5Fa=5Fjour=20=3F=20Ou=20Update=20en=20package=20=3F=20-=20En?=
=?UTF-8?q?-t=C3=AAte=20de=20optimiser.php=20(par=20Ybbet)=20:=C2=A0Avec?=
=?UTF-8?q?=20un=20"s"=20c'est=20mieux=20-=20coupe=5Ftrop=5Flong=20(par=20?=
=?UTF-8?q?Ybbet)=20:=C2=A0=20-=20display=5Fconflit=5Fchamp=20(par=20Ybbet?=
=?UTF-8?q?)=20:=C2=A0=20-=20editer=5Ftexte=5Frecolle=20(par=20Ybbet)=20:?=
=?UTF-8?q?=C2=A0Pas=20convaincu=20l=C3=A0=E2=80=A6=20-=20En-t=C3=AAte=20d?=
=?UTF-8?q?e=20editer.php=20(par=20Ybbet)=20:=C2=A0Au=20pluriel=20-=20inc?=
=?UTF-8?q?=5Ftitrer=5Fcontenu=5Fdist=20(par=20Ybbet)=20:=C2=A0=20-=20sign?=
=?UTF-8?q?aler=5Fconflits=5Fedition=20(par=20Ybbet)=20:=C2=A0=20-=20mail?=
=?UTF-8?q?=5Fnormaliser=5Fheaders=20(par=20Ybbet)=20:=C2=A0=20-=20nettoye?=
=?UTF-8?q?r=5Fcaracteres=5Fmail=20(par=20Ybbet)=20:=C2=A0=20-=20nettoyer?=
=?UTF-8?q?=5Ftitre=5Femail=20(par=20Ybbet)=20:=C2=A0=20-=20=5FT=20(par=20?=
=?UTF-8?q?erational)=20:=C2=A0comment=20forcer=20la=20langue?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Relecteur : Matthieu Marcillaud
---
ecrire/genie/maintenance.php | 6 ++++
ecrire/genie/mise_a_jour.php | 6 ++++
ecrire/genie/optimiser.php | 6 +++-
ecrire/inc/editer.php | 60 +++++++++++++++++++++++++++---------
ecrire/inc/envoyer_mail.php | 33 ++++++++++++++++++--
ecrire/inc/utils.php | 5 +--
6 files changed, 95 insertions(+), 21 deletions(-)
diff --git a/ecrire/genie/maintenance.php b/ecrire/genie/maintenance.php
index 41079bbe02..432d913ed8 100644
--- a/ecrire/genie/maintenance.php
+++ b/ecrire/genie/maintenance.php
@@ -10,6 +10,12 @@
* Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. *
\***************************************************************************/
+/**
+ * Gestion des différentes tâches de maintenance
+ *
+ * @package SPIP\Core\Genie\Maintenance
+ */
+
if (!defined('_ECRIRE_INC_VERSION')) return;
/**
diff --git a/ecrire/genie/mise_a_jour.php b/ecrire/genie/mise_a_jour.php
index 9b4cd5b1d9..b80e56b027 100644
--- a/ecrire/genie/mise_a_jour.php
+++ b/ecrire/genie/mise_a_jour.php
@@ -10,6 +10,12 @@
* Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. *
\***************************************************************************/
+/**
+ * Vérification en tâche de fond des différentes mise à jour.
+ *
+ * @package SPIP\Core\Genie\Mise_a_jour
+ */
+
if (!defined('_ECRIRE_INC_VERSION')) return;
/**
diff --git a/ecrire/genie/optimiser.php b/ecrire/genie/optimiser.php
index 5b5d3031e4..cdcfc3fc54 100644
--- a/ecrire/genie/optimiser.php
+++ b/ecrire/genie/optimiser.php
@@ -212,4 +212,8 @@ function optimiser_base_disparus($attente = 86400) {
if (!$n) spip_log("Optimisation des tables: aucun lien mort");
}
-?>
+/**
+ * Gestion des optimisations de la base de données en cron
+ *
+ * @package SPIP\Core\Genie\Optimiser
+**/
diff --git a/ecrire/inc/editer.php b/ecrire/inc/editer.php
index 0e63fecdf5..219b8f610c 100644
--- a/ecrire/inc/editer.php
+++ b/ecrire/inc/editer.php
@@ -267,11 +267,13 @@ function formulaires_editer_objet_charger($type, $id='new', $id_parent=0, $lier_
return $contexte;
}
-//
-// Gestion des textes trop longs (limitation brouteurs)
-// utile pour les textes > 32ko
-
-// http://doc.spip.org/@coupe_trop_long
+/**
+ * Gestion des textes trop longs (limitation brouteurs)
+ * utile pour les textes > 32ko
+ *
+ * @param string $texte
+ * @return array
+ */
function coupe_trop_long($texte){
$aider = charger_fonction('aider', 'inc');
if (strlen($texte) > 28*1024) {
@@ -297,7 +299,13 @@ function coupe_trop_long($texte){
return (array($texte,''));
}
-// http://doc.spip.org/@editer_texte_recolle
+/**
+ * Formater un `$texte` dans `textarea`
+ *
+ * @param string $texte
+ * @param string $att_text
+ * @return array
+ */
function editer_texte_recolle($texte, $att_text)
{
if ((strlen($texte)<29*1024)
@@ -337,19 +345,17 @@ function titre_automatique($champ_titre,$champs_contenu,$longueur=null){
}
/**
- * Determiner un titre automatique,
- * a partir des champs textes de contenu
+ * Déterminer un titre automatique,
+ * Ã partir des champs textes de contenu
*
- * Les textes et le titre sont pris dans les champs postés (via _request())
+ * Les textes et le titre sont pris dans les champs postés (via `_request()`)
* et le titre calculé est de même affecté en tant que champ posté.
*
- * @param string $champ_titre
- * Nom du champ titre
* @param array $champs_contenu
* Liste des champs contenu textuels
* @param array|null $c
* tableau qui contient les valeurs des champs de contenu
- * si null on utilise les valeurs du POST
+ * si `null` on utilise les valeurs du POST
* @param int $longueur
* Longueur de coupe du texte
* @return string
@@ -596,7 +602,14 @@ function controler_md5(&$champs, $ctr, $type, $id, $serveur, $prefix = 'ctr_') {
return $conflits;
}
-// http://doc.spip.org/@display_conflit_champ
+/**
+ * Afficher le contenu d'un champ selon sa longueur
+ * soit dans un `textarea`, soit dans un `input`
+ *
+ * @param string $x
+ * texte à afficher
+ * @return string
+ */
function display_conflit_champ($x) {
if (strstr($x, "\n") OR strlen($x)>80)
return "<textarea style='width:99%; height:10em;'>".entites_html($x)."</textarea>\n";
@@ -604,7 +617,20 @@ function display_conflit_champ($x) {
return "<input type='text' size='40' style='width:99%' value=\"".entites_html($x)."\" />\n";
}
-// http://doc.spip.org/@signaler_conflits_edition
+/**
+ * Signaler une erreur entre 2 saisies d'un champ
+ *
+ * @uses preparer_diff()
+ * @uses propre_diff()
+ * @uses afficher_para_modifies()
+ * @uses afficher_diff()
+ * @uses minipres()
+ *
+ * @param array $conflits
+ * Valeur des champs en conflit
+ * @param string $redirect
+ * @return string
+ */
function signaler_conflits_edition($conflits, $redirect='') {
include_spip('inc/minipres');
include_spip('inc/revisions');
@@ -675,4 +701,8 @@ function signaler_conflits_edition($conflits, $redirect='') {
);
}
-?>
+/**
+ * Fonctions d'aide à l'édition d'objets éditoriaux.
+ *
+ * @package SPIP\Core\Edition
+**/
diff --git a/ecrire/inc/envoyer_mail.php b/ecrire/inc/envoyer_mail.php
index d068df984f..0d7b5ee4f1 100644
--- a/ecrire/inc/envoyer_mail.php
+++ b/ecrire/inc/envoyer_mail.php
@@ -20,12 +20,30 @@ if (!defined('_ECRIRE_INC_VERSION')) return;
include_spip('inc/charsets');
include_spip('inc/texte');
-// http://doc.spip.org/@nettoyer_titre_email
+/**
+ * Nettoyer le titre d'un email
+ *
+ * @uses textebrut()
+ * @uses corriger_typo()
+ *
+ * @param string $titre
+ * @return string
+ */
function nettoyer_titre_email($titre) {
return str_replace("\n", ' ', textebrut(corriger_typo($titre)));
}
-// http://doc.spip.org/@nettoyer_caracteres_mail
+/**
+ * Utiliser le bon encodage de caractères selon le charset
+ *
+ * Caractères pris en compte : apostrophe, double guillemet,
+ * le tiret cadratin, le tiret demi-cadratin
+ *
+ * @uses filtrer_entites()
+ *
+ * @param string $t
+ * @return string
+ */
function nettoyer_caracteres_mail($t) {
$t = filtrer_entites($t);
@@ -145,7 +163,16 @@ function inc_envoyer_mail_dist($destinataire, $sujet, $corps, $from = "", $heade
return @mail($destinataire, $sujet, $texte, $headers);
}
-
+/**
+ * Formater correctement l'entête d'un email
+ *
+ * @param string $headers
+ * @param string $from
+ * @param string $to
+ * @param string $texte
+ * @param string $parts
+ * @return array
+ */
function mail_normaliser_headers($headers, $from, $to, $texte, $parts="")
{
$charset = $GLOBALS['meta']['charset'];
diff --git a/ecrire/inc/utils.php b/ecrire/inc/utils.php
index f43e5018b4..39e73857db 100644
--- a/ecrire/inc/utils.php
+++ b/ecrire/inc/utils.php
@@ -597,13 +597,14 @@ function test_plugin_actif($plugin){
* ```
* _T('bouton_enregistrer')
* _T('medias:image_tourner_droite')
- * _T('medias:erreurs', array('nb'=>3)
+ * _T('medias:erreurs', array('nb'=>3))
+ * _T("email_sujet", array('spip_lang'=>$lang_usager))
* ```
*
* @param string $texte
* Clé de traduction
* @param array $args
- * Couples (variable => valeur) pour passer des variables à la chaîne traduite
+ * Couples (variable => valeur) pour passer des variables à la chaîne traduite. la variable spip_lang permet de forcer la langue
* @param array $options
* - string class : nom d'une classe a ajouter sur un span pour encapsuler la chaine
* - bool force : forcer un retour meme si la chaine n'a pas de traduction
--
GitLab