[SPIP] ~maj v3.0.14-->v3.0.17

[ptitvelo/web/www.git] / www / plugins-dist / mots / action / editer_groupe_mots.php

diff --git a/www/plugins-dist/mots/action/editer_groupe_mots.php b/www/plugins-dist/mots/action/editer_groupe_mots.php
index 9e6d582..ebe0bd3 100644 (file)
--- a/www/plugins-dist/mots/action/editer_groupe_mots.php
+++ b/www/plugins-dist/mots/action/editer_groupe_mots.php
@@ -10,12 +10,29 @@
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
+/**
+ * Gestion de l'action editer_groupes_mots
+ *
+ * @package SPIP\Mots\Actions
+ */
 if (!defined("_ECRIRE_INC_VERSION")) return;
 
 include_spip('inc/filtres');
 
-// Modification d'un groupe de mots
-// http://doc.spip.org/@action_editer_groupe_mots_dist
+/**
+ * Action d'édition d'un groupe de mots clés dans la base de données dont
+ * l'identifiant du groupe est donné en paramètre de cette fonction ou
+ * en argument de l'action sécurisée
+ *
+ * Si aucun identifiant n'est donné, on crée alors un nouveau groupe de
+ * mots clés.
+ * 
+ * @param null|int $id_groupe
+ *     Identifiant du groupe de mot-clé. En absence utilise l'argument
+ *     de l'action sécurisée.
+ * @return array
+ *     Liste (identifiant du groupe de mot clé, Texte d'erreur éventuel)
+**/
 function action_editer_groupe_mots_dist($id_groupe=null)
 {
        if (is_null($id_groupe)){
@@ -24,22 +41,28 @@ function action_editer_groupe_mots_dist($id_groupe=null)
        }
 
        if (!intval($id_groupe)) {
-               $id_groupe = groupemots_inserer();
+               $id_groupe = groupe_mots_inserer();
        }
 
        if ($id_groupe>0)
-               $err = groupemots_modifier($id_groupe);
+               $err = groupe_mots_modifier($id_groupe);
 
        return array($id_groupe,$err);
 }
 
+
 /**
- * Creer un groupe de mots
+ * Insertion d'un groupe de mots clés
  *
+ * @pipeline_appel pre_insertion
+ * @pipeline_appel post_insertion
+ * 
  * @param string $table
- * @return int 
+ *     Tables sur lesquels des mots de ce groupe pourront être liés
+ * @return int|bool
+ *     Identifiant du nouveau groupe de mots clés.
  */
-function groupemots_inserer($table='') {
+function groupe_mots_inserer($table='') {
        $champs = array(
                'titre' => '',
                'unseul' => 'non',
@@ -75,13 +98,22 @@ function groupemots_inserer($table='') {
        return $id_groupe;
 }
 
+
 /**
  * Modifier un groupe de mot
+ * 
  * @param int $id_groupe
+ *     Identifiant du grope de mots clés à modifier
  * @param array|null $set
- * @return string
+ *     Couples (colonne => valeur) de données à modifier.
+ *     En leur absence, on cherche les données dans les champs éditables
+ *     qui ont été postés
+ * @return string|null
+ *     Chaîne vide si aucune erreur,
+ *     Null si aucun champ à modifier,
+ *     Chaîne contenant un texte d'erreur sinon.
  */
-function groupemots_modifier($id_groupe, $set=null) {
+function groupe_mots_modifier($id_groupe, $set=null) {
        $err = '';
 
        include_spip('inc/modifier');
@@ -117,9 +149,64 @@ function groupemots_modifier($id_groupe, $set=null) {
        return $err;
 }
 
+// Fonctions Dépréciées
+// --------------------
 
-// obsolete
+/**
+ * Créer une révision sur un groupe de mot
+ *
+ * @deprecated Utiliser groupe_mots_modifier()
+ * @see groupe_mots_modifier()
+ * 
+ * @param int $id_groupe
+ *     Identifiant du grope de mots clés à modifier
+ * @param array|null $c
+ *     Couples (colonne => valeur) de données à modifier.
+ *     En leur absence, on cherche les données dans les champs éditables
+ *     qui ont été postés
+ * @return string|null
+ *     Chaîne vide si aucune erreur,
+ *     Null si aucun champ à modifier,
+ *     Chaîne contenant un texte d'erreur sinon.
+ */
 function revision_groupe_mot($id_groupe, $c=false) {
-       return groupemots_modifier($id_groupe,$c);
+       return groupe_mots_modifier($id_groupe,$c);
+}
+
+
+/**
+ * Insertion d'un groupe de mots clés
+ *
+ * @deprecated Utiliser groupe_mots_inserer() ou objet_inserer()
+ * @see groupe_mots_inserer()
+ * 
+ * @param string $table
+ *     Tables sur lesquels des mots de ce groupe pourront être liés
+ * @return int|bool
+ *     Identifiant du nouveau groupe de mots clés.
+ */
+function groupemots_inserer($table='') {
+       return groupe_mots_inserer($table);
+}
+
+/**
+ * Modifier un groupe de mot
+ *
+ * @deprecated Utiliser groupe_mots_modifier() ou objet_modifier()
+ * @see groupe_mots_modifier()
+ * 
+ * @param int $id_groupe
+ *     Identifiant du grope de mots clés à modifier
+ * @param array|null $set
+ *     Couples (colonne => valeur) de données à modifier.
+ *     En leur absence, on cherche les données dans les champs éditables
+ *     qui ont été postés
+ * @return string|null
+ *     Chaîne vide si aucune erreur,
+ *     Null si aucun champ à modifier,
+ *     Chaîne contenant un texte d'erreur sinon.
+ */
+function groupemots_modifier($id_groupe, $set=null) {
+       return groupe_mots_modifier($id_groupe, $set);
 }
 ?>