Project

General

Profile

Systeme de Plugins » History » Version 5

Simon, 05/04/2012 10:23 AM

1 1 Simon
h1. Système de Plugins
2
3 5 Simon
4
h2. Installation d'un plugin
5
*
6
Pré-requis* : Avant d'installer un plugin, vous devez vous assurer que le *MOD_PLUGIN* est bien actif. Pour cela, depuis l'interface d'administration, allez sur _Configurer_ > _Système_. Déplier l'onglet _Configuration système (define_release)_. Passez en mode édition et changez la valeur de *MOD_PLUGIN* à 1. Enregistrez les modifications.
7
Dès lors que le *MOD_PLUGIN* est activé, le sous-menu _Plugins_ apparaît dans l'onglet _Configurer_.
8
9
# Télécharger le plugin
10
# Dézipper l'archive dans le dossier /plugins/ de l'application
11
# Donner les permissions nécessaires à l'utilisateur apache sur le dossier. Par exemple :
12
  * <code>chown www-data:www-data /plugins/l21_monplugin/</code>
13
  * <code>chmod -R 0755 /plugins/l21_monplugin/</code>
14
# Vous pouvez à présent vous rendre sur la page des plugins en cliquant sur _Configurer_ > _Plugins_. Le plugin nouvellement installé doit apparaître. Vous devez à présent l'activer en cliquant sur le lien adéquat. Votre plugin est installé!
15
16
17 1 Simon
h2. Architecture d'un plugin
18
19
L'architecture d'un plugin doit se conformer à quelques règles.
20
21
# D'abord en ce qui concerne le nommage, le plugin doit nécessairement être préfixé de *l21_*
22 2 Simon
# Il doit contenir un fichier <code>plugin.xml</code> qui renseignera les méta-informations (nom, auteur, compatibilité, date de sortie, portée du plugin ...)
23
# Il doit nécessairement disposé d'un fichier nommé <code>__init__.php</code>. Ce fichier sera exécuté à chaque appel de page. C'est lui qui instancie le plugin et permettra donc son exécution.
24 1 Simon
# Si le plugin fait appel à des fichiers de langue, il doit impérativement reproduire la structure applicative. Il contient alors un répertoire nommé languages et autant de sous-répertoires pour les langues (par exemple _fr_ et _en_). Tous les fishiers contenus dans les sous-répertoires seront chargés lors de l'instanciation du plugin.
25 2 Simon
# La présence d'un fichier <code>__install__.php</code> permettra lors de l'installation du plugin d'effectuer des actions relative à sa mise en oeuvre, par exemple, l'ajout d'une table dans la base de données, la modification d'un fichier, ...
26 1 Simon
27
Pour le reste, vous avez une totale liberté dans l'organisation de votre plugin. Veillez toutefois à proposer une structure claire, afin que celui-ci puisse être amélioré ou repris par un autre utilisateur.
28
29 4 Simon
30
h2. L'objet plugin
31
32
Chaque plugin est instancié par la classe "plugin":http://dev.linea21.com/projects/linea21/repository/changes/trunk/v1/class/class.plugin.php. Les propriétés de l'objet sont ainsi rendues disponibles via la variable globale <code>$plug</code>.
33
34
Par exemple : 
35
<pre><code class="xml">
36
echo $plug->getVar('name');
37
echo $plug->getVar('shortname');
38
39
// renverra le nom du plugin
40
// puis le nom du plugin privé du préfixe l21_
41
</code>
42
</pre>
43
44
Référez-vous à "la classe":http://dev.linea21.com/projects/linea21/repository/changes/trunk/v1/class/class.plugin.php pour connaître les attributs de l'objet et les méthodes qui y sont liées.
45
46
47 1 Simon
h2. Exemple de fichier plugin.xml
48
49
<pre><code class="xml">
50
<?xml version="1.0" encoding="UTF-8"?>
51
<plugin>
52
	<pluginname>l21_gotoTop</pluginname>
53
	<description>Add a go to Top button on each pages</description>
54
	<version>1</version>
55
	<date>22-01-2012</date>
56
	<compatibility>1.5 +</compatibility>
57
	<author>Simon Georget</author>
58
	<homepage>http://www.empreinte-urbaine.eu</homepage>
59
	<default_language>fr</default_language>
60 4 Simon
        <image>plugin.png</image>
61 1 Simon
	<apps>
62
		<app>public</app>
63
		<app>admin</app>
64
	</apps>
65
</plugin>
66
</code>
67
</pre>
68
69
La balise <apps> définit la portée du plugin. Elle peut comporter un ou plusieurs tags, selon que le plugin est utile à l'interface publique, à l'interface d'administration ou au deux -comme dans l'exemple ci-dessus.
70
71
72
h2. Exemple de l'architecture d'un plugin 
73
74 3 Simon
La capture d'écran ci-dessous décrit l'architecture du plugin l21_gotoTop affichant une flèche permettant à l'utilisateur de revenir en haut de page à tout moment.
75 1 Simon
76 3 Simon
!plugin.png!
77
78
79
Pour accéder au code source du plugin, "suivez le lien":http://dev.linea21.com/projects/linea21/repository/show/trunk/v1/plugins/l21_gotoTop.