kanbanworkflowstimelinescrumrubyroadmapproject-planningproject-managementopenprojectangularissue-trackerifcgantt-chartganttbug-trackerboardsbcf
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
62 lines
2.3 KiB
62 lines
2.3 KiB
#-- encoding: UTF-8
|
|
#-- copyright
|
|
# OpenProject is a project management system.
|
|
# Copyright (C) 2012-2015 the OpenProject Foundation (OPF)
|
|
#
|
|
# This program is free software; you can redistribute it and/or
|
|
# modify it under the terms of the GNU General Public License version 3.
|
|
#
|
|
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
|
|
# Copyright (C) 2006-2013 Jean-Philippe Lang
|
|
# Copyright (C) 2010-2013 the ChiliProject Team
|
|
#
|
|
# 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.
|
|
#
|
|
# See doc/COPYRIGHT.rdoc for more details.
|
|
#++
|
|
|
|
class Setting
|
|
module Callbacks
|
|
# register a callback for a setting named #name
|
|
def register_callback(name, &callback)
|
|
# register the block with the underlying notifications system
|
|
notifier.subscribe(notification_event_for(name), &callback)
|
|
end
|
|
|
|
# instructs the underlying notifications system to publish all setting events for setting #name
|
|
# based on the new and old setting objects different events can be triggered
|
|
# currently, that's whenever a setting is set regardless whether the value changed
|
|
def fire_callbacks(name, setting, old_setting)
|
|
notifier.send(notification_event_for(name), event_payload_for(setting, old_setting))
|
|
end
|
|
|
|
private
|
|
|
|
# encapsulates the event name broadcast to all subscribers
|
|
def notification_event_for(name)
|
|
"setting.#{name}.changed"
|
|
end
|
|
|
|
# encapsulates the payload expected by the notifier
|
|
def event_payload_for(setting, old_setting)
|
|
{ value: setting.value, old_value: old_setting.value }
|
|
end
|
|
|
|
# the notifier to delegate to
|
|
def notifier
|
|
OpenProject::Notifications
|
|
end
|
|
end
|
|
end
|
|
|