Changeset 74895 in spip-zone

Timestamp:

Aug 23, 2013, 1:46:42 AM (8 years ago)

Author:

gilles.vincent@…

Message:

Ajout d'un parametre pour les favoris :
on peut desormais les classer par categorie.

L'objectif de ce plugin est de garder l'interface simple de la configuration des favoris.
La gestion des categories est volontairement laissee au soin d'autres plugins qui feront du label "categorie" ce qui sera le plus adapte

Le plugin est repasse en etat de test sous la nouvelle version, jusqu'a ce qu'il sera stabilise et valide
(en fonction des retours des utilisateurs)

Location:

_plugins_/mesfavoris

Files:

• action/ajouter_favori.php (modified) (2 diffs)
• balise/formulaire_favori.php (modified) (3 diffs)
• exemples/mesfavoris_boucle.html (modified) (1 diff)
• exemples/mesfavoris_form_categories.html (added)
• formulaires/favori.php (modified) (4 diffs)
• inc/mesfavoris.php (modified) (5 diffs)
• inclure/mesfavoris.html (modified) (2 diffs)
• mesfavoris_administrations.php (modified) (5 diffs)
• mesfavoris_autoriser.php (modified) (2 diffs)
• paquet.xml (modified) (2 diffs)
• plugin.xml (modified) (1 diff)

_plugins_/mesfavoris/action/ajouter_favori.php

@@ -2 +2 @@
 /*
  * Plugin mesfavoris
- * (c) 2009-2012 Olivier Sallou, Cedric Morin
+ * (c) 2009-2013 Olivier Sallou, Cedric Morin, Gilles Vincent
  * Distribue sous licence GPL
  *
@@ -20 +20 @@
         else
                 $id_auteur = $GLOBALS['visiteur_session']['id_auteur'];
+        if (count($arg)>3)
+                $categorie = $arg[3];
+        else
+                $categorie = '';
 
         include_spip('inc/mesfavoris');
-        mesfavoris_ajouter($id_favori);
+        mesfavoris_ajouter($id_objet,$objet,$id_auteur,$categorie);
 }
 

_plugins_/mesfavoris/balise/formulaire_favori.php

@@ -2 +2 @@
 /*
  * Plugin mesfavoris
- * (c) 2009-2010 Olivier Sallou, Cedric Morin
+ * (c) 2009-2013 Olivier Sallou, Cedric Morin, Gilles Vincent
  * Distribue sous licence GPL
  *
@@ -13 +13 @@
  * Par defaut, l'objet et son identifiant sont pris dans la boucle
  * <BOUCLE_(ARTICLES){id_article}> #FORMULAIRE_FAVORI ...
- * 
+ *
  * Mais il est possible de forcer un objet particulier :
  * #FORMULAIRE_FAVORI{article,8}
- * 
+ *
+ * Il est également possible de forcer à une catégorie donnée
+ * #FORMULAIRE_FAVORI{article,8,ma_categorie}
+ * <BOUCLE_(ARTICLES){id_article}> #FORMULAIRE_FAVORI{ma_categorie} ...
+ *  
  */
 function balise_FORMULAIRE_FAVORI ($p) {
@@ -40 +44 @@
         $objet = $args[0];
         $id_objet = $args[1];
+        $categorie = $args[2];
         // pas dans une boucle ? on generera une erreur ?
         if ($objet == "'balise_hors_boucle'") {
                 $objet = '';
                 $id_objet = '';
+                $categorie = '';
         }
         
         // on envoie les arguments a la fonction charger
         // du formulaire CVT fomulaires/favori.php
-        return array($objet, $id_objet);
+        return array($objet, $id_objet,$categorie);
         
 }

_plugins_/mesfavoris/exemples/mesfavoris_boucle.html

@@ -3 +3 @@
 <B_2>
 <ul>
-<BOUCLE_2(FAVORIS){id_auteur ?}{id_article ?}{id_rubrique ?}>
+<BOUCLE_2(FAVORIS){categorie ?}{id_auteur ?}{id_article ?}{id_rubrique ?}>
 <li>#ID_OBJET : #OBJET : #INFO_URL{#OBJET,#ID_OBJET}</li>
 </BOUCLE_2>

_plugins_/mesfavoris/formulaires/favori.php

@@ -2 +2 @@
 /*
  * Plugin mesfavoris
- * (c) 2009-2012 Olivier Sallou, Cedric Morin
+ * (c) 2009-2013 Olivier Sallou, Cedric Morin, Gilles Vincent
  * Distribue sous licence GPL
  *
@@ -10 +10 @@
 
 /**
- *
+ * Charger du formulaire CVT 
+ * Les arguments sont déterminés par la fonction balise_FORMULAIRE_FAVORI_stat()
+ * 
  * @param string $objet
  * @param int $id_objet
+ * @param string $categorie
  * @return array
  */
-function formulaires_favori_charger_dist($objet, $id_objet){
+function formulaires_favori_charger_dist($objet, $id_objet, $categorie){
         $valeur = array(
                 'editable'=>true,
@@ -29 +32 @@
         else {
                 include_spip('inc/mesfavoris');
-                $favori = mesfavoris_trouver($id_objet,$objet,$GLOBALS['visiteur_session']['id_auteur']);
-                if ($favori['id_favori']){
+                $favori = mesfavoris_trouver($id_objet,$objet,$GLOBALS['visiteur_session']['id_auteur'],$categorie);
+                if ($favori){
                         $valeur['_deja_favori'] = true;
                 }
@@ -37 +40 @@
 }
 
-function formulaires_favori_traiter_dist($objet, $id_objet){
+/**
+ * Traiter le formulaire CVT
+ * 
+ * @param  string $objet     
+ * @param  int $id_objet  
+ * @param  string $categorie 
+ * @return array            
+ */
+function formulaires_favori_traiter_dist($objet, $id_objet, $categorie){
         $res = array('message_ok'=>' ');
         if ($id_auteur = intval($GLOBALS['visiteur_session']['id_auteur'])){
                 include_spip('inc/mesfavoris');
                 if (!is_null(_request('ajouter'))){
-                        mesfavoris_ajouter($id_objet, $objet, $id_auteur);
+                        mesfavoris_ajouter($id_objet, $objet, $id_auteur, $categorie);
                 }
                 if (!is_null(_request('retirer'))){
-                        mesfavoris_supprimer(array('id_objet'=>$id_objet,'objet'=>$objet,'id_auteur'=>$GLOBALS['visiteur_session']['id_auteur']));
+                        mesfavoris_supprimer(array('id_objet'=>$id_objet,'objet'=>$objet,'id_auteur'=>$GLOBALS['visiteur_session']['id_auteur'],'categorie' => $categorie));
                 }
         }

_plugins_/mesfavoris/inc/mesfavoris.php

@@ -2 +2 @@
 /*
  * Plugin mesfavoris
- * (c) 2009-2012 Olivier Sallou, Cedric Morin
+ * (c) 2009-2013 Olivier Sallou, Cedric Morin, Gilles Vincent
  * Distribue sous licence GPL
  *
@@ -10 +10 @@
 
 /**
- * Supprimer un favori dont on connait l'id
+ * Supprimer un ensemble de favoris dont on connait les id
  *
  * @param int $id_favori
@@ -20 +20 @@
                                 $cond[] = "$k=".sql_quote($v);
                 $cond = implode(' AND ',$cond);
-                $res = sql_select('id_favori,objet,id_objet,id_auteur','spip_favoris',$cond);
+                $res = sql_select('id_favori,categorie,objet,id_objet,id_auteur','spip_favoris',$cond);
                 include_spip('inc/invalideur');
                 while ($row = sql_fetch($res)){
@@ -30 +30 @@
 }
 
-function mesfavoris_ajouter($id_objet,$objet,$id_auteur){
+function mesfavoris_ajouter($id_objet,$objet,$id_auteur,$categorie=""){
         if ($id_auteur
                 AND $id_objet = intval($id_objet)
                 AND preg_match(",^\w+$,",$objet)){
 
-                if (!mesfavoris_trouver($id_objet,$objet,$id_auteur)){
-                        sql_insertq("spip_favoris",array('id_auteur'=>$id_auteur,'id_objet'=>$id_objet,'objet'=>$objet));
+                if (!mesfavoris_trouver($id_objet,$objet,$id_auteur,$categorie)){
+                        sql_insertq("spip_favoris",array('id_auteur'=>$id_auteur,'id_objet'=>$id_objet,'categorie'=>$categorie,'objet'=>$objet));
                         include_spip('inc/invalideur');
                         suivre_invalideur("favori/$objet/$id_objet");
@@ -43 +43 @@
         }
         else
-                spip_log("erreur ajouter favori $id_objet-$objet-$id_auteur");
+                spip_log("erreur ajouter favori $id_objet-$objet-$categorie-$id_auteur");
 }
 
-function mesfavoris_trouver($id_objet,$objet,$id_auteur){
+function mesfavoris_trouver($id_objet,$objet,$id_auteur,$categorie=""){
         $row = false;
         if ($id_auteur=intval($id_auteur)
                 AND $id_objet = intval($id_objet)
                 AND preg_match(",^\w+$,",$objet)){
-                $row = sql_fetsel("*","spip_favoris","id_auteur=".intval($id_auteur)." AND id_objet=".intval($id_objet)." AND objet=".sql_quote($objet));
+                $row = sql_fetsel("*","spip_favoris","id_auteur=".intval($id_auteur)." AND id_objet=".intval($id_objet)." AND objet=".sql_quote($objet)." AND categorie=".sql_quote($categorie));
         }
         return $row;

_plugins_/mesfavoris/inclure/mesfavoris.html

@@ -4 +4 @@
   Distribue sous licence GPL
   
-  Affiche les favoirs d'un auteur particulier
+  Affiche les favoris d'un auteur particulier
   
   Paramètres possibles :
@@ -15 +15 @@
   -* type_pagination string : le type de pagination souhaitée sinon celle par défaut de SPIP
   -* sinon string : le texte à afficher dans le cas ou la liste est vide (par défaut aucun)
-
+  -* categorie string : le type de favori à afficher
 ]
 <B_selections>
-        <div id="selection" class="liste favoris[ (#ENV{class})]">
+        <div id="selection" class="liste favoris[ (#ENV{categorie})][ (#ENV{class})]">
                 <h2>[(#ENV{titre,<:mesfavoris:mes_favoris:>})]</h2>
                 [<p class="pagination">(#PAGINATION)</p>]
                 <ul class="liste-items">
-                        <BOUCLE_selections(FAVORIS){!par maj}{id_auteur}{pagination #ENV{pagination,10}}>
+                        <BOUCLE_selections(FAVORIS){!par maj}{id_auteur}{categorie ?}{pagination #ENV{pagination,10}}>
                                 <li class="item">
                                         <a href="#INFO_URL{#OBJET,#ID_OBJET}">#INFO_TITRE{#OBJET,#ID_OBJET}</a>
-                                        <span class="date"><span class="sep"> - </span>[<:mesfavoris:ajoute_le:> (#MAJ|affdate_court)]</span>
+                                        <span class="date"><span class="sep"> - </span>[<:mesfavoris:ajoute_le:> (#MAJ|affdate_court)] [dans la catégorie (#CATEGORIE)]</span>
                                         [(#ENV{bouton_suppression,oui}|=={non}|non)
                                         [(#AUTORISER{modifier,favori,#ID_FAVORI}|oui)[(#BOUTON_ACTION{<:mesfavoris:remove:>,#URL_ACTION_AUTEUR{supprimer_favori,#ID_FAVORI,#SELF},ajax})]]]

_plugins_/mesfavoris/mesfavoris_administrations.php

@@ -2 +2 @@
 /**
  * Plugin mesfavoris
- * (c) 2009-2012 Olivier Sallou, Cedric Morin
+ * (c) 2009-2013 Olivier Sallou, Cedric Morin, Gilles Vincent
  * Distribue sous licence GPL
  *
@@ -9 +9 @@
 if (!defined("_ECRIRE_INC_VERSION")) return;
 
+/**
+ * Déclaration de l'index de $tables_principales qui sera utilisé dans les 'spip_'
+ * 
+ * @param  array $interface Array contenant les infos des tables visibles par recherche sur 'spip_bidule'
+ * @return array            Cet Array de description modifié
+ */
 function mesfavoris_declarer_tables_interfaces($interface){
-        // 'spip_' dans l'index de $tables_principales
         $interface['table_des_tables']['favoris']='favoris';
-
         return $interface;
 }
@@ -28 +32 @@
                 "id_objet"      => "bigint(21) DEFAULT '0' NOT NULL",
                 "objet" => "VARCHAR (25) DEFAULT '' NOT NULL",
+                "categorie"     => "VARCHAR (25) DEFAULT '' NOT NULL",
                 "maj"   => "TIMESTAMP"
         );
@@ -36 +41 @@
                 "KEY id_auteur" => "id_auteur",
                 "KEY id_objet" => "id_objet",
-                "KEY objet" => "objet"
+                "KEY objet" => "objet",
+                "KEY categorie" => "categorie",
         );
 
@@ -80 +86 @@
                         ecrire_meta($nom_meta_base_version,$current_version="1.1.0",'non');
                 }
+                if (version_compare($current_version,'1.2.0','<')){
+                        sql_alter("TABLE spip_favoris ADD COLUMN categorie VARCHAR(50) DEFAULT '' NOT NULL");
+                        sql_alter("TABLE spip_favoris ADD INDEX categorie (categorie)");
+                        ecrire_meta($nom_meta_base_version,$current_version="1.2.0",'non');
+                }
         }
 }

_plugins_/mesfavoris/mesfavoris_autoriser.php

@@ -2 +2 @@
 /**
  * Plugin mesfavoris
- * (c) 2009-2012 Olivier Sallou, Cedric Morin
+ * (c) 2009-2013 Olivier Sallou, Cedric Morin, Gilles Vincent
  * Distribue sous licence GPL
  *
@@ -12 +12 @@
 function mesfavoris_autoriser(){}
 
+/**
+ * Contrôle l'accès sur la modification d'un favori via le plugin
+ * Ici les admins (non restreint) ont tous les droits
+ * Et les auteurs peuvent modifier leurs favoris
+ * 
+ * @param  string $faire Action
+ * @param  string $type  Type d'objet
+ * @param  integer $id   id de l'objet
+ * @param  array $qui    celui qui veut réaliser l'action $faire sur l'objet
+ * @param  array $opt    
+ * @return boolean       true si la modification est possible
+ */
 function autoriser_favori_modifier_dist($faire, $type, $id, $qui, $opt) {
         if ($qui['statut'] == '0minirezo' AND !$qui['restreint'])

_plugins_/mesfavoris/paquet.xml

@@ -2 +2 @@
         prefix="mesfavoris"
         categorie="navigation"
-        version="2.3.4"
-        etat="stable"
+        version="2.4.0"
+        etat="test"
         compatibilite="[2.0.0;3.0.99]"
         logo="images/mesfavoris-128.png"
-        schema="1.1.0"
+        schema="1.2.0"
         documentation="http://www.spip-contrib.net/Mes-Favoris-2-0"
 >       
@@ -14 +14 @@
 
         <auteur>Olivier Sallou</auteur>
-        <auteur lien="yterium.net">Cédric Morin</auteur>
+        <auteur lien="http://www.yterium.net">Cédric Morin</auteur>
+        <auteur lien="http://www.tech-nova.fr">Gilles Vincent</auteur>
 
         <pipeline nom="declarer_tables_principales" inclure="mesfavoris_administrations.php" />

_plugins_/mesfavoris/plugin.xml

@@ -3 +3 @@
         <slogan>S&#233;lection de favoris</slogan>
         <icon>images/mesfavoris-128.png</icon>
-        <version>2.3.4</version>
-        <version_base>1.1.0</version_base>
-        <etat>stable</etat>
+        <version>2.4.0</version>
+        <version_base>1.2.0</version_base>
+        <etat>test</etat>
         <prefix>mesfavoris</prefix>
-        <auteur>Olivier Sallou, [C&#233;dric Morin->yterium.net]</auteur>
+        <auteur>Olivier Sallou, [C&#233;dric Morin->http://www.yterium.net], [Gilles Vincent->http://www.tech-nova.fr]</auteur>
         <description>(D&#233;)S&#233;lectionne un objet pour g&#233;rer des objets (articles, rubriques ...) favoris pour un visiteur authentifi&#233;</description>
         <install>mesfavoris_administrations.php</install>