diff --git a/lib/redmine/hook.rb b/lib/redmine/hook.rb index 84c33e326..7b06dc99f 100644 --- a/lib/redmine/hook.rb +++ b/lib/redmine/hook.rb @@ -1,16 +1,16 @@ # Redmine - project management software -# Copyright (C) 2006-2008 Jean-Philippe Lang +# Copyright (C) 2006-2011 Jean-Philippe Lang # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License # as published by the Free Software Foundation; either version 2 # of the License, or (at your option) any later version. -# +# # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. -# +# # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. @@ -22,7 +22,7 @@ module Redmine @@listener_classes = [] @@listeners = nil @@hook_listeners = {} - + class << self # Adds a listener class. # Automatically called when a class inherits from Redmine::Hook::Listener. @@ -31,29 +31,29 @@ module Redmine @@listener_classes << klass clear_listeners_instances end - + # Returns all the listerners instances. def listeners @@listeners ||= @@listener_classes.collect {|listener| listener.instance} end - + # Returns the listeners instances for the given hook. def hook_listeners(hook) @@hook_listeners[hook] ||= listeners.select {|listener| listener.respond_to?(hook)} end - + # Clears all the listeners. def clear_listeners @@listener_classes = [] clear_listeners_instances end - + # Clears all the listeners instances. def clear_listeners_instances @@listeners = nil @@hook_listeners = {} end - + # Calls a hook. # Returns the listeners response. def call_hook(hook, context={}) @@ -101,11 +101,11 @@ module Redmine def self.default_url_options {:only_path => true } end - + # Helper method to directly render a partial using the context: - # + # # class MyHook < Redmine::Hook::ViewListener - # render_on :view_issues_show_details_bottom, :partial => "show_more_data" + # render_on :view_issues_show_details_bottom, :partial => "show_more_data" # end # def self.render_on(hook, options={}) @@ -117,23 +117,23 @@ module Redmine # Helper module included in ApplicationHelper and ActionControllerso that # hooks can be called in views like this: - # + # # <%= call_hook(:some_hook) %> # <%= call_hook(:another_hook, :foo => 'bar' %> - # + # # Or in controllers like: # call_hook(:some_hook) # call_hook(:another_hook, :foo => 'bar' - # + # # Hooks added to views will be concatenated into a string. Hooks added to # controllers will return an array of results. # # Several objects are automatically added to the call context: - # + # # * project => current project # * request => Request instance # * controller => current Controller instance - # + # module Helper def call_hook(hook, context={}) if is_a?(ActionController::Base) @@ -142,7 +142,7 @@ module Redmine else default_context = {:controller => controller, :project => @project, :request => request} Redmine::Hook.call_hook(hook, default_context.merge(context)).join(' ') - end + end end end end