From: Tamás G. <gt...@gt...> - 2010-09-08 10:59:52
|
Hi, Please advise me: for (small) customizations (for example print out the uploader's login name beside the attachment in the bug view page), which method is preferred? a) just modify core/print_api.php / print_bug_attachments_list, b) modify core/print_api.php to print the uploader login if a (newly defined global variable says so), c) insert a new event (in core/print_api.php) and use that in a plugin? a) is the easiest, but least flexible (thus I think upstream would refuse it), b) is maybe approvable, c) is the most flexible - but sould I invent a new event for every little customization? Thanks in advance, Tamás Gulácsi |
From: John R. <jr...@le...> - 2010-09-08 13:52:15
|
On 09/08/2010 06:59 AM, Tamás Gulácsi wrote: > Hi, > > Please advise me: for (small) customizations (for example print out > the uploader's login name beside the attachment in the bug view page), > which method is preferred? > a) just modify core/print_api.php / print_bug_attachments_list, > b) modify core/print_api.php to print the uploader login if a (newly > defined global variable says so), > c) insert a new event (in core/print_api.php) and use that in a plugin? > > a) is the easiest, but least flexible (thus I think upstream would > refuse it), b) is maybe approvable, c) is the most flexible - but > sould I invent a new event for every little customization? My general rule-of-thumb for plugin events is this: Can you imagine more than your one specific use of the event? If the event would only be useful for your exact context, then it's probably better to maintain a patch against the core (a or b), or submit a feature request to our tracker. If you can think of multiple uses for the event, or an event that would be useful to more than one plugin, or if you can try to further generalize the event to encompass more possibilities, then it might be better to create a new event and submit that as a feature request. If you do decide to create/propose a new event, please try to update the developer guide documentation with the event's usage, parameters, and return values, and include that update as part of the patch proposal. Also of benefit would be an explanation/example of how a plugin might use the event, which could just be submitted as part of the feature request. Cheers, and I hope this helped :) -- John Reese LeetCode.net |