Changeset 74912 in spip-zone


Ignore:
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 ;) )

Location:
_plugins_/mesfavoris
Files:
5 edited
2 copied
1 moved

Legend:

Unmodified
Added
Removed

  • _plugins_/mesfavoris/mesfavoris_administrations.php

    r74895 r74912  
    77 */
    88
     9/**
     10 * Fichier gérant l'installation et désinstallation du plugin
     11 *
     12 * @package SPIP\Mesfavoris\Installation
     13 */
     14
    915if (!defined("_ECRIRE_INC_VERSION")) return;
    1016
    1117/**
    1218 * Déclaration de l'index de $tables_principales qui sera utilisé dans les 'spip_'
    13  *
     19 *
     20 * @pipeline declarer_tables_interfaces
    1421 * @param  array $interface Array contenant les infos des tables visibles par recherche sur 'spip_bidule'
    1522 * @return array            Cet Array de description modifié
    … …  
    2330 * Declaration des tables principales
    2431 *
     32 * @pipeline declarer_tables_principales
    2533 * @param array $tables_principales Un array de description des tables
    2634 * @return array $tables_principales L'Array de description complété
    … …  
    5260
    5361/**
    54  * Mise à jour des tables
     62 * Installation / Mise à jour des tables des favoris
     63 *
     64 * Crée les tables SQL du plugin (spip_favoris)
    5565 *
    5666 * @param string $nom_meta_base_version
     67 *     Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
    5768 * @param string $version_cible
     69 *     Version du schéma de données dans ce plugin (déclaré dans paquet.xml)
    5870 */
    5971function mesfavoris_upgrade($nom_meta_base_version,$version_cible){
    … …  
    96108
    97109/**
    98  * Desinstallation du plugin
     110 * Désinstallation du plugin
    99111 *
     112 * Supprime les tables SQL du plugin (spip_favoris)
     113 *
    100114 * @param string $nom_meta_base_version
     115 *     Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
    101116 */
    102117function mesfavoris_vider_tables($nom_meta_base_version) {

  • _plugins_/mesfavoris/mesfavoris_autoriser.php

    r74895 r74912  
    77 */
    88
    9 // Sécurité
     9/**
     10 * Définit les autorisations du plugin forum
     11 *
     12 * @package SPIP\Mesfavoris\Autorisations
     13 */
     14
     15/ Sécurité
    1016if (!defined("_ECRIRE_INC_VERSION")) return;
    1117
    … …  
    1622 * Ici les admins (non restreint) ont tous les droits
    1723 * Et les auteurs peuvent modifier leurs favoris
    18  *
     24 *
     25 * @pipeline autoriser
    1926 * @param  string $faire Action
    2027 * @param  string $type  Type d'objet

  • _plugins_/mesfavoris/mesfavoris_pipelines.php

    r64726 r74912  
    22/**
    33 * Plugin mesfavoris
    4  * (c) 2009-2012 Olivier Sallou, Cedric Morin
     4 * (c) 2009-2013 Olivier Sallou, Cedric Morin, Gilles Vincent
    55 * Distribue sous licence GPL
    66 *
    77 */
    8  
     8
     9/**
     10 * Utilisation des pipelines
     11 *
     12 * @package SPIP\Mesfavoris\Pipelines
     13 */
     14
    915// Sécurité
    1016if (!defined("_ECRIRE_INC_VERSION")) return;
    1117
    1218/**
     19 * Déclaration de l'index de $tables_principales qui sera utilisé dans les 'spip_'
     20 *
     21 * @pipeline declarer_tables_interfaces
     22 * @param  array $interface Array contenant les infos des tables visibles par recherche sur 'spip_bidule'
     23 * @return array            Cet Array de description modifié
     24 */
     25function mesfavoris_declarer_tables_interfaces($interface){
     26        $interface['table_des_tables']['favoris']='favoris';
     27        return $interface;
     28}
     29
     30/**
     31 * Declaration des tables principales
     32 *
     33 * @pipeline declarer_tables_principales
     34 * @param array $tables_principales Un array de description des tables
     35 * @return array $tables_principales L'Array de description complété
     36 */
     37function mesfavoris_declarer_tables_principales($tables_principales){
     38        $spip_favoris = array(
     39                "id_favori"     => "bigint(21) NOT NULL",
     40                "id_auteur"     => "bigint DEFAULT '0' NOT NULL",
     41                "id_objet"      => "bigint(21) DEFAULT '0' NOT NULL",
     42                "objet" => "VARCHAR (25) DEFAULT '' NOT NULL",
     43                "categorie"     => "VARCHAR (25) DEFAULT '' NOT NULL",
     44                "maj"   => "TIMESTAMP"
     45        );
     46
     47        $spip_favoris_key = array(
     48                "PRIMARY KEY"           => "id_favori",
     49                "KEY auteur_objet"      => "id_auteur,id_objet,objet",
     50                "KEY id_auteur" => "id_auteur",
     51                "KEY id_objet" => "id_objet",
     52                "KEY objet" => "objet",
     53                "KEY categorie" => "categorie",
     54        );
     55
     56        $tables_principales['spip_favoris'] =
     57                array('field' => &$spip_favoris, 'key' => &$spip_favoris_key);
     58
     59        return $tables_principales;
     60}
     61
     62/**
    1363 * Insertion dans le pipeline insert_head_css
    14  *
     64 *
     65 * @pipeline insert_head_css
    1566 * @param string $flux Le contenu CSS du head
    1667 * @param string $flux Le contenu CSS du head modifié

  • _plugins_/mesfavoris/paquet.xml

    r74895 r74912  
    1717        <auteur lien="http://www.tech-nova.fr">Gilles Vincent</auteur>
    1818
    19         <pipeline nom="declarer_tables_principales" inclure="mesfavoris_administrations.php" />
    20         <pipeline nom="declarer_tables_interfaces" inclure="mesfavoris_administrations.php" />
     19        <pipeline nom="declarer_tables_principales" inclure="mesfavoris_pipelines.php" />
     20        <pipeline nom="declarer_tables_interfaces" inclure="mesfavoris_pipelines.php" />
    2121        <pipeline nom="insert_head_css" inclure="mesfavoris_pipelines.php" />
    2222        <pipeline nom="autoriser" inclure="mesfavoris_autoriser.php" />

  • _plugins_/mesfavoris/plugin.xml

    r74895 r74912  
    1313        <pipeline>
    1414                <nom>declarer_tables_principales</nom>
    15                 <inclure>mesfavoris_administrations.php</inclure>
     15                <inclure>mesfavoris_pipelines.php</inclure>
    1616        </pipeline>
    1717        <pipeline>
    1818                <nom>declarer_tables_interfaces</nom>
    19                 <inclure>mesfavoris_administrations.php</inclure>
     19                <inclure>mesfavoris_pipelines.php</inclure>
    2020        </pipeline>
    2121        <pipeline>
Note: See TracChangeset for help on using the changeset viewer.