MDL-65318 core_calendar: Additional fixes
* Move 'calendareventtype' property to event_exporter_base and rename it to 'normalisedeventtype' * Add a 'normalisedeventtypetext' property to event_exporter_base for displaying the human-friendly text for the normalised event type. * Clean up calendareventtype from other exporter/template locations * Fix template names.
This commit is contained in:
Jun Pataleta
committed by
Simey Lameze
Simey Lameze
parent
a67bbe5039
commit
ab709ed274
+1
-1
@@ -1 +1 @@
|
||||
define(["jquery","core/templates","core/str","core/notification","core_calendar/repository","core_calendar/events","core_calendar/selectors","core/modal_factory","core/modal_events","core_calendar/summary_modal"],function(a,b,c,d,e,f,g,h,i,j){var k=function(b){b=a(b),b.on("click",g.links.eventLink,function(b){var c,d=a(b.target),e=null;c=d.is(g.actions.viewEvent)?d:d.closest(g.actions.viewEvent),e=c.length?c.data("eventId"):d.find(g.actions.viewEvent).data("eventId"),e&&(b.preventDefault(),b.stopPropagation(),w(e))}),b.on("click",g.links.navLink,function(c){var d=b.find(g.wrapper),e=d.data("view"),f=d.data("courseid"),h=d.data("categoryid"),i=a(c.currentTarget);"month"===e?(m(b,i.attr("href"),i.data("year"),i.data("month"),f,h),c.preventDefault()):"day"===e&&(q(b,i.attr("href"),i.data("year"),i.data("month"),i.data("day"),f,h),c.preventDefault())})},l=function(c,h,i,j,k,l){r(c),l=l||c.find(g.wrapper),M.util.js_pending([c.get("id"),h,i,j].join("-"));var m=c.data("includenavigation"),n=c.data("mini");return e.getCalendarMonthData(h,i,j,k,m,n).then(function(a){return b.render(c.attr("data-template"),a)}).then(function(a,c){return b.replaceNode(l,a,c)}).then(function(){a("body").trigger(f.viewUpdated)}).always(function(){return M.util.js_complete([c.get("id"),h,i,j].join("-")),s(c)}).fail(d.exception)},m=function(b,c,d,e,g,h){return l(b,d,e,g,h).then(function(){return c.length&&"#"!==c&&window.history.pushState({},"",c),arguments}).then(function(){return a("body").trigger(f.monthChanged,[d,e,g,h]),arguments})},n=function(a,b,c){var d=a.find(g.wrapper).data("year"),e=a.find(g.wrapper).data("month");return"undefined"==typeof b&&(b=a.find(g.wrapper).data("courseid")),"undefined"==typeof c&&(c=a.find(g.wrapper).data("categoryid")),l(a,d,e,b,c)},o=function(c,h,i,j,k,l,m){r(c),m=m||c.find(g.wrapper),M.util.js_pending([c.get("id"),h,i,j,k,l].join("-"));var n=c.data("includenavigation");return e.getCalendarDayData(h,i,j,k,l,n).then(function(a){return b.render(c.attr("data-template"),a)}).then(function(a,c){return b.replaceNode(m,a,c)}).then(function(){a("body").trigger(f.viewUpdated)}).always(function(){return M.util.js_complete([c.get("id"),h,i,j,k,l].join("-")),s(c)}).fail(d.exception)},p=function(a,b,c){var d=a.find(g.wrapper),e=d.data("year"),f=d.data("month"),h=d.data("day");return b||(b=a.find(g.wrapper).data("courseid")),"undefined"==typeof c&&(c=a.find(g.wrapper).data("categoryid")),o(a,e,f,h,b,c)},q=function(b,c,d,e,g,h,i){return o(b,d,e,g,h,i).then(function(){return c.length&&"#"!==c&&window.history.pushState({},"",c),arguments}).then(function(){return a("body").trigger(f.dayChanged,[d,e,g,h,i]),arguments})},r=function(a){var b=a.find(g.containers.loadingIcon);b.removeClass("hidden")},s=function(a){var b=a.find(g.containers.loadingIcon);b.addClass("hidden")},t=function(c,h,i){r(c);var j=c.find(g.wrapper);return"undefined"==typeof h&&(h=c.find(g.wrapper).data("courseid")),"undefined"==typeof i&&(i=c.find(g.wrapper).data("categoryid")),e.getCalendarUpcomingData(h,i).then(function(a){return b.render(c.attr("data-template"),a)}).then(function(a,c){return b.replaceNode(j,a,c)}).then(function(){a("body").trigger(f.viewUpdated)}).always(function(){return s(c)}).fail(d.exception)},u=function(a){switch(a){case"user":return"user";case"site":return"site";case"group":return"group";case"category":return"category";default:return"course"}},v=function(a){return"calendar_event_"+u(a)},w=function(a){var c="";e.getEventById(a).then(function(b){if(!b.event)throw new Error("Error encountered while trying to fetch calendar event with ID: "+a);var d=b.event;return c=v(d.eventtype),x(d.eventtype).then(function(a){return d.eventtype=a,d})}).then(function(a){var d={title:a.name,type:j.TYPE,body:b.render("core_calendar/event_summary_body",a),templateContext:{canedit:a.canedit,candelete:a.candelete,headerclasses:c,isactionevent:a.isactionevent,url:a.url}};return h.create(d)}).done(function(a){a.getRoot().on(i.hidden,function(){a.destroy()}),a.show()}).fail(d.exception)},x=function(a){var b="type"+u(a);return c.get_string(b,"core_calendar").then(function(a){return a})};return{init:function(a){k(a)},reloadCurrentMonth:n,changeMonth:m,refreshMonthContent:l,reloadCurrentDay:p,changeDay:q,refreshDayContent:o,reloadCurrentUpcoming:t}});
|
||||
define(["jquery","core/templates","core/str","core/notification","core_calendar/repository","core_calendar/events","core_calendar/selectors","core/modal_factory","core/modal_events","core_calendar/summary_modal"],function(a,b,c,d,e,f,g,h,i,j){var k=function(b){b=a(b),b.on("click",g.links.eventLink,function(b){var c,d=a(b.target),e=null;c=d.is(g.actions.viewEvent)?d:d.closest(g.actions.viewEvent),e=c.length?c.data("eventId"):d.find(g.actions.viewEvent).data("eventId"),e&&(b.preventDefault(),b.stopPropagation(),v(e))}),b.on("click",g.links.navLink,function(c){var d=b.find(g.wrapper),e=d.data("view"),f=d.data("courseid"),h=d.data("categoryid"),i=a(c.currentTarget);"month"===e?(m(b,i.attr("href"),i.data("year"),i.data("month"),f,h),c.preventDefault()):"day"===e&&(q(b,i.attr("href"),i.data("year"),i.data("month"),i.data("day"),f,h),c.preventDefault())})},l=function(c,h,i,j,k,l){r(c),l=l||c.find(g.wrapper),M.util.js_pending([c.get("id"),h,i,j].join("-"));var m=c.data("includenavigation"),n=c.data("mini");return e.getCalendarMonthData(h,i,j,k,m,n).then(function(a){return b.render(c.attr("data-template"),a)}).then(function(a,c){return b.replaceNode(l,a,c)}).then(function(){a("body").trigger(f.viewUpdated)}).always(function(){return M.util.js_complete([c.get("id"),h,i,j].join("-")),s(c)}).fail(d.exception)},m=function(b,c,d,e,g,h){return l(b,d,e,g,h).then(function(){return c.length&&"#"!==c&&window.history.pushState({},"",c),arguments}).then(function(){return a("body").trigger(f.monthChanged,[d,e,g,h]),arguments})},n=function(a,b,c){var d=a.find(g.wrapper).data("year"),e=a.find(g.wrapper).data("month");return"undefined"==typeof b&&(b=a.find(g.wrapper).data("courseid")),"undefined"==typeof c&&(c=a.find(g.wrapper).data("categoryid")),l(a,d,e,b,c)},o=function(c,h,i,j,k,l,m){r(c),m=m||c.find(g.wrapper),M.util.js_pending([c.get("id"),h,i,j,k,l].join("-"));var n=c.data("includenavigation");return e.getCalendarDayData(h,i,j,k,l,n).then(function(a){return b.render(c.attr("data-template"),a)}).then(function(a,c){return b.replaceNode(m,a,c)}).then(function(){a("body").trigger(f.viewUpdated)}).always(function(){return M.util.js_complete([c.get("id"),h,i,j,k,l].join("-")),s(c)}).fail(d.exception)},p=function(a,b,c){var d=a.find(g.wrapper),e=d.data("year"),f=d.data("month"),h=d.data("day");return b||(b=a.find(g.wrapper).data("courseid")),"undefined"==typeof c&&(c=a.find(g.wrapper).data("categoryid")),o(a,e,f,h,b,c)},q=function(b,c,d,e,g,h,i){return o(b,d,e,g,h,i).then(function(){return c.length&&"#"!==c&&window.history.pushState({},"",c),arguments}).then(function(){return a("body").trigger(f.dayChanged,[d,e,g,h,i]),arguments})},r=function(a){var b=a.find(g.containers.loadingIcon);b.removeClass("hidden")},s=function(a){var b=a.find(g.containers.loadingIcon);b.addClass("hidden")},t=function(c,h,i){r(c);var j=c.find(g.wrapper);return"undefined"==typeof h&&(h=c.find(g.wrapper).data("courseid")),"undefined"==typeof i&&(i=c.find(g.wrapper).data("categoryid")),e.getCalendarUpcomingData(h,i).then(function(a){return b.render(c.attr("data-template"),a)}).then(function(a,c){return b.replaceNode(j,a,c)}).then(function(){a("body").trigger(f.viewUpdated)}).always(function(){return s(c)}).fail(d.exception)},u=function(a){return"calendar_event_"+a},v=function(a){var c="";e.getEventById(a).then(function(b){if(!b.event)throw new Error("Error encountered while trying to fetch calendar event with ID: "+a);var d=b.event;return c=u(d.normalisedeventtype),d}).then(function(a){var d={title:a.name,type:j.TYPE,body:b.render("core_calendar/event_summary_body",a),templateContext:{canedit:a.canedit,candelete:a.candelete,headerclasses:c,isactionevent:a.isactionevent,url:a.url}};return h.create(d)}).done(function(a){a.getRoot().on(i.hidden,function(){a.destroy()}),a.show()}).fail(d.exception)};return{init:function(a){k(a)},reloadCurrentMonth:n,changeMonth:m,refreshMonthContent:l,reloadCurrentDay:p,changeDay:q,refreshDayContent:o,reloadCurrentUpcoming:t}});
|
||||
@@ -339,28 +339,6 @@ define([
|
||||
.fail(Notification.exception);
|
||||
};
|
||||
|
||||
/**
|
||||
* Convert the given event type into one of either user, site,
|
||||
* group, category, or course.
|
||||
*
|
||||
* @param {String} eventType The calendar event type
|
||||
* @return {String}
|
||||
*/
|
||||
var normaliseEventType = function(eventType) {
|
||||
switch (eventType) {
|
||||
case 'user':
|
||||
return 'user';
|
||||
case 'site':
|
||||
return 'site';
|
||||
case 'group':
|
||||
return 'group';
|
||||
case 'category':
|
||||
return 'category';
|
||||
default:
|
||||
return 'course';
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Get the CSS class to apply for the given event type.
|
||||
*
|
||||
@@ -368,7 +346,7 @@ define([
|
||||
* @return {String}
|
||||
*/
|
||||
var getEventTypeClassFromType = function(eventType) {
|
||||
return 'calendar_event_' + normaliseEventType(eventType);
|
||||
return 'calendar_event_' + eventType;
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -385,12 +363,9 @@ define([
|
||||
throw new Error('Error encountered while trying to fetch calendar event with ID: ' + eventId);
|
||||
}
|
||||
var eventData = getEventResponse.event;
|
||||
typeClass = getEventTypeClassFromType(eventData.eventtype);
|
||||
typeClass = getEventTypeClassFromType(eventData.normalisedeventtype);
|
||||
|
||||
return getEventType(eventData.eventtype).then(function(eventType) {
|
||||
eventData.eventtype = eventType;
|
||||
return eventData;
|
||||
});
|
||||
return eventData;
|
||||
}).then(function(eventData) {
|
||||
// Build the modal parameters from the event data.
|
||||
var modalParams = {
|
||||
@@ -422,19 +397,6 @@ define([
|
||||
}).fail(Notification.exception);
|
||||
};
|
||||
|
||||
/**
|
||||
* Get the event type lang string.
|
||||
*
|
||||
* @param {String} eventType The event type.
|
||||
* @return {promise} The lang string promise.
|
||||
*/
|
||||
var getEventType = function(eventType) {
|
||||
var lang = 'type' + normaliseEventType(eventType);
|
||||
return Str.get_string(lang, 'core_calendar').then(function(langStr) {
|
||||
return langStr;
|
||||
});
|
||||
};
|
||||
|
||||
return {
|
||||
init: function(root) {
|
||||
registerEventListeners(root);
|
||||
|
||||
@@ -52,9 +52,6 @@ class calendar_event_exporter extends event_exporter_base {
|
||||
'type' => PARAM_BOOL,
|
||||
'default' => false,
|
||||
];
|
||||
$values['calendareventtype'] = [
|
||||
'type' => PARAM_TEXT,
|
||||
];
|
||||
$values['popupname'] = [
|
||||
'type' => PARAM_RAW,
|
||||
];
|
||||
@@ -172,8 +169,6 @@ class calendar_event_exporter extends event_exporter_base {
|
||||
$values['popupname'] = get_string('eventnameandcourse', 'calendar', $eventnameparams);
|
||||
}
|
||||
|
||||
$values['calendareventtype'] = $this->get_calendar_event_type();
|
||||
|
||||
if ($event->get_course_module()) {
|
||||
$values = array_merge($values, $this->get_module_timestamp_limits($event));
|
||||
} else if ($hascourse && $course->id != SITEID && empty($event->get_group())) {
|
||||
|
||||
@@ -55,7 +55,6 @@ class event_exporter extends event_exporter_base {
|
||||
'type' => event_action_exporter::read_properties_definition(),
|
||||
'optional' => true,
|
||||
];
|
||||
$values['calendareventtype'] = ['type' => PARAM_TEXT];
|
||||
return $values;
|
||||
}
|
||||
|
||||
@@ -73,7 +72,6 @@ class event_exporter extends event_exporter_base {
|
||||
|
||||
$event = $this->event;
|
||||
$context = $this->related['context'];
|
||||
$values['calendareventtype'] = $event->get_type();
|
||||
if ($moduleproxy = $event->get_course_module()) {
|
||||
$modulename = $moduleproxy->get('modname');
|
||||
$moduleid = $moduleproxy->get('id');
|
||||
@@ -83,8 +81,6 @@ class event_exporter extends event_exporter_base {
|
||||
$params = array('update' => $moduleid, 'return' => true, 'sesskey' => sesskey());
|
||||
$editurl = new \moodle_url('/course/mod.php', $params);
|
||||
$values['editurl'] = $editurl->out(false);
|
||||
// Activity events are normalised to "look" like course events.
|
||||
$values['calendareventtype'] = 'course';
|
||||
} else if ($event->get_type() == 'category') {
|
||||
$url = $event->get_category()->get_proxied_instance()->get_view_link();
|
||||
} else if ($event->get_type() == 'course') {
|
||||
|
||||
@@ -236,6 +236,12 @@ class event_exporter_base extends exporter {
|
||||
'default' => null,
|
||||
'null' => NULL_ALLOWED
|
||||
],
|
||||
'normalisedeventtype' => [
|
||||
'type' => PARAM_TEXT
|
||||
],
|
||||
'normalisedeventtypetext' => [
|
||||
'type' => PARAM_TEXT
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
@@ -254,11 +260,14 @@ class event_exporter_base extends exporter {
|
||||
$values['isactionevent'] = false;
|
||||
$values['iscourseevent'] = false;
|
||||
$values['iscategoryevent'] = false;
|
||||
$values['normalisedeventtype'] = $event->get_type();
|
||||
if ($moduleproxy = $event->get_course_module()) {
|
||||
// We need a separate property to flag if an event is action event.
|
||||
// That's required because canedit return true but action action events cannot be edited on the calendar UI.
|
||||
// But they are considered editable because you can drag and drop the event on the month view.
|
||||
$values['isactionevent'] = true;
|
||||
// Activity events are normalised to "look" like course events.
|
||||
$values['normalisedeventtype'] = 'course';
|
||||
} else if ($event->get_type() == 'course') {
|
||||
$values['iscourseevent'] = true;
|
||||
} else if ($event->get_type() == 'category') {
|
||||
@@ -266,6 +275,7 @@ class event_exporter_base extends exporter {
|
||||
}
|
||||
$timesort = $event->get_times()->get_sort_time()->getTimestamp();
|
||||
$iconexporter = new event_icon_exporter($event, ['context' => $context]);
|
||||
$values['normalisedeventtypetext'] = get_string('type' . $values['normalisedeventtype'], 'calendar');
|
||||
|
||||
$values['icon'] = $iconexporter->export($output);
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
}}
|
||||
{{!
|
||||
@template calendar/calendar_day
|
||||
@template core_calendar/calendar_day
|
||||
|
||||
Calendar day view.
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
}}
|
||||
{{!
|
||||
@template calendar/day_detailed
|
||||
@template core_calendar/day_detailed
|
||||
|
||||
Calendar day view.
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@
|
||||
Example context (json):
|
||||
{
|
||||
"formattedtime": "Wednesday, 17 April, 9:27 AM",
|
||||
"calendareventtype": "Group",
|
||||
"normalisedeventtype": "Group",
|
||||
"description": "An random event description",
|
||||
"location": "Moodle HQ",
|
||||
"isactionevent": "true",
|
||||
@@ -61,7 +61,7 @@
|
||||
</div>
|
||||
<div class="row mt-1">
|
||||
<div class="col-xs-1">{{#pix}} i/calendar, core, {{#str}} eventtype, core_calendar {{/str}} {{/pix}}</div>
|
||||
<div class="col-xs-11">{{calendareventtype}}</div>
|
||||
<div class="col-xs-11">{{normalisedeventtypetext}}</div>
|
||||
</div>
|
||||
{{#description}}
|
||||
<div class="row mt-1">
|
||||
|
||||
@@ -31,7 +31,7 @@
|
||||
{
|
||||
"id": 1,
|
||||
"name": "Sample event name",
|
||||
"calendareventtype": "course",
|
||||
"normalisedeventtype": "course",
|
||||
"course": {
|
||||
"id": 1
|
||||
},
|
||||
@@ -52,12 +52,12 @@
|
||||
}} data-course-id="{{course.id}}"{{!
|
||||
}} data-event-id="{{id}}"{{!
|
||||
}} class="event m-t-1"{{!
|
||||
}} data-eventtype-{{calendareventtype}}="1"{{!
|
||||
}} data-eventtype-{{normalisedeventtype}}="1"{{!
|
||||
}} data-event-title="{{name}}"{{!
|
||||
}} data-event-count="{{eventcount}}"{{!
|
||||
}}>
|
||||
<div class="card rounded">
|
||||
<div class="box card-header clearfix calendar_event_{{calendareventtype}}">
|
||||
<div class="box card-header clearfix calendar_event_{{normalisedeventtype}}">
|
||||
<div class="commands float-sm-right">
|
||||
{{#canedit}}
|
||||
{{#candelete}}
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
}}
|
||||
{{!
|
||||
@template calendar/event_list
|
||||
@template core_calendar/event_list
|
||||
|
||||
Calendar event list.
|
||||
|
||||
|
||||
@@ -87,7 +87,7 @@
|
||||
{{/underway}}
|
||||
{{^underway}}
|
||||
<li data-region="event-item"
|
||||
data-eventtype-{{calendareventtype}}="1"
|
||||
data-eventtype-{{normalisedeventtype}}="1"
|
||||
{{#draggable}}
|
||||
draggable="true"
|
||||
data-drag-type="move"
|
||||
@@ -106,7 +106,7 @@
|
||||
{{/draggable}}>
|
||||
|
||||
<a data-action="view-event" data-event-id="{{id}}" href="{{url}}" title="{{name}}">
|
||||
<span class="badge badge-circle calendar_event_{{calendareventtype}}">
|
||||
<span class="badge badge-circle calendar_event_{{normalisedeventtype}}">
|
||||
|
||||
</span>
|
||||
{{> core_calendar/event_icon}}
|
||||
|
||||
@@ -135,7 +135,7 @@
|
||||
{{$nocontent}}{{#str}}eventnone, calendar{{/str}}{{/nocontent}}
|
||||
{{$content}}
|
||||
{{#events}}
|
||||
<div data-popover-eventtype-{{calendareventtype}}="1">
|
||||
<div data-popover-eventtype-{{normalisedeventtype}}="1">
|
||||
{{#modulename}}
|
||||
{{#pix}} icon, {{modulename}} {{/pix}}
|
||||
{{/modulename}}
|
||||
|
||||
@@ -41,7 +41,7 @@
|
||||
{{#events}}
|
||||
<div{{!
|
||||
}} class="event"{{!
|
||||
}} data-eventtype-{{calendareventtype}}="1"{{!
|
||||
}} data-eventtype-{{normalisedeventtype}}="1"{{!
|
||||
}} data-region="event-item"{{!
|
||||
}}>
|
||||
<span>{{#icon}}{{#pix}} {{key}}, {{component}}, {{alttext}} {{/pix}}{{/icon}}</span>
|
||||
|
||||
Reference in New Issue
Block a user