imported>SylvainBeucler |
imported>Pierre |
| Ligne 1 : |
Ligne 1 : |
| − | = Introduction =
| |
| | | | |
| − | * [http://www.spip.net/rubrique205.html Le développement de SPIP et ses outils]: documentation officielle
| |
| − | * [http://doc.spip.org/@Plugin-xml Plugin.xml]: référence de la syntaxe
| |
| − | * [http://doc.spip.org/@Les-points-d-entree-pipelines Les points d’entrée (pipelines)]: les ''hooks'', quoi
| |
| − | * Formulaires:
| |
| − | ** [http://www.spip.net/fr_article3796.html Formulaires CVT par l’exemple]
| |
| − | ** [http://www.spip.net/fr_article3800.html Les formulaires CVT de SPIP 2.0]
| |
| − | * [http://www.spip-contrib.net/Developper-avec-SPIP Développer avec SPIP]: une liste de liens sur SPIP-Contrib; noter que certaines fonctionnalités des plugins sont des reprises de l'existant < v1.9, par exemple la définition de balises personnalisées.
| |
| − | * Le "SPIP_PATH", pour chercher les squelettes, dans l'ordre: <code>squelettes, (racine), squelettes-dist, prive, ecrire</code> (cf. <code>ecrire/inc/utils.php:_chemin()</code>)
| |
| − |
| |
| − | = API =
| |
| − |
| |
| − | http://doc.spip.org/ a pour but de documentation l'API de SPIP, une page par fonction, modifiable par tous.
| |
| − | En pratique, peu de fonctions sont documentées. Qui plus est, cette documentation étant sensées être la documentation officielle, le code source se contente d'y faire référence, sans détailler ces fonctions - donc il n'y a pas plus d'informations dans les fichiers .php de <code>ecrire/</code>.
| |
| − |
| |
| − | La meilleure source de documentation reste la lecture directe du code source, et l'étude d'autres plugins.
| |
| − |
| |
| − | = Passer de 1.9 à 2.0 =
| |
| − |
| |
| − | Certaines fonctions ont changé. Pour convertir le code de votre plugin, une bonne source d'information est <code>ecrire/inc/vieilles_defs.php</code> qui définit des anciennes fonctions avec la nouvelle API 2.0.
| |
| − |
| |
| − | = Insérer une nouvelle page admin =
| |
| − |
| |
| − | * Définir le préfixe de votre plugin (convention de nommage) dans <code>plugin.xml</code>:
| |
| − | <prefix>monprefixe</prefix>
| |
| − | * Créer <code>plugins/mon_plugin-0.1/exec/monprefixe_mapage.php</code>
| |
| − | * Y définir <code>exec_monprefixe_mapage()</code> (ou <code>exec_monprefixe_mapage_dist()</code>)
| |
| − |
| |
| − | Contenu du fichier:
| |
| − | <pre>
| |
| − | <?php
| |
| − | if (!defined("_ECRIRE_INC_VERSION")) return;
| |
| − |
| |
| − | function exec_monprefixe_index()
| |
| − | {
| |
| − | $commencer_page = charger_fonction('commencer_page', 'inc');
| |
| − | echo $commencer_page("Titre (barre de titre du navigateur)");
| |
| − |
| |
| − | echo gros_titre("Titre (dans la page)", '<img src="logo.png" alt="" />', false);
| |
| − |
| |
| − |
| |
| − | echo debut_grand_cadre(true);
| |
| − | echo "Bandeau en haut";
| |
| − | echo fin_grand_cadre(true);
| |
| − |
| |
| − |
| |
| − | echo debut_gauche("ignored", true);
| |
| − | echo "À gauche<br />";
| |
| − |
| |
| − | echo creer_colonne_droite("", true);
| |
| − | echo "À droite si grand écran, à gauche sinon<br />";
| |
| − | echo debut_boite_info(true);
| |
| − | echo "Encadré";
| |
| − | echo fin_boite_info(true);
| |
| − |
| |
| − | $res = icone_horizontale("Page 1", generer_url_ecrire("monprefixe_page1"),
| |
| − | "../"._DIR_PLUGIN_MONPREFIXE."fond.gif",
| |
| − | "../"._DIR_PLUGIN_MONPREFIXE."page1.gif", false);
| |
| − | echo bloc_des_raccourcis($res); // crée creer_colonne_droite si besoin
| |
| − |
| |
| − |
| |
| − | echo debut_droite("ignored", true); // ferme creer_colonne_droite, si utilisé
| |
| − | echo "Contenu, au milieu";
| |
| − |
| |
| − |
| |
| − | echo fin_gauche();
| |
| − | echo fin_page();
| |
| − | }
| |
| − | </pre>
| |
| − |
| |
| − | Les <code>true</code> et <code>false</code> qui se baladent partout permettent de dire qu'on s'occupe d'afficher le contenu, sans quoi SPIP affiche un avertissement. Il faut utiliser <code>true</code> ou <code>false</code> au cas par cas, selon la fonction, cela manque de cohérence.
| |
| − |
| |
| − | Pour le contenu, on peut soit l'écrire avec des <code>echo</code>, soit faire appel à un squelette dans <code>plugins/mon_plugin-0.1/prive/mon_squelette.html</code>:
| |
| − | recuperer_fond('prive/mon_squelette', $_GET);
| |
| − |
| |
| − | Exemples: <code>ecrire/exec/sites_tous.php</code>, et <code>acces_restreint_3_0/exec/acces_restreint</code> dans le plugin "Accès restreint".
| |
| − |
| |
| − | = Traitement dans la partie publique =
| |
| − |
| |
| − | Diverses solutions possibles:
| |
| − |
| |
| − | == Balise dynamique ==
| |
| − |
| |
| − | Ajoutez une balise dynamique à votre plugin. La balise affichera un formulaire avec pour cible la page courante, et on utilisera <code>_request</code> dans le code PHP pour effectuer le traitement. Exemple: #FORMULAIRE_ABONNEMENT dans SPIP-Listes, cf. <code>spip-listes_1_9_3/balise/formulaire_abonnement.php</code>.
| |
| − |
| |
| − | == Modèles ==
| |
| − |
| |
| − | L'utilisation d'une syntaxe <code><''modele''N></code> dans un article appelle le squelette <code>modeles/''modele''.html</code> avec un contexte <code>id_''modele''=N</code>. Ce squelette pourra inclure une balise correspondante, par exemple.
| |
| − |
| |
| − | Cf. <code>ecrire/inc/lien.php:traiter_modeles(...)</code>.
| |
| − | Exemples: <code>prive/modeles/img.html</code>, <code>plugins/forms_et_tables_1_9_1/modeles/form.html</code>.
| |
| − |
| |
| − | == Boucles ==
| |
| − |
| |
| − | On peut introduire des nouvelles boucles en déclarant des fonctions <code>boucle_MABOUCLE_dist</code> ou <code>critere_MABOUCLE_moncritere_dist</code>. Le plus simple est d'inclure ces déclarations dans un fichier <code><fonction></code> de <code>plugin.xml</code> (chargé à chaque recalcul).
| |
| − |
| |
| − | Cf. <code>ecrire/public/compiler.php:public_compiler_dist(...)</code> et <code>ecrire/public/criteres.php:calculter_criteres(...)</code>.
| |
| − |
| |
| − | Exemples: <code>ecrire/public/boucles.php</code>, <code>ecrire/public/criteres.php</code>, <code>forms_et_tables_1_9_1/public/forms_boucles.php</code>, <code>spip-bonux/public/spip_bonux_criteres.php</code>.
| |
| − |
| |
| − | == Paramètre 'action' ==
| |
| − |
| |
| − | Le fichier <code>action/monprefixe_monaction.php</code> sera exécuté; cependant ce n'est pas prévu pour afficher du contenu, seulement pour du traitement.
| |
| − |
| |
| − | == Squelette dédié ==
| |
| − |
| |
| − | Utiliser le paramètre <code>page=</code> pour afficher un squelette de votre plugin, qui pourra contenir du PHP. L'inconvénient est le manque d'intégration dans le site public, puisque ce ne sera pas intégré dans les squelettes du webmestre.
| |
| − |
| |
| − | == Formulaire ==
| |
| − |
| |
| − | Paramètre <code>formulaire_action</code>
| |
| − |
| |
| − | On peut s'appuyer sur les outils "CVT" (charger/vérifier/traiter) de SPIP. Cette approche crée les formulaires statiques, un par squelette (pas prévu pour la génération dynamique).
| |
| − |
| |
| − | TODO
| |
| − |
| |
| − | == Pipeline ==
| |
| − |
| |
| − | La listes des hooks SPIP est dans <code>ecrire/inc_version.php</code>. D'autres plugins peuvent en rajouter pour leurs besoins propres (ex: Forms&Tables).
| |
| − |
| |
| − | TODO
| |
