Fr Plugin072to078 » History » Version 60

yllen, 01/21/2011 03:43 PM

1 37 tsmr
h1. Migration d'un plugin de GLPI 0.72 vers 0.78
2 1 remi
3 4 remi
{{toc}}
4 4 remi
5 39 tsmr
Entre la version 0.72 et la version 0.78 de GLPI de nombreux changements ont été implémentés, autant sur la base de données que sur la structure des fichiers. L'utilisation de l'auto-chargement de classes simplifie grandement le codage de plugins.
6 39 tsmr
Pour mettre à jour un plugin en 0.78, plusieurs étapes sont nécessaires :
7 39 tsmr
8 39 tsmr
 * Modification des tables et champs utilisés
9 39 tsmr
 * Modification des noms de fichiers
10 39 tsmr
 * Insertion des fonctions dans les classes
11 39 tsmr
 * Prise en charge des modifications de fonctions du cœur
12 39 tsmr
 * Nouveaux hooks disponibles
13 39 tsmr
 * Modification de la gestion des objets de type dropdown (listes déroulantes)
14 1 remi
15 42 yllen
16 5 remi
h2. Database
17 5 remi
18 2 tsmr
h3. CleanDB
19 1 remi
20 2 tsmr
Le coeur a subi d'importantes modification au niveau base de données :
21 2 tsmr
22 2 tsmr
https://forge.indepnet.net/wiki/glpi/CleanDbStudy
23 2 tsmr
24 41 yllen
25 40 yllen
26 43 yllen
27 43 yllen
28 43 yllen
h1. MODIFICATIONS A EFFECTUER DANS LES PLUGINS
29 43 yllen
30 43 yllen
31 43 yllen
h2. Règle de nommage des tables d'un plugin
32 43 yllen
33 43 yllen
*Nom de table d'un objet*
34 43 yllen
glpi_plugin_nomduplugin_objets (le nom de l'objet doit être au pluriel)
35 43 yllen
> ex: glpi_plugin_monplugin_profiles
36 43 yllen
37 43 yllen
*Nom de table d'un sous-objet*
38 43 yllen
glpi_plugin_nomduplugin_objetsousobjets (le nom de l'objet doit être au singulier et celui du sous-objet au pluriel)
39 43 yllen
> ex: glpi_plugin_monplugin_profiletypes
40 43 yllen
41 43 yllen
*Nom de table de 2 objets liés*
42 43 yllen
glpi_plugin_nomduplugin_objets1_objets2 (les noms des 2 objets liés doivent être au pluriel)
43 43 yllen
> ex: glpi_plugin_monplugin_profiles_entities
44 43 yllen
45 43 yllen
46 45 yllen
h2. Règle de nommage des pages d'un plugin
47 43 yllen
48 45 yllen
A chaque table du plugin doit correspondre un fichier  object.class (objet au singulier)
49 45 yllen
> ex: table glpi_plugin_monplugin_profiles  => fichier profile.class
50 43 yllen
51 45 yllen
52 52 yllen
h2. Modification dans les fichiers .class
53 52 yllen
54 52 yllen
Règle de nommage des class d'un plugin : new PluginNomdemonpluginProfile(); (nom de la class au singulier)
55 52 yllen
56 52 yllen
La fonction __construct () listant uniquement le nom de la table et le type n'est plus nécessaire
57 52 yllen
58 52 yllen
59 52 yllen
60 52 yllen
61 45 yllen
h2. Hook.php
62 45 yllen
63 45 yllen
h3. function plugin_monplugin_get_headings
64 45 yllen
65 45 yllen
h3. function plugin_monplugin_headings
66 45 yllen
67 45 yllen
Changement des paramètres d'appel de ces 2 fonctions ($type,$ID,$withtemplate => $item,$withtemplate)
68 45 yllen
<pre>
69 45 yllen
function plugin_monplugin_get_headings($item,$withtemplate) {
70 45 yllen
71 45 yllen
   $type = get_class($item);
72 45 yllen
   if ($type == 'Profile') {
73 45 yllen
</pre>
74 45 yllen
75 45 yllen
76 45 yllen
h3. function plugin_monplugin_headings_actions
77 45 yllen
78 45 yllen
Changement des paramètres d'appel de la fonction ($type => $item)
79 45 yllen
80 45 yllen
81 45 yllen
82 45 yllen
h2. setup.php
83 45 yllen
84 45 yllen
h3. function plugin_monplugin_init
85 45 yllen
86 45 yllen
Ajout des noms de class du plugin dans les types généraux du coeur
87 45 yllen
<pre>    
88 45 yllen
registerPluginType('typedemonplugin', 'PLUGIN_MONPLUGIN_TYPE', 'PluginMonpluginObjet',
89 45 yllen
                      array('classname'              => 'PluginMonpluginObjet',
90 45 yllen
                            'tablename'              => 'glpi_plugin_appliances_appliances',
91 45 yllen
                            'searchpage'             => 'index.php',
92 45 yllen
                            ...
93 45 yllen
</pre>
94 1 remi
devient
95 45 yllen
<pre>
96 54 yllen
Plugin::registerClass('PluginMonpluginProfile, array('classname' => 'PluginMonpluginObjet',                                         ...
97 45 yllen
</pre>
98 1 remi
99 1 remi
Modification des hooks sur les actions de GLPI
100 52 yllen
101 45 yllen
<pre>
102 1 remi
$PLUGIN_HOOKS['pre_item_add']['monplugin'] = 'plugin_pre_item_adde_monplugin';
103 1 remi
devient
104 1 remi
$PLUGIN_HOOKS['pre_item_add']['monplugin'] = array('Computer' =>'plugin_pre_item_update_monplugin');
105 52 yllen
</pre>
106 45 yllen
107 45 yllen
 
108 54 yllen
<pre> $PLUGIN_HOOKS['pre_item_delete']['monplugin'] = 'plugin_pre_item_monplugin_delete';
109 54 yllen
110 50 yllen
devient
111 54 yllen
$PLUGIN_HOOKS['pre_item_purge']['monplugin'] = objet => function
112 52 yllen
ou
113 50 yllen
$PLUGIN_HOOKS['pre_item_purge']['monplugin'] = objet => array('Class', 'Méthode')); </pre>
114 45 yllen
115 1 remi
116 45 yllen
117 51 yllen
h2. Méthodes obligatoires
118 52 yllen
119 51 yllen
candelete....
120 45 yllen
121 45 yllen
122 45 yllen
123 45 yllen
124 40 yllen
h1. MODIFICATIONS DU COEUR IMPACTANT LES PLUGINS
125 42 yllen
126 41 yllen
h2. CommonDBTM
127 42 yllen
128 41 yllen
h3. showFormHeader
129 1 remi
130 45 yllen
Nouveau prototype
131 41 yllen
<pre>
132 1 remi
function showFormHeader ($options=array())
133 41 yllen
</pre>
134 1 remi
135 1 remi
Nouveau fonctionnement :
136 1 remi
* passage par défaut des form sur 2 colonnes
137 1 remi
* ouverture des <form, <div (tabsbody) et <table (tab_cadre_fixe)
138 1 remi
* champs cachés : entities_id, _no_message_link, template_name et is_template 
139 41 yllen
140 1 remi
Conseil : à utiliser conjointement avec showFormButtons
141 41 yllen
142 42 yllen
h3. showFormButtons
143 41 yllen
144 1 remi
Nouvelle fonction (factorisation du code)
145 1 remi
146 1 remi
<pre>
147 1 remi
function showFormButtons ($options=array())
148 1 remi
</pre>
149 1 remi
150 1 remi
Fonctionnement :
151 1 remi
* fermeture des <form, <div et <table
152 1 remi
* champs cachés : id
153 3 remi
154 42 yllen
h3. can / check
155 1 remi
156 1 remi
Nouveau prototype
157 1 remi
158 1 remi
<pre>
159 42 yllen
function can($ID,$right,&$input=NULL)
160 42 yllen
function check($ID,$right,&$input=NULL)
161 42 yllen
</pre>
162 42 yllen
163 42 yllen
Le paramètre $input, uniquement requis lors d'un ajout, attend les valeurs à ajouter (souvent le $_POST) et pas uniquement l'entité cible.
164 42 yllen
165 42 yllen
h3. cleanDBonPurge
166 42 yllen
167 42 yllen
Les méthodes fournies par le coeur (cleanRelationData/cleanRelationTable) nettoient les enregistrements liés des tables lors de la suppression d'un objet.
168 1 remi
* glpi_contracts_items (if registered in 'contract_types')
169 42 yllen
* glpi_documents_items (doc_types)
170 42 yllen
* glpi_infocoms (infocom_types)
171 42 yllen
* glpi_networkports et glpi_networkports_networkports (netport_types)
172 1 remi
* glpi_reservationitems (reservation_types)
173 42 yllen
* glpi_tickets (helpdesk_types)
174 1 remi
175 1 remi
Il n'est donc plus utile de le prévoir dans la méthode *cleanDBonPurge* du type, mais de s'assurer de l'enrichissement des tableaux lors du *Plugin::registerClass*.
176 1 remi
177 1 remi
178 1 remi
h3. Changement du nom des types d'objet
179 1 remi
180 1 remi
A vérifier dans le define.php (PROFILE_TYPE => 'Profile', COMPUTER_TYPE => 'Computer',.....)
181 1 remi
182 1 remi
183 59 yllen
h3. Classes renommées
184 59 yllen
185 59 yllen
<pre>Enterprise   =>   Supplier</pre>
186 59 yllen
187 59 yllen
188 1 remi
h3. Variables de session
189 58 yllen
190 59 yllen
<pre>$_SESSION["glpiview_ID"]  =>  $_SESSION["glpiis_ids_visible"] </pre>
191 59 yllen
192 60 yllen
<pre>$_SESSION['glpiID']       =>  getLoginUserID()</pre>
193 58 yllen
194 54 yllen
195 1 remi
h3. Variables globales
196 54 yllen
197 1 remi
Suppression de $INFOFORM_PAGES;
198 54 yllen
199 1 remi
Création de la constante globale  DROPDOWN_EMPTY_VALUE pour remplacer les ----- dans les dropdowns
200 1 remi
201 56 tsmr
202 1 remi
h3. Configuration
203 54 yllen
204 60 yllen
<pre>$CFG_GLPI["mailing"]                   =>   $CFG_GLPI["use_mailing"]</pre>
205 54 yllen
206 60 yllen
<pre> $CFG_GLPI["deleted_tables"]           =>   $item->maybeDeleted()</pre>
207 1 remi
208 60 yllen
<pre> $CFG_GLPI["template_tables"]          =>  $item->maybeTemplate()</pre>
209 54 yllen
210 54 yllen
<pre> $CFG_GLPI["specif_entities_tables"]   =>   $item->isEntityAssign()</pre>
211 1 remi
212 60 yllen
<pre> $CFG_GLPI["dropdowntree_tables"]      =>   $item instanceof CommonTreeDropdown </pre>
213 1 remi
214 58 yllen
215 1 remi
216 1 remi
h3. Fonctions supprimées
217 1 remi
218 1 remi
Liste alphabétique :
219 1 remi
220 58 yllen
|| *Ancienne fonction* || *Alternative* ||
221 58 yllen
|| addDeviceDocument()              || Document_Item->add(...) ||
222 58 yllen
|| addDeviceContract()              || Contract_Item->add(...) ||
223 58 yllen
|| addDropdown()                    || Dropdown::import(...)   ||
224 58 yllen
|| cleanCache();                    || ||
225 58 yllen
|| dropdownAllItems()               || Dropdown::showAllItems(...)  ||
226 58 yllen
|| dropdownArrayValues[ReadOnly]()  || Dropdown::showFromArray(...)  ||
227 58 yllen
|| dropdownConnectPort()            || NetworkPort::dropdownConnect(...)  ||
228 58 yllen
|| dropdownHours()                  || Dropdown::showHours(...) ||
229 58 yllen
|| dropdownInteger()                || Dropdown::showInteger(...)  ||
230 58 yllen
|| dropdownLanguages()              || Dropdown::showLanguages(...)  ||
231 58 yllen
|| dropdownNoneReadWrite()          || Profile::dropdownNoneReadWrite(...) ||
232 58 yllen
|| dropdownNoValue()                || Dropdown::show(...) ||
233 58 yllen
|| dropdownPlanningState()          || Planning::dropdownState(...) ||
234 58 yllen
|| dropdownRequestType(...)         || Dropdown::show('RequestType', ...) ||
235 58 yllen
|| dropdownRules()                  || Rule::dropdown()  ||
236 58 yllen
|| dropdownValue()                  || Dropdown::show(...) ||
237 58 yllen
|| dropdownyesno()                  || Dropdown::showYesNo(...)  ||
238 58 yllen
|| externalImportDropdown()         || Dropdowwn::importExternal(...)  ||
239 58 yllen
|| getAllDropdown()                 || Dropdown::getStandardDropdownItemTypes()  ||
240 58 yllen
|| getContractSuppliers()           || Contract->getSuppliersNames()         || 
241 58 yllen
|| getDocumentLink()                || Document->getDownloadLink(...) ||
242 58 yllen
|| getDropdownName()                || Dropdown::getDropdownName(...) ||
243 58 yllen
|| getPlanningState()               || Planning::getState(...) ||
244 58 yllen
|| getRequestTypeName(...)          || Dropdown::getDropdownName('glpi_requesttypes',...) ||
245 58 yllen
|| getYesNo()                       || Dropdown::getYesNo(...)  ||
246 58 yllen
|| globalManagementDropdown()       || Dropdown::showGlobalSwitch(...)  ||
247 58 yllen
|| haveTypeRight($type,'r')         || $item = new $type();  $item->canGlobal('r') ||
248 58 yllen
|| haveTypeRight($itemtype,'r')     || $item = new $itemtype();  $item->canView('r') ||
249 58 yllen
|| privatepublicSwitch()            || Dropdown::showPrivatePublicSwitch(...)  ||
250 58 yllen
|| registerPluginType()             || Plugin::registerClass(...)         ||
251 58 yllen
|| showContractAssociated()         || Contract::showAssociated(...) ||
252 58 yllen
|| showDocumentAssociated()         || Document::showAssociated(...) ||
253 28 remi
|| showInfocomForm()                || Infocom::showForItem(...) ||
254 28 remi
|| showSaveBookmarkButton()         || Bookmark::showSaveButton(...) ||
255 1 remi
|| useplugin                        || Plugin::load(...)  ||
256 1 remi
257 1 remi
258 59 yllen
h3. getSearchOptions
259 1 remi
260 59 yllen
Cette nouvelle méthode doit retourner les options de recherche pour le type courant.
261 1 remi
262 1 remi
263 1 remi
h3. Utilisation Mbstring pour gérer UTF8
264 1 remi
265 1 remi
<pre>substr        =>   utf8_substr</pre>
266 60 yllen
267 1 remi
<pre>utf8_decode   =>   decodeFromUtf8</pre>
268 60 yllen
269 59 yllen
<pre>utf8_encode   =>   encodeFromUtf8</pre>
270 60 yllen
271 59 yllen
<pre>strtolower    =>   utf8_strtolower</pre>
272 60 yllen
273 59 yllen
<pre>strtoupper    =>   utf8_strtoupper</pre>
274 21 remi
275 21 remi
276 21 remi
277 38 ddurieux
278 59 yllen
h1. A REVOIR
279 38 ddurieux
280 38 ddurieux
281 38 ddurieux
282 38 ddurieux
h2. HOOK supprimés
283 38 ddurieux
284 38 ddurieux
* plugin_example_getAddSearchOption() : remplacé par la méthode getSearchOptions du type et le hook plugin_example_getAddSearchOptions
285 38 ddurieux
286 38 ddurieux
h2. HOOK ajoutés
287 38 ddurieux
288 47 tsmr
* plugin_example_getAddSearchOptions($itemtype) retourne les options de recherche ajoutées par le plugin aux types existants
289 47 tsmr
* 0.78.2 : plugin_example_searchOptionsValues($params = array()) permet de faire des recherche sur le moteur avec un drodpdown particulier (interne au plugin)
290 38 ddurieux
* 0.78.2 : plugin_example_displayConfigItem($type,$ID,$data,$num) Permet de personnaliser le style du <td> dans la liste des objets
291 12 remi
292 12 remi
293 12 remi
h2. Tâche planifiée
294 12 remi
295 12 remi
Le hook *'cron'* n'est plus utilisé
296 12 remi
297 12 remi
Lors de l'installation un plugin peut enregistrer une tâche en utilisant
298 12 remi
<pre>
299 12 remi
   CronTask::Register('pluginame', 'taskname', DAY_TIMESTAMP, array('param'=>50));
300 12 remi
</pre>
301 12 remi
La suppression est automatiquement réalisée par le coeur lors de la désinstallation du plugin.
302 12 remi
303 12 remi
Il devrait ensuite fournir 1 fonction
304 12 remi
<pre>
305 12 remi
function plugin_example_cron_info($name)
306 12 remi
</pre>
307 12 remi
Qui retourne un tableau à 2 entrées pour la tâche $name comprenant 'description' (description localisée de la tâche) et 'parameter' (optionnel, description localisée du paramètre)
308 12 remi
309 12 remi
Et pour chaque tâche, une fonction d'exécution
310 12 remi
<pre>
311 12 remi
function plugin_example_cron_sample_run($task)
312 12 remi
</pre>
313 12 remi
L'objet $task permet d'enregistrer des évenements ($task->log) et des statistiques ($task->add/setVolume)
314 1 remi
Le code retour doit être : 0 (rien à faire), >0 (terminé) ou <0 (à continuer)