mirrored from git://git.moodle.org/moodle.git
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'MDL66035' of https://github.com/jwalits/moodle into MOO…
…DLE_37_STABLE
- Loading branch information
Showing
6 changed files
with
486 additions
and
0 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
// This file is part of Moodle - http://moodle.org/ | ||
// | ||
// Moodle 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 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// Moodle 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 Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
/** | ||
* Controls the message preference page. | ||
* | ||
* @module core_message/message_preferences | ||
* @class message_preferences | ||
* @package message | ||
* @copyright 2016 Ryan Wyllie <ryan@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
define(['jquery', 'core/ajax', 'core/notification', | ||
'core_message/message_notification_preference', 'core/custom_interaction_events'], | ||
function($, Ajax, Notification, MessageNotificationPreference, CustomEvents) { | ||
|
||
var SELECTORS = { | ||
PREFERENCE: '[data-state]', | ||
PREFERENCES_CONTAINER: '[data-region="preferences-container"]', | ||
CONTACTABLE_PRIVACY_CONTAINER: '[data-region="privacy-setting-container"]', | ||
}; | ||
|
||
/** | ||
* Constructor for the MessagePreferences. | ||
* | ||
* @param {object} element The root element for the message preferences | ||
*/ | ||
var MessagePreferences = function(element) { | ||
this.root = $(element); | ||
this.userId = this.root.find(SELECTORS.PREFERENCES_CONTAINER).attr('data-user-id'); | ||
|
||
this.registerEventListeners(); | ||
}; | ||
|
||
/** | ||
* Check if the preferences have been disabled on this page. | ||
* | ||
* @method preferencesDisabled | ||
* @return {bool} | ||
*/ | ||
MessagePreferences.prototype.preferencesDisabled = function() { | ||
return this.root.find(SELECTORS.PREFERENCES_CONTAINER).hasClass('disabled'); | ||
}; | ||
|
||
/** | ||
* Update the contactable privacy user preference in the DOM and | ||
* send a request to update on the server. | ||
* | ||
* @return {Promise} | ||
* @method saveContactablePrivacySetting | ||
*/ | ||
MessagePreferences.prototype.saveContactablePrivacySetting = function() { | ||
var container = this.root.find(SELECTORS.CONTACTABLE_PRIVACY_CONTAINER); | ||
var value = $("input[type='radio']:checked").val(); | ||
|
||
if (container.hasClass('loading')) { | ||
return $.Deferred().resolve(); | ||
} | ||
|
||
container.addClass('loading'); | ||
|
||
var request = { | ||
methodname: 'core_user_update_user_preferences', | ||
args: { | ||
userid: this.userId, | ||
preferences: [ | ||
{ | ||
type: container.attr('data-preference-key'), | ||
value: value, | ||
} | ||
] | ||
} | ||
}; | ||
|
||
return Ajax.call([request])[0] | ||
.fail(Notification.exception) | ||
.always(function() { | ||
container.removeClass('loading'); | ||
}); | ||
}; | ||
|
||
/** | ||
* Create all of the event listeners for the message preferences page. | ||
* | ||
* @method registerEventListeners | ||
*/ | ||
MessagePreferences.prototype.registerEventListeners = function() { | ||
CustomEvents.define(this.root, [ | ||
CustomEvents.events.activate | ||
]); | ||
|
||
this.root.on('change', function(e) { | ||
// Add listener for privacy setting radio buttons change. | ||
if (e.target.name == 'message_blocknoncontacts') { | ||
this.saveContactablePrivacySetting(); | ||
} else { | ||
// Add listener for processor preferences. | ||
if (!this.preferencesDisabled()) { | ||
var preferencesContainer = $(e.target).closest(SELECTORS.PREFERENCES_CONTAINER); | ||
var preferenceElement = $(e.target).closest(SELECTORS.PREFERENCE); | ||
var messagePreference = new MessageNotificationPreference(preferencesContainer, this.userId); | ||
|
||
preferenceElement.addClass('loading'); | ||
messagePreference.save().always(function() { | ||
preferenceElement.removeClass('loading'); | ||
}); | ||
} | ||
} | ||
}.bind(this)); | ||
}; | ||
|
||
return MessagePreferences; | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
{{! | ||
This file is part of Moodle - http://moodle.org/ | ||
Moodle 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 3 of the License, or | ||
(at your option) any later version. | ||
Moodle 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 Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
}} | ||
{{! | ||
@template core_message/message_preferences | ||
The message preferences page | ||
Classes required for JS: | ||
* None | ||
Data attibutes required for JS: | ||
* All data attributes are required | ||
Context variables required for this template: | ||
* userid The logged in user id | ||
* disableall If the user has disabled notifications | ||
* components The list of notification components | ||
* privacychoices The choice options for the contactable privacy setting | ||
Example context (json): | ||
{ | ||
"userid": 1, | ||
"disableall": 0, | ||
"components": [ | ||
{ | ||
"notifications": [ | ||
{ | ||
"displayname": "Notices about minor problems", | ||
"preferencekey": "message_provider_moodle_notices", | ||
"onlinehelphtml": "<p>some help HTML</p>", | ||
"offlinehelphtml": "<p>some help HTML</p>", | ||
"processors": [ | ||
{ | ||
"displayname": "Popup notification", | ||
"name": "popup", | ||
"locked": 0, | ||
"userconfigured": 1, | ||
"loggedin": { | ||
"name": "loggedin", | ||
"displayname": "When I'm logged in", | ||
"checked": 0, | ||
"disableall": 0 | ||
}, | ||
"loggedoff": { | ||
"name": "loggedoff", | ||
"displayname": "When I'm offline", | ||
"checked": 0, | ||
"disableall": 0 | ||
} | ||
} | ||
] | ||
} | ||
] | ||
} | ||
], | ||
"privacychoices": [ | ||
{ | ||
"value": 1, | ||
"text": "My contacts only", | ||
"checked": 0 | ||
}, | ||
{ | ||
"value": 2, | ||
"text": "Anyone within courses I am a member of", | ||
"checked": 1 | ||
} | ||
] | ||
} | ||
}} | ||
<div class="preferences-page-container" data-region="preferences-page-container"> | ||
<h2>{{#str}} messagepreferences, message {{/str}}</h2> | ||
<div class="privacy-setting-container" | ||
data-user-id="{{userid}}" | ||
data-region="privacy-setting-container" | ||
data-preference-key="message_blocknoncontacts"> | ||
<p>{{#str}} contactableprivacy, message {{/str}}</p> | ||
{{#privacychoices}} | ||
<input id="action-selection-option-{{value}}" | ||
type="radio" | ||
name="message_blocknoncontacts" | ||
value="{{value}}" | ||
{{#checked}}checked="checked"{{/checked}}/> | ||
<label for="action-selection-option-{{value}}">{{text}}</label> | ||
<br> | ||
{{/privacychoices}} | ||
</div><br> | ||
<div class="preferences-container {{#disableall}}disabled{{/disableall}}" | ||
data-user-id="{{userid}}" | ||
data-region="preferences-container"> | ||
<table class="table table-hover preference-table" data-region="preference-table"> | ||
<tbody> | ||
{{#components}} | ||
{{> message/message_preferences_component }} | ||
{{/components}} | ||
</tbody> | ||
</table> | ||
</div> | ||
</div> | ||
{{#js}} | ||
require(['jquery', 'core_message/message_preferences'], | ||
function($, MessagePreferences) { | ||
new MessagePreferences($('[data-region="preferences-page-container"]')); | ||
}); | ||
{{/js}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
{{! | ||
This file is part of Moodle - http://moodle.org/ | ||
Moodle 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 3 of the License, or | ||
(at your option) any later version. | ||
Moodle 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 Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
}} | ||
{{! | ||
@template core_message/message_preferences_component | ||
The message preferences page | ||
Classes required for JS: | ||
* None | ||
Data attibutes required for JS: | ||
* All data attributes are required | ||
Context variables required for this template: | ||
* notifications The list of notifications | ||
Example context (json): | ||
{ | ||
"notifications": [ | ||
{ | ||
"displayname": "Notices about minor problems", | ||
"preferencekey": "message_provider_moodle_notices", | ||
"onlinehelphtml": "<p>some help HTML</p>", | ||
"offlinehelphtml": "<p>some help HTML</p>", | ||
"processors": [ | ||
{ | ||
"displayname": "Popup notification", | ||
"name": "popup", | ||
"locked": 0, | ||
"userconfigured": 1, | ||
"loggedin": { | ||
"name": "loggedin", | ||
"displayname": "When I'm logged in", | ||
"checked": 0, | ||
"disableall": 0 | ||
}, | ||
"loggedoff": { | ||
"name": "loggedoff", | ||
"displayname": "When I'm offline", | ||
"checked": 0, | ||
"disableall": 0 | ||
} | ||
} | ||
] | ||
} | ||
] | ||
} | ||
}} | ||
{{#notifications}} | ||
<tr data-preference-key="{{preferencekey}}"> | ||
<th>{{displayname}}</th> | ||
<td class="align-bottom"> | ||
<div class="container-fluid"> | ||
<div class="row-fluid"> | ||
<div class="span6 col-xs-6"> | ||
{{#str}} loggedin, message {{/str}} | ||
{{#onlinehelphtml}}{{{.}}}{{/onlinehelphtml}} | ||
</div> | ||
<div class="span6 col-xs-6"> | ||
{{#str}} loggedoff, message {{/str}} | ||
{{#offlinehelphtml}}{{{.}}}{{/offlinehelphtml}} | ||
</div> | ||
</div> | ||
</div> | ||
</td> | ||
</tr> | ||
{{#processors}} | ||
{{> message/message_preferences_notification_processor }} | ||
{{/processors}} | ||
{{/notifications}} |
Oops, something went wrong.