Adds #activity_provider shortcut method to the plugin API.

git-svn-id: http://redmine.rubyforge.org/svn/trunk@1702 e93f8b46-1217-0410-a6f0-8f06a7374b81
This commit is contained in:
Jean-Philippe Lang 2008-07-27 18:38:31 +00:00
parent a774c5c48b
commit d05bcda2ba
2 changed files with 26 additions and 8 deletions

View File

@ -30,14 +30,6 @@ module Redmine
end end
# Registers an activity provider # Registers an activity provider
#
# Options:
# * :class_name - one or more model(s) that provide these events (inferred from event_type by default)
# * :default - setting this option to false will make the events not displayed by default
#
# Examples:
# register :issues
# register :myevents, :class_name => 'Meeting'
def register(event_type, options={}) def register(event_type, options={})
options.assert_valid_keys(:class_name, :default) options.assert_valid_keys(:class_name, :default)

View File

@ -117,6 +117,32 @@ module Redmine #:nodoc:
@project_module = nil @project_module = nil
end end
# Registers an activity provider.
#
# Options:
# * <tt>:class_name</tt> - one or more model(s) that provide these events (inferred from event_type by default)
# * <tt>:default</tt> - setting this option to false will make the events not displayed by default
#
# A model can provide several activity event types.
#
# Examples:
# register :news
# register :scrums, :class_name => 'Meeting'
# register :issues, :class_name => ['Issue', 'Journal']
#
# Retrieving events:
# Associated model(s) must implement the find_events class method.
# ActiveRecord models can use acts_as_activity_provider as a way to implement this class method.
#
# The following call should return all the scrum events visible by current user that occured in the 5 last days:
# Meeting.find_events('scrums', User.current, 5.days.ago, Date.today)
# Meeting.find_events('scrums', User.current, 5.days.ago, Date.today, :project => foo) # events for project foo only
#
# Note that :view_scrums permission is required to view these events in the activity view.
def activity_provider(*args)
Redmine::Activity.register(*args)
end
# Returns +true+ if the plugin can be configured. # Returns +true+ if the plugin can be configured.
def configurable? def configurable?
settings && settings.is_a?(Hash) && !settings[:partial].blank? settings && settings.is_a?(Hash) && !settings[:partial].blank?