Changeset 74912 in spip-zone for _plugins_/mesfavoris/mesfavoris_pipelines.php

Timestamp:

Aug 23, 2013, 3:24:09 PM (8 years ago)

Author:

gilles.vincent@…

Message:

Un peu de PHPDoc et un classement plus standard des pipelines et exemples de demo (encore faudrait-il qu'il existe un standard des bonnes pratiques pour le developpement de plugins ;) )

File:

• _plugins_/mesfavoris/mesfavoris_pipelines.php (modified) (1 diff)

_plugins_/mesfavoris/mesfavoris_pipelines.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
  *
  */
- 
+
+/**
+ * Utilisation des pipelines
+ *
+ * @package SPIP\Mesfavoris\Pipelines
+ */
+
 // Sécurité
 if (!defined("_ECRIRE_INC_VERSION")) return;
 
 /**
+ * Déclaration de l'index de $tables_principales qui sera utilisé dans les 'spip_'
+ *
+ * @pipeline declarer_tables_interfaces
+ * @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){
+        $interface['table_des_tables']['favoris']='favoris';
+        return $interface;
+}
+
+/**
+ * Declaration des tables principales
+ *
+ * @pipeline declarer_tables_principales
+ * @param array $tables_principales Un array de description des tables
+ * @return array $tables_principales L'Array de description complété
+ */
+function mesfavoris_declarer_tables_principales($tables_principales){
+        $spip_favoris = array(
+                "id_favori"     => "bigint(21) NOT NULL",
+                "id_auteur"     => "bigint DEFAULT '0' NOT NULL",
+                "id_objet"      => "bigint(21) DEFAULT '0' NOT NULL",
+                "objet" => "VARCHAR (25) DEFAULT '' NOT NULL",
+                "categorie"     => "VARCHAR (25) DEFAULT '' NOT NULL",
+                "maj"   => "TIMESTAMP"
+        );
+
+        $spip_favoris_key = array(
+                "PRIMARY KEY"           => "id_favori",
+                "KEY auteur_objet"      => "id_auteur,id_objet,objet",
+                "KEY id_auteur" => "id_auteur",
+                "KEY id_objet" => "id_objet",
+                "KEY objet" => "objet",
+                "KEY categorie" => "categorie",
+        );
+
+        $tables_principales['spip_favoris'] =
+                array('field' => &$spip_favoris, 'key' => &$spip_favoris_key);
+
+        return $tables_principales;
+}
+
+/**
  * Insertion dans le pipeline insert_head_css
- * 
+ *
+ * @pipeline insert_head_css
  * @param string $flux Le contenu CSS du head
  * @param string $flux Le contenu CSS du head modifié