/
Events_Reference_Bug.xml
485 lines (395 loc) · 14.5 KB
/
Events_Reference_Bug.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Developers_Guide.ent">
%BOOK_ENTITIES;
]>
<sect1 id="dev.eventref.bug">
<title>Bug and Bugnote Events</title>
<sect2 id="dev.eventref.bug.view">
<title>Bug View</title>
<blockquote id="dev.eventref.bug.view.details">
<title>EVENT_VIEW_BUG_DETAILS (Execute)</title>
<blockquote>
<para>
This event allows a plugin to either process information or display some
data in the bug view page. It is triggered after the row containing the
target version and product build fields, and before the bug summary is
displayed.
</para>
<para>
Any output here should be defining appropriate rows and columns for the
surrounding <programlisting><table></programlisting> elements.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.view.extra">
<title>EVENT_VIEW_BUG_EXTRA (Execute)</title>
<blockquote>
<para>
This event allows a plugin to either process information or display some
data in the bug view page. It is triggered after the bug notes have been
displayed, but before the history log is shown.
</para>
<para>
Any output here should be contained within its own
<programlisting><table></programlisting> element.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
</sect2>
<sect2 id="dev.eventref.bug.action">
<title>Bug Actions</title>
<blockquote id="dev.eventref.bug.action.reportbugform">
<title>EVENT_REPORT_BUG_FORM (Execute)</title>
<blockquote>
<para>
This event allows plugins to do processing or display form elements on
the Report Issue page. It is triggered immediately before the summary
text field.
</para>
<para>
Any output here should be defining appropriate rows and columns for the
surrounding <table> elements.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Project ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.action.reportbugformtop">
<title>EVENT_REPORT_BUG_FORM_TOP (Execute)</title>
<blockquote>
<para>
This event allows plugins to do processing or display form elements at
the top of the Report Issue page. It is triggered before any of the
visible form elements have been created.
</para>
<para>
Any output here should be defining appropriate rows and columns for the
surrounding <table> elements.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Project ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.action.reportbugdata">
<title>EVENT_REPORT_BUG_DATA (Chain)</title>
<blockquote>
<para>
This event allows plugins to perform pre-processing of the new bug data
structure after being reported from the user, but before the data is
saved to the database. At this point, the issue ID is not yet known, as
the data has not yet been persisted.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Complex>: Bug data structure (see <filename>core/bug_api.php</filename>)</para></listitem>
</itemizedlist>
<itemizedlist>
<title>Return Value</title>
<listitem><para><Complex>: Bug data structure</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.action.reportbug">
<title>EVENT_REPORT_BUG (Execute)</title>
<blockquote>
<para>
This event allows plugins to perform post-processing of the bug data
structure after being reported from the user and being saved to the
database. At this point, the issue ID is actually known, and is passed
as a second parameter.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Complex>: Bug data structure (see <filename>core/bug_api.php</filename>)</para></listitem>
<listitem><para><Integer>: Bug ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.action.updatebugform">
<title>EVENT_UPDATE_BUG_FORM (Execute)</title>
<blockquote>
<para>
This event allows plugins to do processing or display form elements on
the Update Issue page. It is triggered immediately before the summary
text field.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.action.updatebugformtop">
<title>EVENT_UPDATE_BUG_FORM_TOP (Execute)</title>
<blockquote>
<para>
This event allows plugins to do processing or display form elements on
the Update Issue page. It is triggered immediately before before any
of the visible form elements have been created.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.action.bugchangestatusform">
<title>EVENT_BUG_CHANGE_STATUS_FORM (Execute)</title>
<blockquote>
<para>
This event allows plugins to do processing or display form elements in
the bug change status form. It is triggered immediately before the add bugnote
fields.
</para>
<para>
Any output here should be defining appropriate rows and columns for the
surrounding <table> elements.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.action.updatebugdata">
<title>EVENT_UPDATE_BUG_DATA (Chain)</title>
<blockquote>
<para>
This event allows plugins to perform pre-processing of the updated
bug data structure after being modified by the user, but before
being saved to the database.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Complex>: Updated bug data structure (see <filename>core/bug_api.php</filename>)</para></listitem>
<listitem><para><Complex>: Original bug data structure (see <filename>core/bug_api.php</filename>)</para></listitem>
</itemizedlist>
<itemizedlist>
<title>Return Value</title>
<listitem><para><Complex>: Updated bug data structure (see <filename>core/bug_api.php</filename>)</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.action.updatebug">
<title>EVENT_UPDATE_BUG (Execute)</title>
<blockquote>
<para>
This event allows plugins to perform post-processing of the bug data
structure after being updated.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Complex>: Original bug data structure (see <filename>core/bug_api.php</filename>)</para></listitem>
<listitem><para><Complex>: Updated bug data structure (see <filename>core/bug_api.php</filename>)</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.action.bugaction">
<title>EVENT_BUG_ACTION (Execute)</title>
<blockquote>
<para>
This event allows plugins to perform post-processing of group actions
performed from the View Issues page. The event will get called for
each bug ID that was part of the group action event.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><String>: Action title (see <filename>bug_actiongroup.php</filename>)</para></listitem>
<listitem><para><Integer>: Bug ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.action.bugdelete">
<title>EVENT_BUG_DELETED (Execute)</title>
<blockquote>
<para>
This event allows plugins to perform pre-processing of bug deletion
actions. The actual deletion will occur after execution of the event,
for compatibility reasons.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
</sect2>
<sect2 id="dev.eventref.bug.noteview">
<title>Bugnote View</title>
<blockquote id="dev.eventref.bug.noteview.start">
<title>EVENT_VIEW_BUGNOTES_START (Execute)</title>
<blockquote>
<para>
This event allows a plugin to either process information or display some
data in the bug notes section, before any bug notes are displayed. It is
triggered after the bug notes section title.
</para>
<para>
Any output here should be defining appropriate rows and columns for the
surrounding <table> elements.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
<listitem><para><Complex>: A list of all bugnotes to be displayed to the user</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.noteview.note">
<title>EVENT_VIEW_BUGNOTE (Execute)</title>
<blockquote>
<para>
This event allows a plugin to either process information or display some
data in the bug notes section, interleaved with the individual bug notes.
It gets triggered after every bug note is displayed.
</para>
<para>
Any output here should be defining appropriate rows and columns for the
surrounding <table> elements.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
<listitem><para><Integer>: Bugnote ID</para></listitem>
<listitem><para><Boolean>: Private bugnote (false if public)</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.noteview.end">
<title>EVENT_VIEW_BUGNOTES_END (Execute)</title>
<blockquote>
<para>
This event allows a plugin to either process information or display some
data in the bug notes section, after all bugnotes have been displayed.
</para>
<para>
Any output here should be defining appropriate rows and columns for the
surrounding <table> elements.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
</sect2>
<sect2 id="dev.eventref.bug.noteaction">
<title>Bugnote Actions</title>
<blockquote id="dev.eventref.bug.noteaction.addform">
<title>EVENT_BUGNOTE_ADD_FORM (Execute)</title>
<blockquote>
<para>
This event allows plugins to do processing or display form elements in
the bugnote adding form. It is triggered immediately after the bugnote
text field.
</para>
<para>
Any output here should be defining appropriate rows and columns for the
surrounding <table> elements.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.noteaction.add">
<title>EVENT_BUGNOTE_ADD (Execute)</title>
<blockquote>
<para>
This event allows plugins to do post-processing of bugnotes added to an
issue.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
<listitem><para><Integer>: Bugnote ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.noteaction.editform">
<title>EVENT_BUGNOTE_EDIT_FORM (Execute)</title>
<blockquote>
<para>
This event allows plugins to do processing or display form elements in
the bugnote editing form. It is triggered immediately after the bugnote
text field.
</para>
<para>
Any output here should be defining appropriate rows and columns for the
surrounding <table> elements.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
<listitem><para><Integer>: Bugnote ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.noteaction.edit">
<title>EVENT_BUGNOTE_EDIT (Execute)</title>
<blockquote>
<para>
This event allows plugins to do post-processing of bugnote edits.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
<listitem><para><Integer>: Bugnote ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.noteaction.deleted">
<title>EVENT_BUGNOTE_DELETED (Execute)</title>
<blockquote>
<para>
This event allows plugins to do post-processing of bugnote deletions.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
<listitem><para><Integer>: Bugnote ID</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.action.tagattached">
<title>EVENT_TAG_ATTACHED (Execute)</title>
<blockquote>
<para>
This event allows plugins to do post-processing of attached tags.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
<listitem><para><Array of Integers>: Tag IDs</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
<blockquote id="dev.eventref.bug.action.tagdetached">
<title>EVENT_TAG_DETACHED (Execute)</title>
<blockquote>
<para>
This event allows plugins to do post-processing of detached tags.
</para>
<itemizedlist>
<title>Parameters</title>
<listitem><para><Integer>: Bug ID</para></listitem>
<listitem><para><Array of Integers>: Tag IDs</para></listitem>
</itemizedlist>
</blockquote>
</blockquote>
</sect2>
</sect1>