';
- if (($placement !== false) && ($courseid !== false)) {
- $content .= ''. calendar_top_controls($placement, array('id' => $courseid, 'time' => $time)) .'';
+ if (empty($data->context)) {
+ $this->properties->context = $this->calculate_context();
+ }
}
- $content .= ''; // Header row: day names
- // Print out the names of the weekdays.
- for ($i = $display->minwday; $i <= $display->maxwday; ++$i) {
- $pos = $i % $numberofdaysinweek;
- $content .= '| '.
- $daynames[$pos]['shortname'] ." | \n";
+ /**
+ * Magic set method.
+ *
+ * Attempts to call a set_$key method if one exists otherwise falls back
+ * to simply set the property.
+ *
+ * @param string $key property name
+ * @param mixed $value value of the property
+ */
+ public function __set($key, $value) {
+ if (method_exists($this, 'set_'.$key)) {
+ $this->{'set_'.$key}($value);
+ }
+ $this->properties->{$key} = $value;
}
- $content .= '
'; // End of day names; prepare for day numbers
-
- // For the table display. $week is the row; $dayweek is the column.
- $dayweek = $startwday;
-
- // Paddding (the first week may have blank days in the beginning)
- for($i = $display->minwday; $i < $startwday; ++$i) {
- $content .= '| | '."\n";
+ /**
+ * Magic get method.
+ *
+ * Attempts to call a get_$key method to return the property and ralls over
+ * to return the raw property.
+ *
+ * @param string $key property name
+ * @return mixed property value
+ * @throws \coding_exception
+ */
+ public function __get($key) {
+ if (method_exists($this, 'get_'.$key)) {
+ return $this->{'get_'.$key}();
+ }
+ if (!property_exists($this->properties, $key)) {
+ throw new \coding_exception('Undefined property requested');
+ }
+ return $this->properties->{$key};
}
- $weekend = CALENDAR_DEFAULT_WEEKEND;
- if (isset($CFG->calendar_weekend)) {
- $weekend = intval($CFG->calendar_weekend);
+ /**
+ * Magic isset method.
+ *
+ * PHP needs an isset magic method if you use the get magic method and
+ * still want empty calls to work.
+ *
+ * @param string $key $key property name
+ * @return bool|mixed property value, false if property is not exist
+ */
+ public function __isset($key) {
+ return !empty($this->properties->{$key});
}
- // Now display all the calendar
- $daytime = strtotime('-1 day', $display->tstart);
- for($day = 1; $day <= $display->maxdays; ++$day, ++$dayweek) {
- $cellattributes = array();
- $daytime = strtotime('+1 day', $daytime);
- if($dayweek > $display->maxwday) {
- // We need to change week (table row)
- $content .= '
';
- $dayweek = $display->minwday;
- }
+ /**
+ * Calculate the context value needed for an event.
+ *
+ * Event's type can be determine by the available value store in $data
+ * It is important to check for the existence of course/courseid to determine
+ * the course event.
+ * Default value is set to CONTEXT_USER
+ *
+ * @return \stdClass The context object.
+ */
+ protected function calculate_context() {
+ global $USER, $DB;
- // Reset vars.
- if ($weekend & (1 << ($dayweek % $numberofdaysinweek))) {
- // Weekend. This is true no matter what the exact range is.
- $class = 'weekend day';
+ $context = null;
+ if (isset($this->properties->courseid) && $this->properties->courseid > 0) {
+ $context = \context_course::instance($this->properties->courseid);
+ } else if (isset($this->properties->course) && $this->properties->course > 0) {
+ $context = \context_course::instance($this->properties->course);
+ } else if (isset($this->properties->groupid) && $this->properties->groupid > 0) {
+ $group = $DB->get_record('groups', array('id' => $this->properties->groupid));
+ $context = \context_course::instance($group->courseid);
+ } else if (isset($this->properties->userid) && $this->properties->userid > 0
+ && $this->properties->userid == $USER->id) {
+ $context = \context_user::instance($this->properties->userid);
+ } else if (isset($this->properties->userid) && $this->properties->userid > 0
+ && $this->properties->userid != $USER->id &&
+ isset($this->properties->instance) && $this->properties->instance > 0) {
+ $cm = get_coursemodule_from_instance($this->properties->modulename, $this->properties->instance, 0,
+ false, MUST_EXIST);
+ $context = \context_course::instance($cm->course);
} else {
- // Normal working day.
- $class = 'day';
+ $context = \context_user::instance($this->properties->userid);
}
- $eventids = array();
- if (!empty($eventsbyday[$day])) {
- $eventids = $eventsbyday[$day];
- }
-
- if (!empty($durationbyday[$day])) {
- $eventids = array_unique(array_merge($eventids, $durationbyday[$day]));
- }
-
- $finishclass = false;
-
- if (!empty($eventids)) {
- // There is at least one event on this day.
-
- $class .= ' hasevent';
- $hrefparams['view'] = 'day';
- $dayhref = calendar_get_link_href(new moodle_url(CALENDAR_URL . 'view.php', $hrefparams), 0, 0, 0, $daytime);
-
- $popupcontent = '';
- foreach ($eventids as $eventid) {
- if (!isset($events[$eventid])) {
- continue;
- }
- $event = new calendar_event($events[$eventid]);
- $popupalt = '';
- $component = 'moodle';
- if (!empty($event->modulename)) {
- $popupicon = 'icon';
- $popupalt = $event->modulename;
- $component = $event->modulename;
- } else if ($event->courseid == SITEID) { // Site event.
- $popupicon = 'i/siteevent';
- } else if ($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) { // Course event.
- $popupicon = 'i/courseevent';
- } else if ($event->groupid) { // Group event.
- $popupicon = 'i/groupevent';
- } else { // Must be a user event.
- $popupicon = 'i/userevent';
- }
+ return $context;
+ }
- if ($event->timeduration) {
- $startdate = $calendartype->timestamp_to_date_array($event->timestart);
- $enddate = $calendartype->timestamp_to_date_array($event->timestart + $event->timeduration - 1);
- if ($enddate['mon'] == $m && $enddate['year'] == $y && $enddate['mday'] == $day) {
- $finishclass = true;
- }
- }
+ /**
+ * Returns an array of editoroptions for this event.
+ *
+ * @return array event editor options
+ */
+ protected function get_editoroptions() {
+ return $this->editoroptions;
+ }
- $dayhref->set_anchor('event_'.$event->id);
+ /**
+ * Returns an event description: Called by __get
+ * Please use $blah = $event->description;
+ *
+ * @return string event description
+ */
+ protected function get_description() {
+ global $CFG;
- $popupcontent .= html_writer::start_tag('div');
- if ($component == 'moodle') {
- $popupcontent .= $OUTPUT->pix_icon($popupicon, $popupalt, $component);
- } else {
- $popupcontent .= $OUTPUT->image_icon($popupicon, $popupalt, $component);
- }
- // Show ical source if needed.
- if (!empty($event->subscription) && $CFG->calendar_showicalsource) {
- $a = new stdClass();
- $a->name = format_string($event->name, true);
- $a->source = $event->subscription->name;
- $name = get_string('namewithsource', 'calendar', $a);
- } else {
- if ($finishclass) {
- $samedate = $startdate['mon'] == $enddate['mon'] &&
- $startdate['year'] == $enddate['year'] &&
- $startdate['mday'] == $enddate['mday'];
+ require_once($CFG->libdir . '/filelib.php');
- if ($samedate) {
- $name = format_string($event->name, true);
- } else {
- $name = format_string($event->name, true) . ' (' . get_string('eventendtime', 'calendar') . ')';
- }
- } else {
- $name = format_string($event->name, true);
- }
+ if ($this->_description === null) {
+ // Check if we have already resolved the context for this event.
+ if ($this->editorcontext === null) {
+ // Switch on the event type to decide upon the appropriate context to use for this event.
+ $this->editorcontext = $this->properties->context;
+ if ($this->properties->eventtype != 'user' && $this->properties->eventtype != 'course'
+ && $this->properties->eventtype != 'site' && $this->properties->eventtype != 'group') {
+ return clean_text($this->properties->description, $this->properties->format);
}
- $popupcontent .= html_writer::link($dayhref, $name);
- $popupcontent .= html_writer::end_tag('div');
}
- if ($display->thismonth && $day == $d) {
- $popupdata = calendar_get_popup(true, $daytime, $popupcontent);
+ // Work out the item id for the editor, if this is a repeated event
+ // then the files will be associated with the original.
+ if (!empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
+ $itemid = $this->properties->repeatid;
} else {
- $popupdata = calendar_get_popup(false, $daytime, $popupcontent);
- }
-
- // Class and cell content
- if(isset($typesbyday[$day]['startglobal'])) {
- $class .= ' calendar_event_global';
- } else if(isset($typesbyday[$day]['startcourse'])) {
- $class .= ' calendar_event_course';
- } else if(isset($typesbyday[$day]['startgroup'])) {
- $class .= ' calendar_event_group';
- } else if(isset($typesbyday[$day]['startuser'])) {
- $class .= ' calendar_event_user';
- }
- if ($finishclass) {
- $class .= ' duration_finish';
+ $itemid = $this->properties->id;
}
- $data = array(
- 'url' => $dayhref,
- 'day' => $day,
- 'content' => $popupdata['data-core_calendar-popupcontent'],
- 'title' => $popupdata['data-core_calendar-title']
- );
- $cell = $OUTPUT->render_from_template('core_calendar/minicalendar_day_link', $data);
- } else {
- $cell = $day;
+ // Convert file paths in the description so that things display correctly.
+ $this->_description = file_rewrite_pluginfile_urls($this->properties->description, 'pluginfile.php',
+ $this->editorcontext->id, 'calendar', 'event_description', $itemid);
+ // Clean the text so no nasties get through.
+ $this->_description = clean_text($this->_description, $this->properties->format);
}
- $durationclass = false;
- if (isset($typesbyday[$day]['durationglobal'])) {
- $durationclass = ' duration_global';
- } else if(isset($typesbyday[$day]['durationcourse'])) {
- $durationclass = ' duration_course';
- } else if(isset($typesbyday[$day]['durationgroup'])) {
- $durationclass = ' duration_group';
- } else if(isset($typesbyday[$day]['durationuser'])) {
- $durationclass = ' duration_user';
+ // Finally return the description.
+ return $this->_description;
+ }
+
+ /**
+ * Return the number of repeat events there are in this events series.
+ *
+ * @return int number of event repeated
+ */
+ public function count_repeats() {
+ global $DB;
+ if (!empty($this->properties->repeatid)) {
+ $this->properties->eventrepeats = $DB->count_records('event',
+ array('repeatid' => $this->properties->repeatid));
+ // We don't want to count ourselves.
+ $this->properties->eventrepeats--;
}
- if ($durationclass) {
- $class .= ' duration '.$durationclass;
+ return $this->properties->eventrepeats;
+ }
+
+ /**
+ * Update or create an event within the database
+ *
+ * Pass in a object containing the event properties and this function will
+ * insert it into the database and deal with any associated files
+ *
+ * @see self::create()
+ * @see self::update()
+ *
+ * @param \stdClass $data object of event
+ * @param bool $checkcapability if moodle should check calendar managing capability or not
+ * @return bool event updated
+ */
+ public function update($data, $checkcapability=true) {
+ global $DB, $USER;
+
+ foreach ($data as $key => $value) {
+ $this->properties->$key = $value;
}
- // If event has a class set then add it to the table day | tag
- // Note: only one colour for minicalendar
- if(isset($eventsbyday[$day])) {
- foreach($eventsbyday[$day] as $eventid) {
- if (!isset($events[$eventid])) {
- continue;
+ $this->properties->timemodified = time();
+ $usingeditor = (!empty($this->properties->description) && is_array($this->properties->description));
+
+ // Prepare event data.
+ $eventargs = array(
+ 'context' => $this->properties->context,
+ 'objectid' => $this->properties->id,
+ 'other' => array(
+ 'repeatid' => empty($this->properties->repeatid) ? 0 : $this->properties->repeatid,
+ 'timestart' => $this->properties->timestart,
+ 'name' => $this->properties->name
+ )
+ );
+
+ if (empty($this->properties->id) || $this->properties->id < 1) {
+
+ if ($checkcapability) {
+ if (!calendar_add_event_allowed($this->properties)) {
+ print_error('nopermissiontoupdatecalendar');
}
- $event = $events[$eventid];
- if (!empty($event->class)) {
- $class .= ' '.$event->class;
+ }
+
+ if ($usingeditor) {
+ switch ($this->properties->eventtype) {
+ case 'user':
+ $this->properties->courseid = 0;
+ $this->properties->course = 0;
+ $this->properties->groupid = 0;
+ $this->properties->userid = $USER->id;
+ break;
+ case 'site':
+ $this->properties->courseid = SITEID;
+ $this->properties->course = SITEID;
+ $this->properties->groupid = 0;
+ $this->properties->userid = $USER->id;
+ break;
+ case 'course':
+ $this->properties->groupid = 0;
+ $this->properties->userid = $USER->id;
+ break;
+ case 'group':
+ $this->properties->userid = $USER->id;
+ break;
+ default:
+ // We should NEVER get here, but just incase we do lets fail gracefully.
+ $usingeditor = false;
+ break;
}
- break;
+
+ // If we are actually using the editor, we recalculate the context because some default values
+ // were set when calculate_context() was called from the constructor.
+ if ($usingeditor) {
+ $this->properties->context = $this->calculate_context();
+ $this->editorcontext = $this->properties->context;
+ }
+
+ $editor = $this->properties->description;
+ $this->properties->format = $this->properties->description['format'];
+ $this->properties->description = $this->properties->description['text'];
}
- }
- if ($display->thismonth && $day == $d) {
- // The current cell is for today - add appropriate classes and additional information for styling.
- $class .= ' today';
- $today = get_string('today', 'calendar').' '.userdate(time(), get_string('strftimedayshort'));
+ // Insert the event into the database.
+ $this->properties->id = $DB->insert_record('event', $this->properties);
- if (!isset($eventsbyday[$day]) && !isset($durationbyday[$day])) {
- $class .= ' eventnone';
- $popupdata = calendar_get_popup(true, false);
- $data = array(
- 'url' => '#',
- 'day' => $day,
- 'content' => $popupdata['data-core_calendar-popupcontent'],
- 'title' => $popupdata['data-core_calendar-title']
- );
- $cell = $OUTPUT->render_from_template('core_calendar/minicalendar_day_link', $data);
+ if ($usingeditor) {
+ $this->properties->description = file_save_draft_area_files(
+ $editor['itemid'],
+ $this->editorcontext->id,
+ 'calendar',
+ 'event_description',
+ $this->properties->id,
+ $this->editoroptions,
+ $editor['text'],
+ $this->editoroptions['forcehttps']);
+ $DB->set_field('event', 'description', $this->properties->description,
+ array('id' => $this->properties->id));
}
- $cell = get_accesshide($today . ' ') . $cell;
- }
- // Just display it
- $cellattributes['class'] = $class;
- $content .= html_writer::tag('td', $cell, $cellattributes);
- }
+ // Log the event entry.
+ $eventargs['objectid'] = $this->properties->id;
+ $eventargs['context'] = $this->properties->context;
+ $event = \core\event\calendar_event_created::create($eventargs);
+ $event->trigger();
- // Paddding (the last week may have blank days at the end)
- for($i = $dayweek; $i <= $display->maxwday; ++$i) {
- $content .= ' | | ';
- }
- $content .= '
'; // Last row ends
+ $repeatedids = array();
- $content .= '
'; // Tabular display of days ends
- return $content;
-}
+ if (!empty($this->properties->repeat)) {
+ $this->properties->repeatid = $this->properties->id;
+ $DB->set_field('event', 'repeatid', $this->properties->repeatid, array('id' => $this->properties->id));
-/**
- * Gets the calendar popup
- *
- * It called at multiple points in from calendar_get_mini.
- * Copied and modified from calendar_get_mini.
- *
- * @param bool $is_today false except when called on the current day.
- * @param mixed $event_timestart $events[$eventid]->timestart, OR false if there are no events.
- * @param string $popupcontent content for the popup window/layout.
- * @return string eventid for the calendar_tooltip popup window/layout.
- */
-function calendar_get_popup($today = false, $timestart, $popupcontent = '') {
- global $PAGE;
+ $eventcopy = clone($this->properties);
+ unset($eventcopy->id);
- $popupcaption = '';
- if ($today) {
- $popupcaption = get_string('today', 'calendar') . ' ';
- }
+ $timestart = new \DateTime('@' . $eventcopy->timestart);
+ $timestart->setTimezone(\core_date::get_user_timezone_object());
- if (false === $timestart) {
- $popupcaption .= userdate(time(), get_string('strftimedayshort'));
- $popupcontent = get_string('eventnone', 'calendar');
+ for ($i = 1; $i < $eventcopy->repeats; $i++) {
- } else {
- $popupcaption .= get_string('eventsfor', 'calendar', userdate($timestart, get_string('strftimedayshort')));
- }
+ $timestart->add(new \DateInterval('P7D'));
+ $eventcopy->timestart = $timestart->getTimestamp();
- return array(
- 'data-core_calendar-title' => $popupcaption,
- 'data-core_calendar-popupcontent' => $popupcontent,
- );
-}
+ // Get the event id for the log record.
+ $eventcopyid = $DB->insert_record('event', $eventcopy);
-/**
- * Gets the calendar upcoming event
- *
- * @param array $courses array of courses
- * @param array|int|bool $groups array of groups, group id or boolean for all/no group events
- * @param array|int|bool $users array of users, user id or boolean for all/no user events
- * @param int $daysinfuture number of days in the future we 'll look
- * @param int $maxevents maximum number of events
- * @param int $fromtime start time
- * @return array $output array of upcoming events
- */
-function calendar_get_upcoming($courses, $groups, $users, $daysinfuture, $maxevents, $fromtime=0) {
- global $CFG, $COURSE, $DB;
+ // If the context has been set delete all associated files.
+ if ($usingeditor) {
+ $fs = get_file_storage();
+ $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description',
+ $this->properties->id);
+ foreach ($files as $file) {
+ $fs->create_file_from_storedfile(array('itemid' => $eventcopyid), $file);
+ }
+ }
- $display = new stdClass;
- $display->range = $daysinfuture; // How many days in the future we 'll look
- $display->maxevents = $maxevents;
+ $repeatedids[] = $eventcopyid;
- $output = array();
+ // Trigger an event.
+ $eventargs['objectid'] = $eventcopyid;
+ $eventargs['other']['timestart'] = $eventcopy->timestart;
+ $event = \core\event\calendar_event_created::create($eventargs);
+ $event->trigger();
+ }
+ }
- // Prepare "course caching", since it may save us a lot of queries
- $coursecache = array();
+ return true;
+ } else {
- $processed = 0;
- $now = time(); // We 'll need this later
- $usermidnighttoday = usergetmidnight($now);
+ if ($checkcapability) {
+ if (!calendar_edit_event_allowed($this->properties)) {
+ print_error('nopermissiontoupdatecalendar');
+ }
+ }
- if ($fromtime) {
- $display->tstart = $fromtime;
- } else {
- $display->tstart = $usermidnighttoday;
- }
+ if ($usingeditor) {
+ if ($this->editorcontext !== null) {
+ $this->properties->description = file_save_draft_area_files(
+ $this->properties->description['itemid'],
+ $this->editorcontext->id,
+ 'calendar',
+ 'event_description',
+ $this->properties->id,
+ $this->editoroptions,
+ $this->properties->description['text'],
+ $this->editoroptions['forcehttps']);
+ } else {
+ $this->properties->format = $this->properties->description['format'];
+ $this->properties->description = $this->properties->description['text'];
+ }
+ }
- // This works correctly with respect to the user's DST, but it is accurate
- // only because $fromtime is always the exact midnight of some day!
- $display->tend = usergetmidnight($display->tstart + DAYSECS * $display->range + 3 * HOURSECS) - 1;
+ $event = $DB->get_record('event', array('id' => $this->properties->id));
- // Get the events matching our criteria
- $events = calendar_get_events($display->tstart, $display->tend, $users, $groups, $courses);
+ $updaterepeated = (!empty($this->properties->repeatid) && !empty($this->properties->repeateditall));
- // This is either a genius idea or an idiot idea: in order to not complicate things, we use this rule: if, after
- // possibly removing SITEID from $courses, there is only one course left, then clicking on a day in the month
- // will also set the $SESSION->cal_courses_shown variable to that one course. Otherwise, we 'd need to add extra
- // arguments to this function.
+ if ($updaterepeated) {
+ // Update all.
+ if ($this->properties->timestart != $event->timestart) {
+ $timestartoffset = $this->properties->timestart - $event->timestart;
+ $sql = "UPDATE {event}
+ SET name = ?,
+ description = ?,
+ timestart = timestart + ?,
+ timeduration = ?,
+ timemodified = ?
+ WHERE repeatid = ?";
+ $params = array($this->properties->name, $this->properties->description, $timestartoffset,
+ $this->properties->timeduration, time(), $event->repeatid);
+ } else {
+ $sql = "UPDATE {event} SET name = ?, description = ?, timeduration = ?, timemodified = ? WHERE repeatid = ?";
+ $params = array($this->properties->name, $this->properties->description,
+ $this->properties->timeduration, time(), $event->repeatid);
+ }
+ $DB->execute($sql, $params);
- $hrefparams = array();
- if(!empty($courses)) {
- $courses = array_diff($courses, array(SITEID));
- if(count($courses) == 1) {
- $hrefparams['course'] = reset($courses);
+ // Trigger an update event for each of the calendar event.
+ $events = $DB->get_records('event', array('repeatid' => $event->repeatid), '', '*');
+ foreach ($events as $calendarevent) {
+ $eventargs['objectid'] = $calendarevent->id;
+ $eventargs['other']['timestart'] = $calendarevent->timestart;
+ $event = \core\event\calendar_event_updated::create($eventargs);
+ $event->add_record_snapshot('event', $calendarevent);
+ $event->trigger();
+ }
+ } else {
+ $DB->update_record('event', $this->properties);
+ $event = self::load($this->properties->id);
+ $this->properties = $event->properties();
+
+ // Trigger an update event.
+ $event = \core\event\calendar_event_updated::create($eventargs);
+ $event->add_record_snapshot('event', $this->properties);
+ $event->trigger();
+ }
+
+ return true;
}
}
- if ($events !== false) {
-
- $modinfo = get_fast_modinfo($COURSE);
+ /**
+ * Deletes an event and if selected an repeated events in the same series
+ *
+ * This function deletes an event, any associated events if $deleterepeated=true,
+ * and cleans up any files associated with the events.
+ *
+ * @see self::delete()
+ *
+ * @param bool $deleterepeated delete event repeatedly
+ * @return bool succession of deleting event
+ */
+ public function delete($deleterepeated = false) {
+ global $DB;
- foreach($events as $event) {
+ // If $this->properties->id is not set then something is wrong.
+ if (empty($this->properties->id)) {
+ debugging('Attempting to delete an event before it has been loaded', DEBUG_DEVELOPER);
+ return false;
+ }
+ $calevent = $DB->get_record('event', array('id' => $this->properties->id), '*', MUST_EXIST);
+ // Delete the event.
+ $DB->delete_records('event', array('id' => $this->properties->id));
+ // Trigger an event for the delete action.
+ $eventargs = array(
+ 'context' => $this->properties->context,
+ 'objectid' => $this->properties->id,
+ 'other' => array(
+ 'repeatid' => empty($this->properties->repeatid) ? 0 : $this->properties->repeatid,
+ 'timestart' => $this->properties->timestart,
+ 'name' => $this->properties->name
+ ));
+ $event = \core\event\calendar_event_deleted::create($eventargs);
+ $event->add_record_snapshot('event', $calevent);
+ $event->trigger();
- if (!empty($event->modulename)) {
- if ($event->courseid == $COURSE->id) {
- if (isset($modinfo->instances[$event->modulename][$event->instance])) {
- $cm = $modinfo->instances[$event->modulename][$event->instance];
- if (!$cm->uservisible) {
- continue;
- }
- }
- } else {
- if (!$cm = get_coursemodule_from_instance($event->modulename, $event->instance)) {
- continue;
- }
- if (!\core_availability\info_module::is_user_visible($cm, 0, false)) {
- continue;
- }
+ // If we are deleting parent of a repeated event series, promote the next event in the series as parent.
+ if (($this->properties->id == $this->properties->repeatid) && !$deleterepeated) {
+ $newparent = $DB->get_field_sql("SELECT id from {event} where repeatid = ? order by id ASC",
+ array($this->properties->id), IGNORE_MULTIPLE);
+ if (!empty($newparent)) {
+ $DB->execute("UPDATE {event} SET repeatid = ? WHERE repeatid = ?",
+ array($newparent, $this->properties->id));
+ // Get all records where the repeatid is the same as the event being removed.
+ $events = $DB->get_records('event', array('repeatid' => $newparent));
+ // For each of the returned events trigger an update event.
+ foreach ($events as $calendarevent) {
+ // Trigger an event for the update.
+ $eventargs['objectid'] = $calendarevent->id;
+ $eventargs['other']['timestart'] = $calendarevent->timestart;
+ $event = \core\event\calendar_event_updated::create($eventargs);
+ $event->add_record_snapshot('event', $calendarevent);
+ $event->trigger();
}
}
+ }
- if ($processed >= $display->maxevents) {
- break;
+ // If the editor context hasn't already been set then set it now.
+ if ($this->editorcontext === null) {
+ $this->editorcontext = $this->properties->context;
+ }
+
+ // If the context has been set delete all associated files.
+ if ($this->editorcontext !== null) {
+ $fs = get_file_storage();
+ $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description', $this->properties->id);
+ foreach ($files as $file) {
+ $file->delete();
}
+ }
- $event->time = calendar_format_event_time($event, $now, $hrefparams);
- $output[] = $event;
- ++$processed;
+ // If we need to delete repeated events then we will fetch them all and delete one by one.
+ if ($deleterepeated && !empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
+ // Get all records where the repeatid is the same as the event being removed.
+ $events = $DB->get_records('event', array('repeatid' => $this->properties->repeatid));
+ // For each of the returned events populate an event object and call delete.
+ // make sure the arg passed is false as we are already deleting all repeats.
+ foreach ($events as $event) {
+ $event = new calendar_event($event);
+ $event->delete(false);
+ }
}
- }
- return $output;
-}
+ return true;
+ }
-/**
- * Get a HTML link to a course.
- *
- * @param int $courseid the course id
- * @return string a link to the course (as HTML); empty if the course id is invalid
- */
-function calendar_get_courselink($courseid) {
+ /**
+ * Fetch all event properties.
+ *
+ * This function returns all of the events properties as an object and optionally
+ * can prepare an editor for the description field at the same time. This is
+ * designed to work when the properties are going to be used to set the default
+ * values of a moodle forms form.
+ *
+ * @param bool $prepareeditor If set to true a editor is prepared for use with
+ * the mforms editor element. (for description)
+ * @return \stdClass Object containing event properties
+ */
+ public function properties($prepareeditor = false) {
+ global $DB;
- if (!$courseid) {
- return '';
- }
+ // First take a copy of the properties. We don't want to actually change the
+ // properties or we'd forever be converting back and forwards between an
+ // editor formatted description and not.
+ $properties = clone($this->properties);
+ // Clean the description here.
+ $properties->description = clean_text($properties->description, $properties->format);
- calendar_get_course_cached($coursecache, $courseid);
- $context = context_course::instance($courseid);
- $fullname = format_string($coursecache[$courseid]->fullname, true, array('context' => $context));
- $url = new moodle_url('/course/view.php', array('id' => $courseid));
- $link = html_writer::link($url, $fullname);
+ // If set to true we need to prepare the properties for use with an editor
+ // and prepare the file area.
+ if ($prepareeditor) {
- return $link;
-}
+ // We may or may not have a property id. If we do then we need to work
+ // out the context so we can copy the existing files to the draft area.
+ if (!empty($properties->id)) {
+ if ($properties->eventtype === 'site') {
+ // Site context.
+ $this->editorcontext = $this->properties->context;
+ } else if ($properties->eventtype === 'user') {
+ // User context.
+ $this->editorcontext = $this->properties->context;
+ } else if ($properties->eventtype === 'group' || $properties->eventtype === 'course') {
+ // First check the course is valid.
+ $course = $DB->get_record('course', array('id' => $properties->courseid));
+ if (!$course) {
+ print_error('invalidcourse');
+ }
+ // Course context.
+ $this->editorcontext = $this->properties->context;
+ // We have a course and are within the course context so we had
+ // better use the courses max bytes value.
+ $this->editoroptions['maxbytes'] = $course->maxbytes;
+ } else {
+ // If we get here we have a custom event type as used by some
+ // modules. In this case the event will have been added by
+ // code and we won't need the editor.
+ $this->editoroptions['maxbytes'] = 0;
+ $this->editoroptions['maxfiles'] = 0;
+ }
-/**
- * Add calendar event metadata
- *
- * @param stdClass $event event info
- * @return stdClass $event metadata
- */
-function calendar_add_event_metadata($event) {
- global $CFG, $OUTPUT;
+ if (empty($this->editorcontext) || empty($this->editorcontext->id)) {
+ $contextid = false;
+ } else {
+ // Get the context id that is what we really want.
+ $contextid = $this->editorcontext->id;
+ }
+ } else {
- //Support multilang in event->name
- $event->name = format_string($event->name,true);
+ // If we get here then this is a new event in which case we don't need a
+ // context as there is no existing files to copy to the draft area.
+ $contextid = null;
+ }
- if(!empty($event->modulename)) { // Activity event
- // The module name is set. I will assume that it has to be displayed, and
- // also that it is an automatically-generated event. And of course that the
- // fields for get_coursemodule_from_instance are set correctly.
- $module = calendar_get_module_cached($coursecache, $event->modulename, $event->instance);
+ // If the contextid === false we don't support files so no preparing
+ // a draft area.
+ if ($contextid !== false) {
+ // Just encase it has already been submitted.
+ $draftiddescription = file_get_submitted_draft_itemid('description');
+ // Prepare the draft area, this copies existing files to the draft area as well.
+ $properties->description = file_prepare_draft_area($draftiddescription, $contextid, 'calendar',
+ 'event_description', $properties->id, $this->editoroptions, $properties->description);
+ } else {
+ $draftiddescription = 0;
+ }
- if ($module === false) {
- return;
+ // Structure the description field as the editor requires.
+ $properties->description = array('text' => $properties->description, 'format' => $properties->format,
+ 'itemid' => $draftiddescription);
}
- $modulename = get_string('modulename', $event->modulename);
- if (get_string_manager()->string_exists($event->eventtype, $event->modulename)) {
- // will be used as alt text if the event icon
- $eventtype = get_string($event->eventtype, $event->modulename);
- } else {
- $eventtype = '';
- }
- $event->icon = $OUTPUT->image_icon('icon', $event->modulename, $eventtype);
+ // Finally return the properties.
+ return $properties;
+ }
- $event->referer = ' elements.
+ $summary = get_string('calendarheading', 'calendar', userdate($display->tstart, get_string('strftimemonthyear')));
+ // Begin table.
+ $content .= '';
+ if (($placement !== false) && ($courseid !== false)) {
+ $content .= '' . calendar_top_controls($placement,
+ array('id' => $courseid, 'time' => $time)) . '';
+ }
+ $content .= ''; // Header row: day names.
- $prevdate = $calendartype->timestamp_to_date_array($prevtimestamp);
- $nextdate = $calendartype->timestamp_to_date_array($nexttimestamp);
+ // Print out the names of the weekdays.
+ for ($i = $display->minwday; $i <= $display->maxwday; $i++) {
+ $pos = $i % $numberofdaysinweek;
+ $content .= '| ' .
+ $daynames[$pos]['shortname'] . " | \n";
+ }
- $prevname = $days[$prevdate['wday']]['fullname'];
- $nextname = $days[$nextdate['wday']]['fullname'];
- $prevlink = calendar_get_link_previous($prevname, 'view.php?view=day'.$courseid.'&', false, false, false, false, $prevtimestamp);
- $nextlink = calendar_get_link_next($nextname, 'view.php?view=day'.$courseid.'&', false, false, false, false, $nexttimestamp);
+ $content .= '
'; // End of day names; prepare for day numbers.
- $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
- $content .= $prevlink;
- $content .= ' | '.userdate($time, get_string('strftimedaydate')).'';
- $content .= ' | '. $nextlink;
- $content .= "";
- $content .= html_writer::end_tag('div')."\n";
+ // For the table display. $week is the row; $dayweek is the column.
+ $dayweek = $startwday;
- break;
+ // Padding (the first week may have blank days in the beginning).
+ for ($i = $display->minwday; $i < $startwday; ++$i) {
+ $content .= '| | ' ."\n";
}
- return $content;
-}
-/**
- * Formats a filter control element.
- *
- * @param moodle_url $url of the filter
- * @param int $type constant defining the type filter
- * @return string html content of the element
- */
-function calendar_filter_controls_element(moodle_url $url, $type) {
- global $OUTPUT;
- switch ($type) {
- case CALENDAR_EVENT_GLOBAL:
- $typeforhumans = 'global';
- $class = 'calendar_event_global';
- break;
- case CALENDAR_EVENT_COURSE:
- $typeforhumans = 'course';
- $class = 'calendar_event_course';
- break;
- case CALENDAR_EVENT_GROUP:
- $typeforhumans = 'groups';
- $class = 'calendar_event_group';
- break;
- case CALENDAR_EVENT_USER:
- $typeforhumans = 'user';
- $class = 'calendar_event_user';
- break;
+ $weekend = CALENDAR_DEFAULT_WEEKEND;
+ if (isset($CFG->calendar_weekend)) {
+ $weekend = intval($CFG->calendar_weekend);
}
- if (calendar_show_event_type($type)) {
- $icon = $OUTPUT->pix_icon('t/hide', get_string('hide'));
- $str = get_string('hide'.$typeforhumans.'events', 'calendar');
- } else {
- $icon = $OUTPUT->pix_icon('t/show', get_string('show'));
- $str = get_string('show'.$typeforhumans.'events', 'calendar');
- }
- $content = html_writer::start_tag('li', array('class' => 'calendar_event'));
- $content .= html_writer::start_tag('a', array('href' => $url, 'rel' => 'nofollow'));
- $content .= html_writer::tag('span', $icon, array('class' => $class));
- $content .= html_writer::tag('span', $str, array('class' => 'eventname'));
- $content .= html_writer::end_tag('a');
- $content .= html_writer::end_tag('li');
- return $content;
-}
-
-/**
- * Get the controls filter for calendar.
- *
- * Filter is used to hide calendar info from the display page
- *
- * @param moodle_url $returnurl return-url for filter controls
- * @return string $content return filter controls in html
- */
-function calendar_filter_controls(moodle_url $returnurl) {
- global $CFG, $USER, $OUTPUT;
-
- $groupevents = true;
- $id = optional_param( 'id',0,PARAM_INT );
- $seturl = new moodle_url('/calendar/set.php', array('return' => base64_encode($returnurl->out_as_local_url(false)), 'sesskey'=>sesskey()));
- $content = html_writer::start_tag('ul');
-
- $seturl->param('var', 'showglobal');
- $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_GLOBAL);
- $seturl->param('var', 'showcourses');
- $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_COURSE);
+ // Now display all the calendar.
+ $daytime = strtotime('-1 day', $display->tstart);
+ for ($day = 1; $day <= $display->maxdays; ++$day, ++$dayweek) {
+ $cellattributes = array();
+ $daytime = strtotime('+1 day', $daytime);
+ if ($dayweek > $display->maxwday) {
+ // We need to change week (table row).
+ $content .= '
';
+ $dayweek = $display->minwday;
+ }
- if (isloggedin() && !isguestuser()) {
- if ($groupevents) {
- // This course MIGHT have group events defined, so show the filter
- $seturl->param('var', 'showgroups');
- $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_GROUP);
+ // Reset vars.
+ if ($weekend & (1 << ($dayweek % $numberofdaysinweek))) {
+ // Weekend. This is true no matter what the exact range is.
+ $class = 'weekend day';
} else {
- // This course CANNOT have group events, so lose the filter
+ // Normal working day.
+ $class = 'day';
}
- $seturl->param('var', 'showuser');
- $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_USER);
- }
- $content .= html_writer::end_tag('ul');
-
- return $content;
-}
-
-/**
- * Return the representation day
- *
- * @param int $tstamp Timestamp in GMT
- * @param int $now current Unix timestamp
- * @param bool $usecommonwords
- * @return string the formatted date/time
- */
-function calendar_day_representation($tstamp, $now = false, $usecommonwords = true) {
- static $shortformat;
- if(empty($shortformat)) {
- $shortformat = get_string('strftimedayshort');
- }
+ $eventids = array();
+ if (!empty($eventsbyday[$day])) {
+ $eventids = $eventsbyday[$day];
+ }
- if($now === false) {
- $now = time();
- }
+ if (!empty($durationbyday[$day])) {
+ $eventids = array_unique(array_merge($eventids, $durationbyday[$day]));
+ }
- // To have it in one place, if a change is needed
- $formal = userdate($tstamp, $shortformat);
+ $finishclass = false;
- $datestamp = usergetdate($tstamp);
- $datenow = usergetdate($now);
+ if (!empty($eventids)) {
+ // There is at least one event on this day.
+ $class .= ' hasevent';
+ $hrefparams['view'] = 'day';
+ $dayhref = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', $hrefparams), 0, 0, 0, $daytime);
- if($usecommonwords == false) {
- // We don't want words, just a date
- return $formal;
- }
- else if($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday']) {
- // Today
- return get_string('today', 'calendar');
- }
- else if(
- ($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] - 1 ) ||
- ($datestamp['year'] == $datenow['year'] - 1 && $datestamp['mday'] == 31 && $datestamp['mon'] == 12 && $datenow['yday'] == 1)
- ) {
- // Yesterday
- return get_string('yesterday', 'calendar');
- }
- else if(
- ($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] + 1 ) ||
- ($datestamp['year'] == $datenow['year'] + 1 && $datenow['mday'] == 31 && $datenow['mon'] == 12 && $datestamp['yday'] == 1)
- ) {
- // Tomorrow
- return get_string('tomorrow', 'calendar');
- }
- else {
- return $formal;
- }
-}
+ $popupcontent = '';
+ foreach ($eventids as $eventid) {
+ if (!isset($events[$eventid])) {
+ continue;
+ }
+ $event = new \calendar_event($events[$eventid]);
+ $popupalt = '';
+ $component = 'moodle';
+ if (!empty($event->modulename)) {
+ $popupicon = 'icon';
+ $popupalt = $event->modulename;
+ $component = $event->modulename;
+ } else if ($event->courseid == SITEID) { // Site event.
+ $popupicon = 'i/siteevent';
+ } else if ($event->courseid != 0 && $event->courseid != SITEID
+ && $event->groupid == 0) { // Course event.
+ $popupicon = 'i/courseevent';
+ } else if ($event->groupid) { // Group event.
+ $popupicon = 'i/groupevent';
+ } else { // Must be a user event.
+ $popupicon = 'i/userevent';
+ }
-/**
- * return the formatted representation time
- *
- * @param int $time the timestamp in UTC, as obtained from the database
- * @return string the formatted date/time
- */
-function calendar_time_representation($time) {
- static $langtimeformat = NULL;
- if($langtimeformat === NULL) {
- $langtimeformat = get_string('strftimetime');
- }
- $timeformat = get_user_preferences('calendar_timeformat');
- if(empty($timeformat)){
- $timeformat = get_config(NULL,'calendar_site_timeformat');
- }
- // The ? is needed because the preference might be present, but empty
- return userdate($time, empty($timeformat) ? $langtimeformat : $timeformat);
-}
+ if ($event->timeduration) {
+ $startdate = $calendartype->timestamp_to_date_array($event->timestart);
+ $enddate = $calendartype->timestamp_to_date_array($event->timestart + $event->timeduration - 1);
+ if ($enddate['mon'] == $m && $enddate['year'] == $y && $enddate['mday'] == $day) {
+ $finishclass = true;
+ }
+ }
-/**
- * Adds day, month, year arguments to a URL and returns a moodle_url object.
- *
- * @param string|moodle_url $linkbase
- * @param int $d The number of the day.
- * @param int $m The number of the month.
- * @param int $y The number of the year.
- * @param int $time the unixtime, used for multiple calendar support. The values $d,
- * $m and $y are kept for backwards compatibility.
- * @return moodle_url|null $linkbase
- */
-function calendar_get_link_href($linkbase, $d, $m, $y, $time = 0) {
- if (empty($linkbase)) {
- return '';
- }
- if (!($linkbase instanceof moodle_url)) {
- $linkbase = new moodle_url($linkbase);
- }
+ $dayhref->set_anchor('event_' . $event->id);
- // If a day, month and year were passed then convert it to a timestamp. If these were passed
- // then we can assume the day, month and year are passed as Gregorian, as no where in core
- // should we be passing these values rather than the time.
- if (!empty($d) && !empty($m) && !empty($y)) {
- if (checkdate($m, $d, $y)) {
- $time = make_timestamp($y, $m, $d);
+ $popupcontent .= \html_writer::start_tag('div');
+ $popupcontent .= $OUTPUT->pix_icon($popupicon, $popupalt, $component);
+ // Show ical source if needed.
+ if (!empty($event->subscription) && $CFG->calendar_showicalsource) {
+ $a = new \stdClass();
+ $a->name = format_string($event->name, true);
+ $a->source = $event->subscription->name;
+ $name = get_string('namewithsource', 'calendar', $a);
+ } else {
+ if ($finishclass) {
+ $samedate = $startdate['mon'] == $enddate['mon'] &&
+ $startdate['year'] == $enddate['year'] &&
+ $startdate['mday'] == $enddate['mday'];
+
+ if ($samedate) {
+ $name = format_string($event->name, true);
+ } else {
+ $name = format_string($event->name, true) . ' (' . get_string('eventendtime', 'calendar') . ')';
+ }
+ } else {
+ $name = format_string($event->name, true);
+ }
+ }
+ $popupcontent .= \html_writer::link($dayhref, $name);
+ $popupcontent .= \html_writer::end_tag('div');
+ }
+
+ if ($display->thismonth && $day == $d) {
+ $popupdata = calendar_get_popup(true, $daytime, $popupcontent);
+ } else {
+ $popupdata = calendar_get_popup(false, $daytime, $popupcontent);
+ }
+
+ // Class and cell content.
+ if (isset($typesbyday[$day]['startglobal'])) {
+ $class .= ' calendar_event_global';
+ } else if (isset($typesbyday[$day]['startcourse'])) {
+ $class .= ' calendar_event_course';
+ } else if (isset($typesbyday[$day]['startgroup'])) {
+ $class .= ' calendar_event_group';
+ } else if (isset($typesbyday[$day]['startuser'])) {
+ $class .= ' calendar_event_user';
+ }
+ if ($finishclass) {
+ $class .= ' duration_finish';
+ }
+ $data = array(
+ 'url' => $dayhref,
+ 'day' => $day,
+ 'content' => $popupdata['data-core_calendar-popupcontent'],
+ 'title' => $popupdata['data-core_calendar-title']
+ );
+ $cell = $OUTPUT->render_from_template('core_calendar/minicalendar_day_link', $data);
} else {
- $time = time();
+ $cell = $day;
}
- } else if (empty($time)) {
- $time = time();
- }
- $linkbase->param('time', $time);
+ $durationclass = false;
+ if (isset($typesbyday[$day]['durationglobal'])) {
+ $durationclass = ' duration_global';
+ } else if (isset($typesbyday[$day]['durationcourse'])) {
+ $durationclass = ' duration_course';
+ } else if (isset($typesbyday[$day]['durationgroup'])) {
+ $durationclass = ' duration_group';
+ } else if (isset($typesbyday[$day]['durationuser'])) {
+ $durationclass = ' duration_user';
+ }
+ if ($durationclass) {
+ $class .= ' duration ' . $durationclass;
+ }
- return $linkbase;
-}
+ // If event has a class set then add it to the table day | tag.
+ // Note: only one colour for minicalendar.
+ if (isset($eventsbyday[$day])) {
+ foreach ($eventsbyday[$day] as $eventid) {
+ if (!isset($events[$eventid])) {
+ continue;
+ }
+ $event = $events[$eventid];
+ if (!empty($event->class)) {
+ $class .= ' ' . $event->class;
+ }
+ break;
+ }
+ }
-/**
- * Build and return a previous month HTML link, with an arrow.
- *
- * @param string $text The text label.
- * @param string|moodle_url $linkbase The URL stub.
- * @param int $d The number of the date.
- * @param int $m The number of the month.
- * @param int $y year The number of the year.
- * @param bool $accesshide Default visible, or hide from all except screenreaders.
- * @param int $time the unixtime, used for multiple calendar support. The values $d,
- * $m and $y are kept for backwards compatibility.
- * @return string HTML string.
- */
-function calendar_get_link_previous($text, $linkbase, $d, $m, $y, $accesshide = false, $time = 0) {
- $href = calendar_get_link_href(new moodle_url($linkbase), $d, $m, $y, $time);
- if (empty($href)) {
- return $text;
+ if ($display->thismonth && $day == $d) {
+ // The current cell is for today - add appropriate classes and additional information for styling.
+ $class .= ' today';
+ $today = get_string('today', 'calendar') . ' ' . userdate(time(), get_string('strftimedayshort'));
+
+ if (!isset($eventsbyday[$day]) && !isset($durationbyday[$day])) {
+ $class .= ' eventnone';
+ $popupdata = calendar_get_popup(true, false);
+ $data = array(
+ 'url' => '#',
+ 'day' => $day,
+ 'content' => $popupdata['data-core_calendar-popupcontent'],
+ 'title' => $popupdata['data-core_calendar-title']
+ );
+ $cell = $OUTPUT->render_from_template('core_calendar/minicalendar_day_link', $data);
+ }
+ $cell = get_accesshide($today . ' ') . $cell;
+ }
+
+ // Just display it.
+ $cellattributes['class'] = $class;
+ $content .= \html_writer::tag('td', $cell, $cellattributes);
}
- return link_arrow_left($text, (string)$href, $accesshide, 'previous');
-}
-/**
- * Build and return a next month HTML link, with an arrow.
- *
- * @param string $text The text label.
- * @param string|moodle_url $linkbase The URL stub.
- * @param int $d the number of the Day
- * @param int $m The number of the month.
- * @param int $y The number of the year.
- * @param bool $accesshide Default visible, or hide from all except screenreaders.
- * @param int $time the unixtime, used for multiple calendar support. The values $d,
- * $m and $y are kept for backwards compatibility.
- * @return string HTML string.
- */
-function calendar_get_link_next($text, $linkbase, $d, $m, $y, $accesshide = false, $time = 0) {
- $href = calendar_get_link_href(new moodle_url($linkbase), $d, $m, $y, $time);
- if (empty($href)) {
- return $text;
+ // Padding (the last week may have blank days at the end).
+ for ($i = $dayweek; $i <= $display->maxwday; ++$i) {
+ $content .= ' | | ';
}
- return link_arrow_right($text, (string)$href, $accesshide, 'next');
-}
+ $content .= '
'; // Last row ends.
-/**
- * Return the name of the weekday
- *
- * @param string $englishname
- * @return string of the weekeday
- */
-function calendar_wday_name($englishname) {
- return get_string(strtolower($englishname), 'calendar');
+ $content .= '
'; // Tabular display of days ends.
+ return $content;
}
/**
- * Return the number of days in month
+ * Gets the calendar popup.
*
- * @param int $month the number of the month.
- * @param int $year the number of the year
- * @return int
- */
-function calendar_days_in_month($month, $year) {
- $calendartype = \core_calendar\type_factory::get_calendar_instance();
- return $calendartype->get_num_days_in_month($year, $month);
-}
-
-/**
- * Get the upcoming event block
+ * It called at multiple points in from calendar_get_mini.
+ * Copied and modified from calendar_get_mini.
*
- * @param array $events list of events
- * @param moodle_url|string $linkhref link to event referer
- * @param boolean $showcourselink whether links to courses should be shown
- * @return string|null $content html block content
+ * @param bool $today false except when called on the current day.
+ * @param mixed $timestart $events[$eventid]->timestart, OR false if there are no events.
+ * @param string $popupcontent content for the popup window/layout.
+ * @return string eventid for the calendar_tooltip popup window/layout.
*/
-function calendar_get_block_upcoming($events, $linkhref = NULL, $showcourselink = false) {
- $content = '';
- $lines = count($events);
- if (!$lines) {
- return $content;
+function calendar_get_popup($today = false, $timestart, $popupcontent = '') {
+ $popupcaption = '';
+ if ($today) {
+ $popupcaption = get_string('today', 'calendar') . ' ';
}
- for ($i = 0; $i < $lines; ++$i) {
- if (!isset($events[$i]->time)) { // Just for robustness
- continue;
- }
- $events[$i] = calendar_add_event_metadata($events[$i]);
- $content .= ''.$events[$i]->icon.'';
- if (!empty($events[$i]->referer)) {
- // That's an activity event, so let's provide the hyperlink
- $content .= $events[$i]->referer;
- } else {
- if(!empty($linkhref)) {
- $href = calendar_get_link_href(new moodle_url(CALENDAR_URL . $linkhref), 0, 0, 0, $events[$i]->timestart);
- $href->set_anchor('event_'.$events[$i]->id);
- $content .= html_writer::link($href, $events[$i]->name);
- }
- else {
- $content .= $events[$i]->name;
- }
- }
- $events[$i]->time = str_replace('»', '
»', $events[$i]->time);
- if ($showcourselink && !empty($events[$i]->courselink)) {
- $content .= html_writer::div($events[$i]->courselink, 'course');
- }
- $content .= '
'.$events[$i]->time.'
';
- if ($i < $lines - 1) $content .= '
';
+ if (false === $timestart) {
+ $popupcaption .= userdate(time(), get_string('strftimedayshort'));
+ $popupcontent = get_string('eventnone', 'calendar');
+
+ } else {
+ $popupcaption .= get_string('eventsfor', 'calendar', userdate($timestart, get_string('strftimedayshort')));
}
- return $content;
+ return array(
+ 'data-core_calendar-title' => $popupcaption,
+ 'data-core_calendar-popupcontent' => $popupcontent,
+ );
}
/**
- * Get the next following month
+ * Gets the calendar upcoming event.
*
- * @param int $month the number of the month.
- * @param int $year the number of the year.
- * @return array the following month
+ * @param array $courses array of courses
+ * @param array|int|bool $groups array of groups, group id or boolean for all/no group events
+ * @param array|int|bool $users array of users, user id or boolean for all/no user events
+ * @param int $daysinfuture number of days in the future we 'll look
+ * @param int $maxevents maximum number of events
+ * @param int $fromtime start time
+ * @return array $output array of upcoming events
*/
-function calendar_add_month($month, $year) {
- // Get the calendar type we are using.
- $calendartype = \core_calendar\type_factory::get_calendar_instance();
- return $calendartype->get_next_month($year, $month);
-}
+function calendar_get_upcoming($courses, $groups, $users, $daysinfuture, $maxevents, $fromtime=0) {
+ global $COURSE;
-/**
- * Get the previous month.
- *
- * @param int $month the number of the month.
- * @param int $year the number of the year.
- * @return array previous month
- */
-function calendar_sub_month($month, $year) {
- // Get the calendar type we are using.
- $calendartype = \core_calendar\type_factory::get_calendar_instance();
- return $calendartype->get_prev_month($year, $month);
-}
+ $display = new \stdClass;
+ $display->range = $daysinfuture; // How many days in the future we 'll look.
+ $display->maxevents = $maxevents;
-/**
- * Get per-day basis events
- *
- * @param array $events list of events
- * @param int $month the number of the month
- * @param int $year the number of the year
- * @param array $eventsbyday event on specific day
- * @param array $durationbyday duration of the event in days
- * @param array $typesbyday event type (eg: global, course, user, or group)
- * @param array $courses list of courses
- * @return void
- */
-function calendar_events_by_day($events, $month, $year, &$eventsbyday, &$durationbyday, &$typesbyday, &$courses) {
- // Get the calendar type we are using.
- $calendartype = \core_calendar\type_factory::get_calendar_instance();
+ $output = array();
- $eventsbyday = array();
- $typesbyday = array();
- $durationbyday = array();
+ $processed = 0;
+ $now = time(); // We 'll need this later.
+ $usermidnighttoday = usergetmidnight($now);
- if($events === false) {
- return;
+ if ($fromtime) {
+ $display->tstart = $fromtime;
+ } else {
+ $display->tstart = $usermidnighttoday;
}
- foreach ($events as $event) {
- $startdate = $calendartype->timestamp_to_date_array($event->timestart);
- // Set end date = start date if no duration
- if ($event->timeduration) {
- $enddate = $calendartype->timestamp_to_date_array($event->timestart + $event->timeduration - 1);
- } else {
- $enddate = $startdate;
- }
-
- // Simple arithmetic: $year * 13 + $month is a distinct integer for each distinct ($year, $month) pair
- if(!($startdate['year'] * 13 + $startdate['mon'] <= $year * 13 + $month) && ($enddate['year'] * 13 + $enddate['mon'] >= $year * 13 + $month)) {
- // Out of bounds
- continue;
- }
+ // This works correctly with respect to the user's DST, but it is accurate
+ // only because $fromtime is always the exact midnight of some day!
+ $display->tend = usergetmidnight($display->tstart + DAYSECS * $display->range + 3 * HOURSECS) - 1;
- $eventdaystart = intval($startdate['mday']);
+ // Get the events matching our criteria.
+ $events = \core_calendar\local\api::get_legacy_events($display->tstart, $display->tend, $users, $groups, $courses);
- if($startdate['mon'] == $month && $startdate['year'] == $year) {
- // Give the event to its day
- $eventsbyday[$eventdaystart][] = $event->id;
+ // This is either a genius idea or an idiot idea: in order to not complicate things, we use this rule: if, after
+ // possibly removing SITEID from $courses, there is only one course left, then clicking on a day in the month
+ // will also set the $SESSION->cal_courses_shown variable to that one course. Otherwise, we 'd need to add extra
+ // arguments to this function.
+ $hrefparams = array();
+ if (!empty($courses)) {
+ $courses = array_diff($courses, array(SITEID));
+ if (count($courses) == 1) {
+ $hrefparams['course'] = reset($courses);
+ }
+ }
- // Mark the day as having such an event
- if($event->courseid == SITEID && $event->groupid == 0) {
- $typesbyday[$eventdaystart]['startglobal'] = true;
- // Set event class for global event
- $events[$event->id]->class = 'calendar_event_global';
- }
- else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
- $typesbyday[$eventdaystart]['startcourse'] = true;
- // Set event class for course event
- $events[$event->id]->class = 'calendar_event_course';
- }
- else if($event->groupid) {
- $typesbyday[$eventdaystart]['startgroup'] = true;
- // Set event class for group event
- $events[$event->id]->class = 'calendar_event_group';
+ if ($events !== false) {
+ $modinfo = get_fast_modinfo($COURSE);
+ foreach ($events as $event) {
+ if (!empty($event->modulename)) {
+ if ($event->courseid == $COURSE->id) {
+ if (isset($modinfo->instances[$event->modulename][$event->instance])) {
+ $cm = $modinfo->instances[$event->modulename][$event->instance];
+ if (!$cm->uservisible) {
+ continue;
+ }
+ }
+ } else {
+ if (!$cm = get_coursemodule_from_instance($event->modulename, $event->instance)) {
+ continue;
+ }
+ if (!\core_availability\info_module::is_user_visible($cm, 0, false)) {
+ continue;
+ }
+ }
}
- else if($event->userid) {
- $typesbyday[$eventdaystart]['startuser'] = true;
- // Set event class for user event
- $events[$event->id]->class = 'calendar_event_user';
+
+ if ($processed >= $display->maxevents) {
+ break;
}
- }
- if($event->timeduration == 0) {
- // Proceed with the next
- continue;
+ $event->time = calendar_format_event_time($event, $now, $hrefparams);
+ $output[] = $event;
+ $processed++;
}
+ }
- // The event starts on $month $year or before. So...
- $lowerbound = $startdate['mon'] == $month && $startdate['year'] == $year ? intval($startdate['mday']) : 0;
+ return $output;
+}
- // Also, it ends on $month $year or later...
- $upperbound = $enddate['mon'] == $month && $enddate['year'] == $year ? intval($enddate['mday']) : calendar_days_in_month($month, $year);
+/**
+ * Get a HTML link to a course.
+ *
+ * @param int $courseid the course id
+ * @return string a link to the course (as HTML); empty if the course id is invalid
+ */
+function calendar_get_courselink($courseid) {
+ if (!$courseid) {
+ return '';
+ }
- // Mark all days between $lowerbound and $upperbound (inclusive) as duration
- for($i = $lowerbound + 1; $i <= $upperbound; ++$i) {
- $durationbyday[$i][] = $event->id;
- if($event->courseid == SITEID && $event->groupid == 0) {
- $typesbyday[$i]['durationglobal'] = true;
- }
- else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
- $typesbyday[$i]['durationcourse'] = true;
- }
- else if($event->groupid) {
- $typesbyday[$i]['durationgroup'] = true;
- }
- else if($event->userid) {
- $typesbyday[$i]['durationuser'] = true;
- }
- }
+ calendar_get_course_cached($coursecache, $courseid);
+ $context = \context_course::instance($courseid);
+ $fullname = format_string($coursecache[$courseid]->fullname, true, array('context' => $context));
+ $url = new \moodle_url('/course/view.php', array('id' => $courseid));
+ $link = \html_writer::link($url, $fullname);
- }
- return;
+ return $link;
}
/**
- * Get current module cache
+ * Get current module cache.
*
- * @param array $coursecache list of course cache
+ * @param array $modulecache in memory module cache
* @param string $modulename name of the module
* @param int $instance module instance number
* @return stdClass|bool $module information
*/
-function calendar_get_module_cached(&$coursecache, $modulename, $instance) {
- $module = get_coursemodule_from_instance($modulename, $instance);
-
- if($module === false) return false;
- if(!calendar_get_course_cached($coursecache, $module->course)) {
- return false;
+function calendar_get_module_cached(&$modulecache, $modulename, $instance) {
+ if (!isset($modulecache[$modulename . '_' . $instance])) {
+ $modulecache[$modulename . '_' . $instance] = get_coursemodule_from_instance($modulename, $instance);
}
- return $module;
+
+ return $modulecache[$modulename . '_' . $instance];
}
/**
- * Get current course cache
+ * Get current course cache.
*
* @param array $coursecache list of course cache
* @param int $courseid id of the course
@@ -1554,1424 +1828,1057 @@ function calendar_get_group_cached($groupid) {
}
/**
- * Returns the courses to load events for, the
+ * Add calendar event metadata
*
- * @param array $courseeventsfrom An array of courses to load calendar events for
- * @param bool $ignorefilters specify the use of filters, false is set as default
- * @return array An array of courses, groups, and user to load calendar events for based upon filters
+ * @param stdClass $event event info
+ * @return stdClass $event metadata
*/
-function calendar_set_filters(array $courseeventsfrom, $ignorefilters = false) {
- global $USER, $CFG, $DB;
-
- // For backwards compatability we have to check whether the courses array contains
- // just id's in which case we need to load course objects.
- $coursestoload = array();
- foreach ($courseeventsfrom as $id => $something) {
- if (!is_object($something)) {
- $coursestoload[] = $id;
- unset($courseeventsfrom[$id]);
- }
- }
- if (!empty($coursestoload)) {
- // TODO remove this in 2.2
- debugging('calendar_set_filters now preferes an array of course objects with preloaded contexts', DEBUG_DEVELOPER);
- $courseeventsfrom = array_merge($courseeventsfrom, $DB->get_records_list('course', 'id', $coursestoload));
- }
-
- $courses = array();
- $user = false;
- $group = false;
-
- // capabilities that allow seeing group events from all groups
- // TODO: rewrite so that moodle/calendar:manageentries is not necessary here
- $allgroupscaps = array('moodle/site:accessallgroups', 'moodle/calendar:manageentries');
-
- $isloggedin = isloggedin();
-
- if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_COURSE)) {
- $courses = array_keys($courseeventsfrom);
- }
- if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_GLOBAL)) {
- $courses[] = SITEID;
- }
- $courses = array_unique($courses);
- sort($courses);
+function calendar_add_event_metadata($event) {
+ global $CFG, $OUTPUT;
- if (!empty($courses) && in_array(SITEID, $courses)) {
- // Sort courses for consistent colour highlighting
- // Effectively ignoring SITEID as setting as last course id
- $key = array_search(SITEID, $courses);
- unset($courses[$key]);
- $courses[] = SITEID;
- }
+ // Support multilang in event->name.
+ $event->name = format_string($event->name, true);
- if ($ignorefilters || ($isloggedin && calendar_show_event_type(CALENDAR_EVENT_USER))) {
- $user = $USER->id;
- }
+ if (!empty($event->modulename)) { // Activity event.
+ // The module name is set. I will assume that it has to be displayed, and
+ // also that it is an automatically-generated event. And of course that the
+ // fields for get_coursemodule_from_instance are set correctly.
+ $module = calendar_get_module_cached($coursecache, $event->modulename, $event->instance);
- if (!empty($courseeventsfrom) && (calendar_show_event_type(CALENDAR_EVENT_GROUP) || $ignorefilters)) {
+ if ($module === false) {
+ return;
+ }
- if (count($courseeventsfrom)==1) {
- $course = reset($courseeventsfrom);
- if (has_any_capability($allgroupscaps, context_course::instance($course->id))) {
- $coursegroups = groups_get_all_groups($course->id, 0, 0, 'g.id');
- $group = array_keys($coursegroups);
- }
+ $modulename = get_string('modulename', $event->modulename);
+ if (get_string_manager()->string_exists($event->eventtype, $event->modulename)) {
+ // Will be used as alt text if the event icon.
+ $eventtype = get_string($event->eventtype, $event->modulename);
+ } else {
+ $eventtype = '';
}
- if ($group === false) {
- if (!empty($CFG->calendar_adminseesall) && has_any_capability($allgroupscaps, context_system::instance())) {
- $group = true;
- } else if ($isloggedin) {
- $groupids = array();
+ $icon = $OUTPUT->image_url('icon', $event->modulename) . '';
- // We already have the courses to examine in $courses
- // For each course...
- foreach ($courseeventsfrom as $courseid => $course) {
- // If the user is an editing teacher in there,
- if (!empty($USER->groupmember[$course->id])) {
- // We've already cached the users groups for this course so we can just use that
- $groupids = array_merge($groupids, $USER->groupmember[$course->id]);
- } else if ($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
- // If this course has groups, show events from all of those related to the current user
- $coursegroups = groups_get_user_groups($course->id, $USER->id);
- $groupids = array_merge($groupids, $coursegroups['0']);
- }
- }
- if (!empty($groupids)) {
- $group = $groupids;
- }
- }
+ $event->icon = '
';
+ $event->referer = '' . $event->name . '';
+ $event->courselink = calendar_get_courselink($module->course);
+ $event->cmid = $module->id;
+ } else if ($event->courseid == SITEID) { // Site event.
+ $event->icon = ' . ')
';
+ $event->cssclass = 'calendar_event_global';
+ } else if ($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) { // Course event.
+ $event->icon = ' . ')
';
+ $event->courselink = calendar_get_courselink($event->courseid);
+ $event->cssclass = 'calendar_event_course';
+ } else if ($event->groupid) { // Group event.
+ if ($group = calendar_get_group_cached($event->groupid)) {
+ $groupname = format_string($group->name, true, \context_course::instance($group->courseid));
+ } else {
+ $groupname = '';
}
- }
- if (empty($courses)) {
- $courses = false;
+ $event->icon = \html_writer::empty_tag('image', array('src' => $OUTPUT->image_url('i/groupevent'),
+ 'alt' => get_string('groupevent', 'calendar'), 'title' => $groupname, 'class' => 'icon'));
+ $event->courselink = calendar_get_courselink($event->courseid) . ', ' . $groupname;
+ $event->cssclass = 'calendar_event_group';
+ } else if ($event->userid) { // User event.
+ $event->icon = ' . ')
';
+ $event->cssclass = 'calendar_event_user';
}
- return array($courses, $group, $user);
+ return $event;
}
/**
- * Return the capability for editing calendar event
+ * Get calendar events by id.
*
- * @param calendar_event $event event object
- * @return bool capability to edit event
+ * @since Moodle 2.5
+ * @param array $eventids list of event ids
+ * @return array Array of event entries, empty array if nothing found
*/
-function calendar_edit_event_allowed($event) {
- global $USER, $DB;
+function calendar_get_events_by_id($eventids) {
+ global $DB;
- // Must be logged in
- if (!isloggedin()) {
- return false;
+ if (!is_array($eventids) || empty($eventids)) {
+ return array();
}
- // can not be using guest account
- if (isguestuser()) {
- return false;
- }
+ list($wheresql, $params) = $DB->get_in_or_equal($eventids);
+ $wheresql = "id $wheresql";
- // You cannot edit URL based calendar subscription events presently.
- if (isset($event->subscriptionid)) {
- if (!empty($event->subscription->url)) {
- // This event can be updated externally, so it cannot be edited.
- return false;
- }
- }
+ return $DB->get_records_select('event', $wheresql, $params);
+}
- $sitecontext = context_system::instance();
- // if user has manageentries at site level, return true
- if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
- return true;
- }
+/**
+ * Get control options for calendar.
+ *
+ * @param string $type of calendar
+ * @param array $data calendar information
+ * @return string $content return available control for the calender in html
+ */
+function calendar_top_controls($type, $data) {
+ global $PAGE, $OUTPUT;
- // if groupid is set, it's definitely a group event
- if (!empty($event->groupid)) {
- // Allow users to add/edit group events if:
- // 1) They have manageentries (= entries for whole course)
- // 2) They have managegroupentries AND are in the group
- $group = $DB->get_record('groups', array('id'=>$event->groupid));
- return $group && (
- has_capability('moodle/calendar:manageentries', $event->context) ||
- (has_capability('moodle/calendar:managegroupentries', $event->context)
- && groups_is_member($event->groupid)));
- } else if (!empty($event->courseid)) {
- // if groupid is not set, but course is set,
- // it's definiely a course event
- return has_capability('moodle/calendar:manageentries', $event->context);
- } else if (!empty($event->userid) && $event->userid == $USER->id) {
- // if course is not set, but userid id set, it's a user event
- return (has_capability('moodle/calendar:manageownentries', $event->context));
- } else if (!empty($event->userid)) {
- return (has_capability('moodle/calendar:manageentries', $event->context));
- }
- return false;
-}
+ // Get the calendar type we are using.
+ $calendartype = \core_calendar\type_factory::get_calendar_instance();
-/**
- * Returns the default courses to display on the calendar when there isn't a specific
- * course to display.
- *
- * @return array $courses Array of courses to display
- */
-function calendar_get_default_courses() {
- global $CFG, $DB;
+ $content = '';
- if (!isloggedin()) {
- return array();
+ // Ensure course id passed if relevant.
+ $courseid = '';
+ if (!empty($data['id'])) {
+ $courseid = '&course=' . $data['id'];
}
- $courses = array();
- if (!empty($CFG->calendar_adminseesall) && has_capability('moodle/calendar:manageentries', context_system::instance())) {
- $select = ', ' . context_helper::get_preload_record_columns_sql('ctx');
- $join = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
- $sql = "SELECT c.* $select
- FROM {course} c
- $join
- WHERE EXISTS (SELECT 1 FROM {event} e WHERE e.courseid = c.id)
- ";
- $courses = $DB->get_records_sql($sql, array('contextlevel' => CONTEXT_COURSE), 0, 20);
- foreach ($courses as $course) {
- context_helper::preload_from_record($course);
+ // If we are passing a month and year then we need to convert this to a timestamp to
+ // support multiple calendars. No where in core should these be passed, this logic
+ // here is for third party plugins that may use this function.
+ if (!empty($data['m']) && !empty($date['y'])) {
+ if (!isset($data['d'])) {
+ $data['d'] = 1;
}
- return $courses;
+ if (!checkdate($data['m'], $data['d'], $data['y'])) {
+ $time = time();
+ } else {
+ $time = make_timestamp($data['y'], $data['m'], $data['d']);
+ }
+ } else if (!empty($data['time'])) {
+ $time = $data['time'];
+ } else {
+ $time = time();
}
- $courses = enrol_get_my_courses();
+ // Get the date for the calendar type.
+ $date = $calendartype->timestamp_to_date_array($time);
- return $courses;
-}
+ $urlbase = $PAGE->url;
-/**
- * Display calendar preference button
- *
- * @param stdClass $course course object
- * @deprecated since Moodle 3.2
- * @todo MDL-55875 This will be deleted in Moodle 3.6.
- * @return string return preference button in html
- */
-function calendar_preferences_button(stdClass $course) {
- global $OUTPUT;
+ // We need to get the previous and next months in certain cases.
+ if ($type == 'frontpage' || $type == 'course' || $type == 'month') {
+ $prevmonth = calendar_sub_month($date['mon'], $date['year']);
+ $prevmonthtime = $calendartype->convert_to_gregorian($prevmonth[1], $prevmonth[0], 1);
+ $prevmonthtime = make_timestamp($prevmonthtime['year'], $prevmonthtime['month'], $prevmonthtime['day'],
+ $prevmonthtime['hour'], $prevmonthtime['minute']);
- // Guests have no preferences
- if (!isloggedin() || isguestuser()) {
- return '';
+ $nextmonth = calendar_add_month($date['mon'], $date['year']);
+ $nextmonthtime = $calendartype->convert_to_gregorian($nextmonth[1], $nextmonth[0], 1);
+ $nextmonthtime = make_timestamp($nextmonthtime['year'], $nextmonthtime['month'], $nextmonthtime['day'],
+ $nextmonthtime['hour'], $nextmonthtime['minute']);
}
- debugging('This should no longer be used, the calendar preferences are now linked to the user preferences page');
- return $OUTPUT->single_button(new moodle_url('/user/calendar.php'), get_string("preferences", "calendar"));
-}
+ switch ($type) {
+ case 'frontpage':
+ $prevlink = calendar_get_link_previous(get_string('monthprev', 'access'), $urlbase, false, false, false,
+ true, $prevmonthtime);
+ $nextlink = calendar_get_link_next(get_string('monthnext', 'access'), $urlbase, false, false, false, true,
+ $nextmonthtime);
+ $calendarlink = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', array('view' => 'month')),
+ false, false, false, $time);
-/**
- * Get event format time
- *
- * @param calendar_event $event event object
- * @param int $now current time in gmt
- * @param array $linkparams list of params for event link
- * @param bool $usecommonwords the words as formatted date/time.
- * @param int $showtime determine the show time GMT timestamp
- * @return string $eventtime link/string for event time
- */
-function calendar_format_event_time($event, $now, $linkparams = null, $usecommonwords = true, $showtime = 0) {
- $starttime = $event->timestart;
- $endtime = $event->timestart + $event->timeduration;
+ if (!empty($data['id'])) {
+ $calendarlink->param('course', $data['id']);
+ }
- if (empty($linkparams) || !is_array($linkparams)) {
- $linkparams = array();
- }
+ $right = $nextlink;
- $linkparams['view'] = 'day';
+ $content .= \html_writer::start_tag('div', array('class' => 'calendar-controls'));
+ $content .= $prevlink . ' | ';
+ $content .= \html_writer::tag('span', \html_writer::link($calendarlink,
+ userdate($time, get_string('strftimemonthyear')), array('title' => get_string('monththis', 'calendar'))
+ ), array('class' => 'current'));
+ $content .= ' | ' . $right;
+ $content .= "\n";
+ $content .= \html_writer::end_tag('div');
- // OK, now to get a meaningful display...
- // Check if there is a duration for this event.
- if ($event->timeduration) {
- // Get the midnight of the day the event will start.
- $usermidnightstart = usergetmidnight($starttime);
- // Get the midnight of the day the event will end.
- $usermidnightend = usergetmidnight($endtime);
- // Check if we will still be on the same day.
- if ($usermidnightstart == $usermidnightend) {
- // Check if we are running all day.
- if ($event->timeduration == DAYSECS) {
- $time = get_string('allday', 'calendar');
- } else { // Specify the time we will be running this from.
- $datestart = calendar_time_representation($starttime);
- $dateend = calendar_time_representation($endtime);
- $time = $datestart . ' » ' . $dateend;
- }
+ break;
+ case 'course':
+ $prevlink = calendar_get_link_previous(get_string('monthprev', 'access'), $urlbase, false, false, false,
+ true, $prevmonthtime);
+ $nextlink = calendar_get_link_next(get_string('monthnext', 'access'), $urlbase, false, false, false,
+ true, $nextmonthtime);
+ $calendarlink = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', array('view' => 'month')),
+ false, false, false, $time);
- // Set printable representation.
- if (!$showtime) {
- $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
- $url = calendar_get_link_href(new moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $endtime);
- $eventtime = html_writer::link($url, $day) . ', ' . $time;
- } else {
- $eventtime = $time;
+ if (!empty($data['id'])) {
+ $calendarlink->param('course', $data['id']);
}
- } else { // It must spans two or more days.
- $daystart = calendar_day_representation($event->timestart, $now, $usecommonwords) . ', ';
- if ($showtime == $usermidnightstart) {
- $daystart = '';
+
+ $content .= \html_writer::start_tag('div', array('class' => 'calendar-controls'));
+ $content .= $prevlink . ' | ';
+ $content .= \html_writer::tag('span', \html_writer::link($calendarlink,
+ userdate($time, get_string('strftimemonthyear')), array('title' => get_string('monththis', 'calendar'))
+ ), array('class' => 'current'));
+ $content .= ' | ' . $nextlink;
+ $content .= "";
+ $content .= \html_writer::end_tag('div');
+ break;
+ case 'upcoming':
+ $calendarlink = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', array('view' => 'upcoming')),
+ false, false, false, $time);
+ if (!empty($data['id'])) {
+ $calendarlink->param('course', $data['id']);
}
- $timestart = calendar_time_representation($event->timestart);
- $dayend = calendar_day_representation($event->timestart + $event->timeduration, $now, $usecommonwords) . ', ';
- if ($showtime == $usermidnightend) {
- $dayend = '';
+ $calendarlink = \html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')));
+ $content .= \html_writer::tag('div', $calendarlink, array('class' => 'centered'));
+ break;
+ case 'display':
+ $calendarlink = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', array('view' => 'month')),
+ false, false, false, $time);
+ if (!empty($data['id'])) {
+ $calendarlink->param('course', $data['id']);
}
- $timeend = calendar_time_representation($event->timestart + $event->timeduration);
+ $calendarlink = \html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')));
+ $content .= \html_writer::tag('h3', $calendarlink);
+ break;
+ case 'month':
+ $prevlink = calendar_get_link_previous(userdate($prevmonthtime, get_string('strftimemonthyear')),
+ 'view.php?view=month' . $courseid . '&', false, false, false, false, $prevmonthtime);
+ $nextlink = calendar_get_link_next(userdate($nextmonthtime, get_string('strftimemonthyear')),
+ 'view.php?view=month' . $courseid . '&', false, false, false, false, $nextmonthtime);
- // Set printable representation.
- if ($now >= $usermidnightstart && $now < strtotime('+1 day', $usermidnightstart)) {
- $url = calendar_get_link_href(new moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $endtime);
- $eventtime = $timestart . ' » ' . html_writer::link($url, $dayend) . $timeend;
- } else {
- // The event is in the future, print start and end links.
- $url = calendar_get_link_href(new moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $starttime);
- $eventtime = html_writer::link($url, $daystart) . $timestart . ' » ';
+ $content .= \html_writer::start_tag('div', array('class' => 'calendar-controls'));
+ $content .= $prevlink . ' | ';
+ $content .= $OUTPUT->heading(userdate($time, get_string('strftimemonthyear')), 2, 'current');
+ $content .= ' | ' . $nextlink;
+ $content .= '';
+ $content .= \html_writer::end_tag('div')."\n";
+ break;
+ case 'day':
+ $days = calendar_get_days();
- $url = calendar_get_link_href(new moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $endtime);
- $eventtime .= html_writer::link($url, $dayend) . $timeend;
- }
- }
- } else { // There is no time duration.
- $time = calendar_time_representation($event->timestart);
- // Set printable representation.
- if (!$showtime) {
- $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
- $url = calendar_get_link_href(new moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $starttime);
- $eventtime = html_writer::link($url, $day) . ', ' . trim($time);
- } else {
- $eventtime = $time;
- }
- }
+ $prevtimestamp = strtotime('-1 day', $time);
+ $nexttimestamp = strtotime('+1 day', $time);
- // Check if It has expired.
- if ($event->timestart + $event->timeduration < $now) {
- $eventtime = '' . str_replace(' href=', ' class="dimmed" href=', $eventtime) . '';
+ $prevdate = $calendartype->timestamp_to_date_array($prevtimestamp);
+ $nextdate = $calendartype->timestamp_to_date_array($nexttimestamp);
+
+ $prevname = $days[$prevdate['wday']]['fullname'];
+ $nextname = $days[$nextdate['wday']]['fullname'];
+ $prevlink = calendar_get_link_previous($prevname, 'view.php?view=day' . $courseid . '&', false, false,
+ false, false, $prevtimestamp);
+ $nextlink = calendar_get_link_next($nextname, 'view.php?view=day' . $courseid . '&', false, false, false,
+ false, $nexttimestamp);
+
+ $content .= \html_writer::start_tag('div', array('class' => 'calendar-controls'));
+ $content .= $prevlink;
+ $content .= ' | ' .userdate($time,
+ get_string('strftimedaydate')) . '';
+ $content .= ' | ' . $nextlink;
+ $content .= "";
+ $content .= \html_writer::end_tag('div') . "\n";
+
+ break;
}
- return $eventtime;
+ return $content;
}
/**
- * Display month selector options
+ * Formats a filter control element.
*
- * @param string $name for the select element
- * @param string|array $selected options for select elements
+ * @param moodle_url $url of the filter
+ * @param int $type constant defining the type filter
+ * @return string html content of the element
*/
-function calendar_print_month_selector($name, $selected) {
- $months = array();
- for ($i=1; $i<=12; $i++) {
- $months[$i] = userdate(gmmktime(12, 0, 0, $i, 15, 2000), '%B');
+function calendar_filter_controls_element(moodle_url $url, $type) {
+ global $OUTPUT;
+
+ switch ($type) {
+ case CALENDAR_EVENT_GLOBAL:
+ $typeforhumans = 'global';
+ $class = 'calendar_event_global';
+ break;
+ case CALENDAR_EVENT_COURSE:
+ $typeforhumans = 'course';
+ $class = 'calendar_event_course';
+ break;
+ case CALENDAR_EVENT_GROUP:
+ $typeforhumans = 'groups';
+ $class = 'calendar_event_group';
+ break;
+ case CALENDAR_EVENT_USER:
+ $typeforhumans = 'user';
+ $class = 'calendar_event_user';
+ break;
+ }
+
+ if (calendar_show_event_type($type)) {
+ $icon = $OUTPUT->pix_icon('t/hide', get_string('hide'));
+ $str = get_string('hide' . $typeforhumans . 'events', 'calendar');
+ } else {
+ $icon = $OUTPUT->pix_icon('t/show', get_string('show'));
+ $str = get_string('show' . $typeforhumans . 'events', 'calendar');
}
- echo html_writer::label(get_string('months'), 'menu'. $name, false, array('class' => 'accesshide'));
- echo html_writer::select($months, $name, $selected, false);
+ $content = \html_writer::start_tag('li', array('class' => 'calendar_event'));
+ $content .= \html_writer::start_tag('a', array('href' => $url, 'rel' => 'nofollow'));
+ $content .= \html_writer::tag('span', $icon, array('class' => $class));
+ $content .= \html_writer::tag('span', $str, array('class' => 'eventname'));
+ $content .= \html_writer::end_tag('a');
+ $content .= \html_writer::end_tag('li');
+
+ return $content;
}
/**
- * Checks to see if the requested type of event should be shown for the given user.
+ * Get the controls filter for calendar.
*
- * @param CALENDAR_EVENT_GLOBAL|CALENDAR_EVENT_COURSE|CALENDAR_EVENT_GROUP|CALENDAR_EVENT_USER $type
- * The type to check the display for (default is to display all)
- * @param stdClass|int|null $user The user to check for - by default the current user
- * @return bool True if the tyep should be displayed false otherwise
+ * Filter is used to hide calendar info from the display page.
+ *
+
+ * @param moodle_url $returnurl return-url for filter controls
+ * @return string $content return filter controls in html
*/
-function calendar_show_event_type($type, $user = null) {
- $default = CALENDAR_EVENT_GLOBAL + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP + CALENDAR_EVENT_USER;
- if (get_user_preferences('calendar_persistflt', 0, $user) === 0) {
- global $SESSION;
- if (!isset($SESSION->calendarshoweventtype)) {
- $SESSION->calendarshoweventtype = $default;
+function calendar_filter_controls(moodle_url $returnurl) {
+ $groupevents = true;
+
+ $seturl = new \moodle_url('/calendar/set.php', array('return' => base64_encode($returnurl->out_as_local_url(false)),
+ 'sesskey' => sesskey()));
+ $content = \html_writer::start_tag('ul');
+
+ $seturl->param('var', 'showglobal');
+ $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_GLOBAL);
+
+ $seturl->param('var', 'showcourses');
+ $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_COURSE);
+
+ if (isloggedin() && !isguestuser()) {
+ if ($groupevents) {
+ // This course MIGHT have group events defined, so show the filter.
+ $seturl->param('var', 'showgroups');
+ $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_GROUP);
}
- return $SESSION->calendarshoweventtype & $type;
- } else {
- return get_user_preferences('calendar_savedflt', $default, $user) & $type;
+ $seturl->param('var', 'showuser');
+ $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_USER);
}
+ $content .= \html_writer::end_tag('ul');
+
+ return $content;
}
/**
- * Sets the display of the event type given $display.
- *
- * If $display = true the event type will be shown.
- * If $display = false the event type will NOT be shown.
- * If $display = null the current value will be toggled and saved.
+ * Return the representation day.
*
- * @param CALENDAR_EVENT_GLOBAL|CALENDAR_EVENT_COURSE|CALENDAR_EVENT_GROUP|CALENDAR_EVENT_USER $type object of CALENDAR_EVENT_XXX
- * @param bool $display option to display event type
- * @param stdClass|int $user moodle user object or id, null means current user
- */
-function calendar_set_event_type_display($type, $display = null, $user = null) {
- $persist = get_user_preferences('calendar_persistflt', 0, $user);
- $default = CALENDAR_EVENT_GLOBAL + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP + CALENDAR_EVENT_USER;
- if ($persist === 0) {
- global $SESSION;
- if (!isset($SESSION->calendarshoweventtype)) {
- $SESSION->calendarshoweventtype = $default;
- }
- $preference = $SESSION->calendarshoweventtype;
- } else {
- $preference = get_user_preferences('calendar_savedflt', $default, $user);
- }
- $current = $preference & $type;
- if ($display === null) {
- $display = !$current;
+ * @param int $tstamp Timestamp in GMT
+ * @param int|bool $now current Unix timestamp
+ * @param bool $usecommonwords
+ * @return string the formatted date/time
+ */
+function calendar_day_representation($tstamp, $now = false, $usecommonwords = true) {
+ static $shortformat;
+
+ if (empty($shortformat)) {
+ $shortformat = get_string('strftimedayshort');
}
- if ($display && !$current) {
- $preference += $type;
- } else if (!$display && $current) {
- $preference -= $type;
+
+ if ($now === false) {
+ $now = time();
}
- if ($persist === 0) {
- $SESSION->calendarshoweventtype = $preference;
+
+ // To have it in one place, if a change is needed.
+ $formal = userdate($tstamp, $shortformat);
+
+ $datestamp = usergetdate($tstamp);
+ $datenow = usergetdate($now);
+
+ if ($usecommonwords == false) {
+ // We don't want words, just a date.
+ return $formal;
+ } else if ($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday']) {
+ return get_string('today', 'calendar');
+ } else if (($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] - 1 ) ||
+ ($datestamp['year'] == $datenow['year'] - 1 && $datestamp['mday'] == 31 && $datestamp['mon'] == 12
+ && $datenow['yday'] == 1)) {
+ return get_string('yesterday', 'calendar');
+ } else if (($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] + 1 ) ||
+ ($datestamp['year'] == $datenow['year'] + 1 && $datenow['mday'] == 31 && $datenow['mon'] == 12
+ && $datestamp['yday'] == 1)) {
+ return get_string('tomorrow', 'calendar');
} else {
- if ($preference == $default) {
- unset_user_preference('calendar_savedflt', $user);
- } else {
- set_user_preference('calendar_savedflt', $preference, $user);
- }
+ return $formal;
}
}
/**
- * Get calendar's allowed types
+ * return the formatted representation time.
*
- * @param stdClass $allowed list of allowed edit for event type
- * @param stdClass|int $course object of a course or course id
- */
-function calendar_get_allowed_types(&$allowed, $course = null) {
- global $USER, $CFG, $DB;
- $allowed = new stdClass();
- $allowed->user = has_capability('moodle/calendar:manageownentries', context_system::instance());
- $allowed->groups = false; // This may change just below
- $allowed->courses = false; // This may change just below
- $allowed->site = has_capability('moodle/calendar:manageentries', context_course::instance(SITEID));
- if (!empty($course)) {
- if (!is_object($course)) {
- $course = $DB->get_record('course', array('id' => $course), '*', MUST_EXIST);
- }
- if ($course->id != SITEID) {
- $coursecontext = context_course::instance($course->id);
- $allowed->user = has_capability('moodle/calendar:manageownentries', $coursecontext);
+ * @param int $time the timestamp in UTC, as obtained from the database
+ * @return string the formatted date/time
+ */
+function calendar_time_representation($time) {
+ static $langtimeformat = null;
- if (has_capability('moodle/calendar:manageentries', $coursecontext)) {
- $allowed->courses = array($course->id => 1);
+ if ($langtimeformat === null) {
+ $langtimeformat = get_string('strftimetime');
+ }
- if ($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
- if (has_capability('moodle/site:accessallgroups', $coursecontext)) {
- $allowed->groups = groups_get_all_groups($course->id);
- } else {
- $allowed->groups = groups_get_all_groups($course->id, $USER->id);
- }
- }
- } else if (has_capability('moodle/calendar:managegroupentries', $coursecontext)) {
- if($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
- if (has_capability('moodle/site:accessallgroups', $coursecontext)) {
- $allowed->groups = groups_get_all_groups($course->id);
- } else {
- $allowed->groups = groups_get_all_groups($course->id, $USER->id);
- }
- }
- }
- }
+ $timeformat = get_user_preferences('calendar_timeformat');
+ if (empty($timeformat)) {
+ $timeformat = get_config(null, 'calendar_site_timeformat');
}
+
+ return userdate($time, empty($timeformat) ? $langtimeformat : $timeformat);
}
/**
- * See if user can add calendar entries at all
- * used to print the "New Event" button
+ * Adds day, month, year arguments to a URL and returns a moodle_url object.
*
- * @param stdClass $course object of a course or course id
- * @return bool has the capability to add at least one event type
+ * @param string|moodle_url $linkbase
+ * @param int $d The number of the day.
+ * @param int $m The number of the month.
+ * @param int $y The number of the year.
+ * @param int $time the unixtime, used for multiple calendar support. The values $d,
+ * $m and $y are kept for backwards compatibility.
+ * @return moodle_url|null $linkbase
*/
-function calendar_user_can_add_event($course) {
- if (!isloggedin() || isguestuser()) {
- return false;
+function calendar_get_link_href($linkbase, $d, $m, $y, $time = 0) {
+ if (empty($linkbase)) {
+ return null;
}
- calendar_get_allowed_types($allowed, $course);
- return (bool)($allowed->user || $allowed->groups || $allowed->courses || $allowed->site);
+
+ if (!($linkbase instanceof \moodle_url)) {
+ $linkbase = new \moodle_url($linkbase);
+ }
+
+ // If a day, month and year were passed then convert it to a timestamp. If these were passed
+ // then we can assume the day, month and year are passed as Gregorian, as no where in core
+ // should we be passing these values rather than the time.
+ if (!empty($d) && !empty($m) && !empty($y)) {
+ if (checkdate($m, $d, $y)) {
+ $time = make_timestamp($y, $m, $d);
+ } else {
+ $time = time();
+ }
+ } else if (empty($time)) {
+ $time = time();
+ }
+
+ $linkbase->param('time', $time);
+
+ return $linkbase;
}
/**
- * Check wether the current user is permitted to add events
+ * Build and return a previous month HTML link, with an arrow.
*
- * @param stdClass $event object of event
- * @return bool has the capability to add event
+ * @param string $text The text label.
+ * @param string|moodle_url $linkbase The URL stub.
+ * @param int $d The number of the date.
+ * @param int $m The number of the month.
+ * @param int $y year The number of the year.
+ * @param bool $accesshide Default visible, or hide from all except screenreaders.
+ * @param int $time the unixtime, used for multiple calendar support. The values $d,
+ * $m and $y are kept for backwards compatibility.
+ * @return string HTML string.
*/
-function calendar_add_event_allowed($event) {
- global $USER, $DB;
-
- // can not be using guest account
- if (!isloggedin() or isguestuser()) {
- return false;
- }
+function calendar_get_link_previous($text, $linkbase, $d, $m, $y, $accesshide = false, $time = 0) {
+ $href = calendar_get_link_href(new \moodle_url($linkbase), $d, $m, $y, $time);
- $sitecontext = context_system::instance();
- // if user has manageentries at site level, always return true
- if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
- return true;
+ if (empty($href)) {
+ return $text;
}
- switch ($event->eventtype) {
- case 'course':
- return has_capability('moodle/calendar:manageentries', $event->context);
-
- case 'group':
- // Allow users to add/edit group events if:
- // 1) They have manageentries (= entries for whole course)
- // 2) They have managegroupentries AND are in the group
- $group = $DB->get_record('groups', array('id'=>$event->groupid));
- return $group && (
- has_capability('moodle/calendar:manageentries', $event->context) ||
- (has_capability('moodle/calendar:managegroupentries', $event->context)
- && groups_is_member($event->groupid)));
-
- case 'user':
- if ($event->userid == $USER->id) {
- return (has_capability('moodle/calendar:manageownentries', $event->context));
- }
- //there is no 'break;' intentionally
+ return link_arrow_left($text, (string)$href, $accesshide, 'previous');
+}
- case 'site':
- return has_capability('moodle/calendar:manageentries', $event->context);
+/**
+ * Build and return a next month HTML link, with an arrow.
+ *
+ * @param string $text The text label.
+ * @param string|moodle_url $linkbase The URL stub.
+ * @param int $d the number of the Day
+ * @param int $m The number of the month.
+ * @param int $y The number of the year.
+ * @param bool $accesshide Default visible, or hide from all except screenreaders.
+ * @param int $time the unixtime, used for multiple calendar support. The values $d,
+ * $m and $y are kept for backwards compatibility.
+ * @return string HTML string.
+ */
+function calendar_get_link_next($text, $linkbase, $d, $m, $y, $accesshide = false, $time = 0) {
+ $href = calendar_get_link_href(new \moodle_url($linkbase), $d, $m, $y, $time);
- default:
- return has_capability('moodle/calendar:manageentries', $event->context);
+ if (empty($href)) {
+ return $text;
}
+
+ return link_arrow_right($text, (string)$href, $accesshide, 'next');
}
/**
- * Manage calendar events
+ * Return the number of days in month.
*
- * This class provides the required functionality in order to manage calendar events.
- * It was introduced as part of Moodle 2.0 and was created in order to provide a
- * better framework for dealing with calendar events in particular regard to file
- * handling through the new file API
+ * @param int $month the number of the month.
+ * @param int $year the number of the year
+ * @return int
+ */
+function calendar_days_in_month($month, $year) {
+ $calendartype = \core_calendar\type_factory::get_calendar_instance();
+ return $calendartype->get_num_days_in_month($year, $month);
+}
+
+/**
+ * Get the next following month.
*
- * @package core_calendar
- * @category calendar
- * @copyright 2009 Sam Hemelryk
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @param int $month the number of the month.
+ * @param int $year the number of the year.
+ * @return array the following month
+ */
+function calendar_add_month($month, $year) {
+ $calendartype = \core_calendar\type_factory::get_calendar_instance();
+ return $calendartype->get_next_month($year, $month);
+}
+
+/**
+ * Get the previous month.
*
- * @property int $id The id within the event table
- * @property string $name The name of the event
- * @property string $description The description of the event
- * @property int $format The format of the description FORMAT_?
- * @property int $courseid The course the event is associated with (0 if none)
- * @property int $groupid The group the event is associated with (0 if none)
- * @property int $userid The user the event is associated with (0 if none)
- * @property int $repeatid If this is a repeated event this will be set to the
- * id of the original
- * @property string $modulename If added by a module this will be the module name
- * @property int $instance If added by a module this will be the module instance
- * @property string $eventtype The event type
- * @property int $timestart The start time as a timestamp
- * @property int $timeduration The duration of the event in seconds
- * @property int $visible 1 if the event is visible
- * @property int $uuid ?
- * @property int $sequence ?
- * @property int $timemodified The time last modified as a timestamp
+ * @param int $month the number of the month.
+ * @param int $year the number of the year.
+ * @return array previous month
*/
-class calendar_event {
+function calendar_sub_month($month, $year) {
+ $calendartype = \core_calendar\type_factory::get_calendar_instance();
+ return $calendartype->get_prev_month($year, $month);
+}
- /** @var array An object containing the event properties can be accessed via the magic __get/set methods */
- protected $properties = null;
+/**
+ * Get per-day basis events
+ *
+ * @param array $events list of events
+ * @param int $month the number of the month
+ * @param int $year the number of the year
+ * @param array $eventsbyday event on specific day
+ * @param array $durationbyday duration of the event in days
+ * @param array $typesbyday event type (eg: global, course, user, or group)
+ * @param array $courses list of courses
+ * @return void
+ */
+function calendar_events_by_day($events, $month, $year, &$eventsbyday, &$durationbyday, &$typesbyday, &$courses) {
+ $calendartype = \core_calendar\type_factory::get_calendar_instance();
- /**
- * @var string The converted event discription with file paths resolved. This gets populated when someone requests description for the first time */
- protected $_description = null;
+ $eventsbyday = array();
+ $typesbyday = array();
+ $durationbyday = array();
- /** @var array The options to use with this description editor */
- protected $editoroptions = array(
- 'subdirs'=>false,
- 'forcehttps'=>false,
- 'maxfiles'=>-1,
- 'maxbytes'=>null,
- 'trusttext'=>false);
-
- /** @var object The context to use with the description editor */
- protected $editorcontext = null;
+ if ($events === false) {
+ return;
+ }
- /**
- * Instantiates a new event and optionally populates its properties with the
- * data provided
- *
- * @param stdClass $data Optional. An object containing the properties to for
- * an event
- */
- public function __construct($data=null) {
- global $CFG, $USER;
+ foreach ($events as $event) {
+ $startdate = $calendartype->timestamp_to_date_array($event->timestart);
+ if ($event->timeduration) {
+ $enddate = $calendartype->timestamp_to_date_array($event->timestart + $event->timeduration - 1);
+ } else {
+ $enddate = $startdate;
+ }
- // First convert to object if it is not already (should either be object or assoc array)
- if (!is_object($data)) {
- $data = (object)$data;
+ // Simple arithmetic: $year * 13 + $month is a distinct integer for each distinct ($year, $month) pair.
+ if (!($startdate['year'] * 13 + $startdate['mon'] <= $year * 13 + $month) &&
+ ($enddate['year'] * 13 + $enddate['mon'] >= $year * 13 + $month)) {
+ continue;
}
- $this->editoroptions['maxbytes'] = $CFG->maxbytes;
+ $eventdaystart = intval($startdate['mday']);
- $data->eventrepeats = 0;
+ if ($startdate['mon'] == $month && $startdate['year'] == $year) {
+ // Give the event to its day.
+ $eventsbyday[$eventdaystart][] = $event->id;
- if (empty($data->id)) {
- $data->id = null;
+ // Mark the day as having such an event.
+ if ($event->courseid == SITEID && $event->groupid == 0) {
+ $typesbyday[$eventdaystart]['startglobal'] = true;
+ // Set event class for global event.
+ $events[$event->id]->class = 'calendar_event_global';
+ } else if ($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
+ $typesbyday[$eventdaystart]['startcourse'] = true;
+ // Set event class for course event.
+ $events[$event->id]->class = 'calendar_event_course';
+ } else if ($event->groupid) {
+ $typesbyday[$eventdaystart]['startgroup'] = true;
+ // Set event class for group event.
+ $events[$event->id]->class = 'calendar_event_group';
+ } else if ($event->userid) {
+ $typesbyday[$eventdaystart]['startuser'] = true;
+ // Set event class for user event.
+ $events[$event->id]->class = 'calendar_event_user';
+ }
}
- if (!empty($data->subscriptionid)) {
- $data->subscription = calendar_get_subscription($data->subscriptionid);
+ if ($event->timeduration == 0) {
+ // Proceed with the next.
+ continue;
}
- // Default to a user event
- if (empty($data->eventtype)) {
- $data->eventtype = 'user';
+ // The event starts on $month $year or before.
+ if ($startdate['mon'] == $month && $startdate['year'] == $year) {
+ $lowerbound = intval($startdate['mday']);
+ } else {
+ $lowerbound = 0;
}
- // Default to the current user
- if (empty($data->userid)) {
- $data->userid = $USER->id;
+ // Also, it ends on $month $year or later.
+ if ($enddate['mon'] == $month && $enddate['year'] == $year) {
+ $upperbound = intval($enddate['mday']);
+ } else {
+ $upperbound = calendar_days_in_month($month, $year);
}
- if (!empty($data->timeduration) && is_array($data->timeduration)) {
- $data->timeduration = make_timestamp($data->timeduration['year'], $data->timeduration['month'], $data->timeduration['day'], $data->timeduration['hour'], $data->timeduration['minute']) - $data->timestart;
- }
- if (!empty($data->description) && is_array($data->description)) {
- $data->format = $data->description['format'];
- $data->description = $data->description['text'];
- } else if (empty($data->description)) {
- $data->description = '';
- $data->format = editors_get_preferred_format();
- }
- // Ensure form is defaulted correctly
- if (empty($data->format)) {
- $data->format = editors_get_preferred_format();
+ // Mark all days between $lowerbound and $upperbound (inclusive) as duration.
+ for ($i = $lowerbound + 1; $i <= $upperbound; ++$i) {
+ $durationbyday[$i][] = $event->id;
+ if ($event->courseid == SITEID && $event->groupid == 0) {
+ $typesbyday[$i]['durationglobal'] = true;
+ } else if ($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
+ $typesbyday[$i]['durationcourse'] = true;
+ } else if ($event->groupid) {
+ $typesbyday[$i]['durationgroup'] = true;
+ } else if ($event->userid) {
+ $typesbyday[$i]['durationuser'] = true;
+ }
}
- if (empty($data->context)) {
- $data->context = $this->calculate_context($data);
- }
- $this->properties = $data;
}
+ return;
+}
- /**
- * Magic property method
- *
- * Attempts to call a set_$key method if one exists otherwise falls back
- * to simply set the property
- *
- * @param string $key property name
- * @param mixed $value value of the property
- */
- public function __set($key, $value) {
- if (method_exists($this, 'set_'.$key)) {
- $this->{'set_'.$key}($value);
- }
- $this->properties->{$key} = $value;
- }
+/**
+ * Returns the courses to load events for.
+ *
+ * @param array $courseeventsfrom An array of courses to load calendar events for
+ * @param bool $ignorefilters specify the use of filters, false is set as default
+ * @return array An array of courses, groups, and user to load calendar events for based upon filters
+ */
+function calendar_set_filters(array $courseeventsfrom, $ignorefilters = false) {
+ global $USER, $CFG;
- /**
- * Magic get method
- *
- * Attempts to call a get_$key method to return the property and ralls over
- * to return the raw property
- *
- * @param string $key property name
- * @return mixed property value
- */
- public function __get($key) {
- if (method_exists($this, 'get_'.$key)) {
- return $this->{'get_'.$key}();
- }
- if (!isset($this->properties->{$key})) {
- throw new coding_exception('Undefined property requested');
+ // For backwards compatability we have to check whether the courses array contains
+ // just id's in which case we need to load course objects.
+ $coursestoload = array();
+ foreach ($courseeventsfrom as $id => $something) {
+ if (!is_object($something)) {
+ $coursestoload[] = $id;
+ unset($courseeventsfrom[$id]);
}
- return $this->properties->{$key};
}
- /**
- * Stupid PHP needs an isset magic method if you use the get magic method and
- * still want empty calls to work.... blah ~!
- *
- * @param string $key $key property name
- * @return bool|mixed property value, false if property is not exist
- */
- public function __isset($key) {
- return !empty($this->properties->{$key});
- }
+ $courses = array();
+ $user = false;
+ $group = false;
- /**
- * Calculate the context value needed for calendar_event.
- * Event's type can be determine by the available value store in $data
- * It is important to check for the existence of course/courseid to determine
- * the course event.
- * Default value is set to CONTEXT_USER
- *
- * @param stdClass $data information about event
- * @return stdClass The context object.
- */
- protected function calculate_context(stdClass $data) {
- global $USER, $DB;
+ // Get the capabilities that allow seeing group events from all groups.
+ $allgroupscaps = array('moodle/site:accessallgroups', 'moodle/calendar:manageentries');
- $context = null;
- if (isset($data->courseid) && $data->courseid > 0) {
- $context = context_course::instance($data->courseid);
- } else if (isset($data->course) && $data->course > 0) {
- $context = context_course::instance($data->course);
- } else if (isset($data->groupid) && $data->groupid > 0) {
- $group = $DB->get_record('groups', array('id'=>$data->groupid));
- $context = context_course::instance($group->courseid);
- } else if (isset($data->userid) && $data->userid > 0 && $data->userid == $USER->id) {
- $context = context_user::instance($data->userid);
- } else if (isset($data->userid) && $data->userid > 0 && $data->userid != $USER->id &&
- isset($data->instance) && $data->instance > 0) {
- $cm = get_coursemodule_from_instance($data->modulename, $data->instance, 0, false, MUST_EXIST);
- $context = context_course::instance($cm->course);
- } else {
- $context = context_user::instance($data->userid);
- }
+ $isloggedin = isloggedin();
- return $context;
+ if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_COURSE)) {
+ $courses = array_keys($courseeventsfrom);
+ }
+ if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_GLOBAL)) {
+ $courses[] = SITEID;
}
+ $courses = array_unique($courses);
+ sort($courses);
- /**
- * Returns an array of editoroptions for this event: Called by __get
- * Please use $blah = $event->editoroptions;
- *
- * @return array event editor options
- */
- protected function get_editoroptions() {
- return $this->editoroptions;
+ if (!empty($courses) && in_array(SITEID, $courses)) {
+ // Sort courses for consistent colour highlighting.
+ // Effectively ignoring SITEID as setting as last course id.
+ $key = array_search(SITEID, $courses);
+ unset($courses[$key]);
+ $courses[] = SITEID;
}
- /**
- * Returns an event description: Called by __get
- * Please use $blah = $event->description;
- *
- * @return string event description
- */
- protected function get_description() {
- global $CFG;
+ if ($ignorefilters || ($isloggedin && calendar_show_event_type(CALENDAR_EVENT_USER))) {
+ $user = $USER->id;
+ }
- require_once($CFG->libdir . '/filelib.php');
+ if (!empty($courseeventsfrom) && (calendar_show_event_type(CALENDAR_EVENT_GROUP) || $ignorefilters)) {
- if ($this->_description === null) {
- // Check if we have already resolved the context for this event
- if ($this->editorcontext === null) {
- // Switch on the event type to decide upon the appropriate context
- // to use for this event
- $this->editorcontext = $this->properties->context;
- if ($this->properties->eventtype != 'user' && $this->properties->eventtype != 'course'
- && $this->properties->eventtype != 'site' && $this->properties->eventtype != 'group') {
- return clean_text($this->properties->description, $this->properties->format);
- }
+ if (count($courseeventsfrom) == 1) {
+ $course = reset($courseeventsfrom);
+ if (has_any_capability($allgroupscaps, \context_course::instance($course->id))) {
+ $coursegroups = groups_get_all_groups($course->id, 0, 0, 'g.id');
+ $group = array_keys($coursegroups);
}
-
- // Work out the item id for the editor, if this is a repeated event then the files will
- // be associated with the original
- if (!empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
- $itemid = $this->properties->repeatid;
- } else {
- $itemid = $this->properties->id;
+ }
+ if ($group === false) {
+ if (!empty($CFG->calendar_adminseesall) && has_any_capability($allgroupscaps, \context_system::instance())) {
+ $group = true;
+ } else if ($isloggedin) {
+ $groupids = array();
+ foreach ($courseeventsfrom as $courseid => $course) {
+ // If the user is an editing teacher in there.
+ if (!empty($USER->groupmember[$course->id])) {
+ // We've already cached the users groups for this course so we can just use that.
+ $groupids = array_merge($groupids, $USER->groupmember[$course->id]);
+ } else if ($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
+ // If this course has groups, show events from all of those related to the current user.
+ $coursegroups = groups_get_user_groups($course->id, $USER->id);
+ $groupids = array_merge($groupids, $coursegroups['0']);
+ }
+ }
+ if (!empty($groupids)) {
+ $group = $groupids;
+ }
}
-
- // Convert file paths in the description so that things display correctly
- $this->_description = file_rewrite_pluginfile_urls($this->properties->description, 'pluginfile.php', $this->editorcontext->id, 'calendar', 'event_description', $itemid);
- // Clean the text so no nasties get through
- $this->_description = clean_text($this->_description, $this->properties->format);
}
- // Finally return the description
- return $this->_description;
+ }
+ if (empty($courses)) {
+ $courses = false;
}
- /**
- * Return the number of repeat events there are in this events series
- *
- * @return int number of event repeated
- */
- public function count_repeats() {
- global $DB;
- if (!empty($this->properties->repeatid)) {
- $this->properties->eventrepeats = $DB->count_records('event', array('repeatid'=>$this->properties->repeatid));
- // We don't want to count ourselves
- $this->properties->eventrepeats--;
- }
- return $this->properties->eventrepeats;
+ return array($courses, $group, $user);
+}
+
+/**
+ * Return the capability for editing calendar event.
+ *
+ * @param calendar_event $event event object
+ * @return bool capability to edit event
+ */
+function calendar_edit_event_allowed($event) {
+ global $USER, $DB;
+
+ // Must be logged in.
+ if (!isloggedin()) {
+ return false;
}
- /**
- * Update or create an event within the database
- *
- * Pass in a object containing the event properties and this function will
- * insert it into the database and deal with any associated files
- *
- * @see self::create()
- * @see self::update()
- *
- * @param stdClass $data object of event
- * @param bool $checkcapability if moodle should check calendar managing capability or not
- * @return bool event updated
- */
- public function update($data, $checkcapability=true) {
- global $DB, $USER;
+ // Can not be using guest account.
+ if (isguestuser()) {
+ return false;
+ }
- foreach ($data as $key=>$value) {
- $this->properties->$key = $value;
+ // You cannot edit URL based calendar subscription events presently.
+ if (!empty($event->subscriptionid)) {
+ if (!empty($event->subscription->url)) {
+ // This event can be updated externally, so it cannot be edited.
+ return false;
}
+ }
- $this->properties->timemodified = time();
- $usingeditor = (!empty($this->properties->description) && is_array($this->properties->description));
-
- // Prepare event data.
- $eventargs = array(
- 'context' => $this->properties->context,
- 'objectid' => $this->properties->id,
- 'other' => array(
- 'repeatid' => empty($this->properties->repeatid) ? 0 : $this->properties->repeatid,
- 'timestart' => $this->properties->timestart,
- 'name' => $this->properties->name
- )
- );
+ $sitecontext = \context_system::instance();
- if (empty($this->properties->id) || $this->properties->id < 1) {
-
- if ($checkcapability) {
- if (!calendar_add_event_allowed($this->properties)) {
- print_error('nopermissiontoupdatecalendar');
- }
- }
-
- if ($usingeditor) {
- switch ($this->properties->eventtype) {
- case 'user':
- $this->properties->courseid = 0;
- $this->properties->course = 0;
- $this->properties->groupid = 0;
- $this->properties->userid = $USER->id;
- break;
- case 'site':
- $this->properties->courseid = SITEID;
- $this->properties->course = SITEID;
- $this->properties->groupid = 0;
- $this->properties->userid = $USER->id;
- break;
- case 'course':
- $this->properties->groupid = 0;
- $this->properties->userid = $USER->id;
- break;
- case 'group':
- $this->properties->userid = $USER->id;
- break;
- default:
- // Ewww we should NEVER get here, but just incase we do lets
- // fail gracefully
- $usingeditor = false;
- break;
- }
-
- // If we are actually using the editor, we recalculate the context because some default values
- // were set when calculate_context() was called from the constructor.
- if ($usingeditor) {
- $this->properties->context = $this->calculate_context($this->properties);
- $this->editorcontext = $this->properties->context;
- }
-
- $editor = $this->properties->description;
- $this->properties->format = $this->properties->description['format'];
- $this->properties->description = $this->properties->description['text'];
- }
-
- // Insert the event into the database
- $this->properties->id = $DB->insert_record('event', $this->properties);
-
- if ($usingeditor) {
- $this->properties->description = file_save_draft_area_files(
- $editor['itemid'],
- $this->editorcontext->id,
- 'calendar',
- 'event_description',
- $this->properties->id,
- $this->editoroptions,
- $editor['text'],
- $this->editoroptions['forcehttps']);
- $DB->set_field('event', 'description', $this->properties->description, array('id'=>$this->properties->id));
- }
-
- // Log the event entry.
- $eventargs['objectid'] = $this->properties->id;
- $eventargs['context'] = $this->properties->context;
- $event = \core\event\calendar_event_created::create($eventargs);
- $event->trigger();
-
- $repeatedids = array();
-
- if (!empty($this->properties->repeat)) {
- $this->properties->repeatid = $this->properties->id;
- $DB->set_field('event', 'repeatid', $this->properties->repeatid, array('id'=>$this->properties->id));
+ // If user has manageentries at site level, return true.
+ if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
+ return true;
+ }
- $eventcopy = clone($this->properties);
- unset($eventcopy->id);
+ // If groupid is set, it's definitely a group event.
+ if (!empty($event->groupid)) {
+ // Allow users to add/edit group events if -
+ // 1) They have manageentries for the course OR
+ // 2) They have managegroupentries AND are in the group.
+ $group = $DB->get_record('groups', array('id' => $event->groupid));
+ return $group && (
+ has_capability('moodle/calendar:manageentries', $event->context) ||
+ (has_capability('moodle/calendar:managegroupentries', $event->context)
+ && groups_is_member($event->groupid)));
+ } else if (!empty($event->courseid)) {
+ // If groupid is not set, but course is set, it's definiely a course event.
+ return has_capability('moodle/calendar:manageentries', $event->context);
+ } else if (!empty($event->userid) && $event->userid == $USER->id) {
+ // If course is not set, but userid id set, it's a user event.
+ return (has_capability('moodle/calendar:manageownentries', $event->context));
+ } else if (!empty($event->userid)) {
+ return (has_capability('moodle/calendar:manageentries', $event->context));
+ }
- $timestart = new DateTime('@' . $eventcopy->timestart);
- $timestart->setTimezone(core_date::get_user_timezone_object());
+ return false;
+}
- for($i = 1; $i < $eventcopy->repeats; $i++) {
+/**
+ * Returns the default courses to display on the calendar when there isn't a specific
+ * course to display.
+ *
+ * @return array $courses Array of courses to display
+ */
+function calendar_get_default_courses() {
+ global $CFG, $DB;
- $timestart->add(new DateInterval('P7D'));
- $eventcopy->timestart = $timestart->getTimestamp();
+ if (!isloggedin()) {
+ return array();
+ }
- // Get the event id for the log record.
- $eventcopyid = $DB->insert_record('event', $eventcopy);
+ if (!empty($CFG->calendar_adminseesall) && has_capability('moodle/calendar:manageentries', \context_system::instance())) {
+ $select = ', ' . \context_helper::get_preload_record_columns_sql('ctx');
+ $join = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
+ $sql = "SELECT c.* $select
+ FROM {course} c
+ $join
+ WHERE EXISTS (SELECT 1 FROM {event} e WHERE e.courseid = c.id)
+ ";
+ $courses = $DB->get_records_sql($sql, array('contextlevel' => CONTEXT_COURSE), 0, 20);
+ foreach ($courses as $course) {
+ \context_helper::preload_from_record($course);
+ }
+ return $courses;
+ }
- // If the context has been set delete all associated files
- if ($usingeditor) {
- $fs = get_file_storage();
- $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description', $this->properties->id);
- foreach ($files as $file) {
- $fs->create_file_from_storedfile(array('itemid'=>$eventcopyid), $file);
- }
- }
+ $courses = enrol_get_my_courses();
- $repeatedids[] = $eventcopyid;
+ return $courses;
+}
- // Trigger an event.
- $eventargs['objectid'] = $eventcopyid;
- $eventargs['other']['timestart'] = $eventcopy->timestart;
- $event = \core\event\calendar_event_created::create($eventargs);
- $event->trigger();
- }
- }
+/**
+ * Get event format time.
+ *
+ * @param calendar_event $event event object
+ * @param int $now current time in gmt
+ * @param array $linkparams list of params for event link
+ * @param bool $usecommonwords the words as formatted date/time.
+ * @param int $showtime determine the show time GMT timestamp
+ * @return string $eventtime link/string for event time
+ */
+function calendar_format_event_time($event, $now, $linkparams = null, $usecommonwords = true, $showtime = 0) {
+ $starttime = $event->timestart;
+ $endtime = $event->timestart + $event->timeduration;
- // Hook for tracking added events
- self::calendar_event_hook('add_event', array($this->properties, $repeatedids));
- return true;
- } else {
+ if (empty($linkparams) || !is_array($linkparams)) {
+ $linkparams = array();
+ }
- if ($checkcapability) {
- if(!calendar_edit_event_allowed($this->properties)) {
- print_error('nopermissiontoupdatecalendar');
- }
- }
+ $linkparams['view'] = 'day';
- if ($usingeditor) {
- if ($this->editorcontext !== null) {
- $this->properties->description = file_save_draft_area_files(
- $this->properties->description['itemid'],
- $this->editorcontext->id,
- 'calendar',
- 'event_description',
- $this->properties->id,
- $this->editoroptions,
- $this->properties->description['text'],
- $this->editoroptions['forcehttps']);
- } else {
- $this->properties->format = $this->properties->description['format'];
- $this->properties->description = $this->properties->description['text'];
- }
+ // OK, now to get a meaningful display.
+ // Check if there is a duration for this event.
+ if ($event->timeduration) {
+ // Get the midnight of the day the event will start.
+ $usermidnightstart = usergetmidnight($starttime);
+ // Get the midnight of the day the event will end.
+ $usermidnightend = usergetmidnight($endtime);
+ // Check if we will still be on the same day.
+ if ($usermidnightstart == $usermidnightend) {
+ // Check if we are running all day.
+ if ($event->timeduration == DAYSECS) {
+ $time = get_string('allday', 'calendar');
+ } else { // Specify the time we will be running this from.
+ $datestart = calendar_time_representation($starttime);
+ $dateend = calendar_time_representation($endtime);
+ $time = $datestart . ' » ' . $dateend;
}
- $event = $DB->get_record('event', array('id'=>$this->properties->id));
-
- $updaterepeated = (!empty($this->properties->repeatid) && !empty($this->properties->repeateditall));
-
- if ($updaterepeated) {
- // Update all
- if ($this->properties->timestart != $event->timestart) {
- $timestartoffset = $this->properties->timestart - $event->timestart;
- $sql = "UPDATE {event}
- SET name = ?,
- description = ?,
- timestart = timestart + ?,
- timeduration = ?,
- timemodified = ?
- WHERE repeatid = ?";
- $params = array($this->properties->name, $this->properties->description, $timestartoffset, $this->properties->timeduration, time(), $event->repeatid);
- } else {
- $sql = "UPDATE {event} SET name = ?, description = ?, timeduration = ?, timemodified = ? WHERE repeatid = ?";
- $params = array($this->properties->name, $this->properties->description, $this->properties->timeduration, time(), $event->repeatid);
- }
- $DB->execute($sql, $params);
-
- // Trigger an update event for each of the calendar event.
- $events = $DB->get_records('event', array('repeatid' => $event->repeatid), '', 'id,timestart');
- foreach ($events as $event) {
- $eventargs['objectid'] = $event->id;
- $eventargs['other']['timestart'] = $event->timestart;
- $event = \core\event\calendar_event_updated::create($eventargs);
- $event->trigger();
- }
+ // Set printable representation.
+ if (!$showtime) {
+ $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
+ $url = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $endtime);
+ $eventtime = \html_writer::link($url, $day) . ', ' . $time;
} else {
- $DB->update_record('event', $this->properties);
- $event = calendar_event::load($this->properties->id);
- $this->properties = $event->properties();
-
- // Trigger an update event.
- $event = \core\event\calendar_event_updated::create($eventargs);
- $event->trigger();
- }
-
- // Hook for tracking event updates
- self::calendar_event_hook('update_event', array($this->properties, $updaterepeated));
- return true;
- }
- }
-
- /**
- * Deletes an event and if selected an repeated events in the same series
- *
- * This function deletes an event, any associated events if $deleterepeated=true,
- * and cleans up any files associated with the events.
- *
- * @see self::delete()
- *
- * @param bool $deleterepeated delete event repeatedly
- * @return bool succession of deleting event
- */
- public function delete($deleterepeated=false) {
- global $DB;
-
- // If $this->properties->id is not set then something is wrong
- if (empty($this->properties->id)) {
- debugging('Attempting to delete an event before it has been loaded', DEBUG_DEVELOPER);
- return false;
- }
- $calevent = $DB->get_record('event', array('id' => $this->properties->id), '*', MUST_EXIST);
- // Delete the event
- $DB->delete_records('event', array('id'=>$this->properties->id));
-
- // Trigger an event for the delete action.
- $eventargs = array(
- 'context' => $this->properties->context,
- 'objectid' => $this->properties->id,
- 'other' => array(
- 'repeatid' => empty($this->properties->repeatid) ? 0 : $this->properties->repeatid,
- 'timestart' => $this->properties->timestart,
- 'name' => $this->properties->name
- ));
- $event = \core\event\calendar_event_deleted::create($eventargs);
- $event->add_record_snapshot('event', $calevent);
- $event->trigger();
-
- // If we are deleting parent of a repeated event series, promote the next event in the series as parent
- if (($this->properties->id == $this->properties->repeatid) && !$deleterepeated) {
- $newparent = $DB->get_field_sql("SELECT id from {event} where repeatid = ? order by id ASC", array($this->properties->id), IGNORE_MULTIPLE);
- if (!empty($newparent)) {
- $DB->execute("UPDATE {event} SET repeatid = ? WHERE repeatid = ?", array($newparent, $this->properties->id));
- // Get all records where the repeatid is the same as the event being removed
- $events = $DB->get_records('event', array('repeatid' => $newparent));
- // For each of the returned events trigger the event_update hook and an update event.
- foreach ($events as $event) {
- // Trigger an event for the update.
- $eventargs['objectid'] = $event->id;
- $eventargs['other']['timestart'] = $event->timestart;
- $event = \core\event\calendar_event_updated::create($eventargs);
- $event->trigger();
-
- self::calendar_event_hook('update_event', array($event, false));
- }
+ $eventtime = $time;
}
- }
-
- // If the editor context hasn't already been set then set it now
- if ($this->editorcontext === null) {
- $this->editorcontext = $this->properties->context;
- }
-
- // If the context has been set delete all associated files
- if ($this->editorcontext !== null) {
- $fs = get_file_storage();
- $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description', $this->properties->id);
- foreach ($files as $file) {
- $file->delete();
+ } else { // It must spans two or more days.
+ $daystart = calendar_day_representation($event->timestart, $now, $usecommonwords) . ', ';
+ if ($showtime == $usermidnightstart) {
+ $daystart = '';
}
- }
-
- // Fire the event deleted hook
- self::calendar_event_hook('delete_event', array($this->properties->id, $deleterepeated));
-
- // If we need to delete repeated events then we will fetch them all and delete one by one
- if ($deleterepeated && !empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
- // Get all records where the repeatid is the same as the event being removed
- $events = $DB->get_records('event', array('repeatid'=>$this->properties->repeatid));
- // For each of the returned events populate a calendar_event object and call delete
- // make sure the arg passed is false as we are already deleting all repeats
- foreach ($events as $event) {
- $event = new calendar_event($event);
- $event->delete(false);
+ $timestart = calendar_time_representation($event->timestart);
+ $dayend = calendar_day_representation($event->timestart + $event->timeduration, $now, $usecommonwords) . ', ';
+ if ($showtime == $usermidnightend) {
+ $dayend = '';
}
- }
-
- return true;
- }
-
- /**
- * Fetch all event properties
- *
- * This function returns all of the events properties as an object and optionally
- * can prepare an editor for the description field at the same time. This is
- * designed to work when the properties are going to be used to set the default
- * values of a moodle forms form.
- *
- * @param bool $prepareeditor If set to true a editor is prepared for use with
- * the mforms editor element. (for description)
- * @return stdClass Object containing event properties
- */
- public function properties($prepareeditor=false) {
- global $USER, $CFG, $DB;
-
- // First take a copy of the properties. We don't want to actually change the
- // properties or we'd forever be converting back and forwards between an
- // editor formatted description and not
- $properties = clone($this->properties);
- // Clean the description here
- $properties->description = clean_text($properties->description, $properties->format);
-
- // If set to true we need to prepare the properties for use with an editor
- // and prepare the file area
- if ($prepareeditor) {
-
- // We may or may not have a property id. If we do then we need to work
- // out the context so we can copy the existing files to the draft area
- if (!empty($properties->id)) {
-
- if ($properties->eventtype === 'site') {
- // Site context
- $this->editorcontext = $this->properties->context;
- } else if ($properties->eventtype === 'user') {
- // User context
- $this->editorcontext = $this->properties->context;
- } else if ($properties->eventtype === 'group' || $properties->eventtype === 'course') {
- // First check the course is valid
- $course = $DB->get_record('course', array('id'=>$properties->courseid));
- if (!$course) {
- print_error('invalidcourse');
- }
- // Course context
- $this->editorcontext = $this->properties->context;
- // We have a course and are within the course context so we had
- // better use the courses max bytes value
- $this->editoroptions['maxbytes'] = $course->maxbytes;
- } else {
- // If we get here we have a custom event type as used by some
- // modules. In this case the event will have been added by
- // code and we won't need the editor
- $this->editoroptions['maxbytes'] = 0;
- $this->editoroptions['maxfiles'] = 0;
- }
+ $timeend = calendar_time_representation($event->timestart + $event->timeduration);
- if (empty($this->editorcontext) || empty($this->editorcontext->id)) {
- $contextid = false;
- } else {
- // Get the context id that is what we really want
- $contextid = $this->editorcontext->id;
- }
+ // Set printable representation.
+ if ($now >= $usermidnightstart && $now < strtotime('+1 day', $usermidnightstart)) {
+ $url = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $endtime);
+ $eventtime = $timestart . ' » ' . \html_writer::link($url, $dayend) . $timeend;
} else {
+ // The event is in the future, print start and end links.
+ $url = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $starttime);
+ $eventtime = \html_writer::link($url, $daystart) . $timestart . ' » ';
- // If we get here then this is a new event in which case we don't need a
- // context as there is no existing files to copy to the draft area.
- $contextid = null;
+ $url = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $endtime);
+ $eventtime .= \html_writer::link($url, $dayend) . $timeend;
}
-
- // If the contextid === false we don't support files so no preparing
- // a draft area
- if ($contextid !== false) {
- // Just encase it has already been submitted
- $draftiddescription = file_get_submitted_draft_itemid('description');
- // Prepare the draft area, this copies existing files to the draft area as well
- $properties->description = file_prepare_draft_area($draftiddescription, $contextid, 'calendar', 'event_description', $properties->id, $this->editoroptions, $properties->description);
- } else {
- $draftiddescription = 0;
- }
-
- // Structure the description field as the editor requires
- $properties->description = array('text'=>$properties->description, 'format'=>$properties->format, 'itemid'=>$draftiddescription);
}
+ } else { // There is no time duration.
+ $time = calendar_time_representation($event->timestart);
+ // Set printable representation.
+ if (!$showtime) {
+ $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
+ $url = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $starttime);
+ $eventtime = \html_writer::link($url, $day) . ', ' . trim($time);
+ } else {
+ $eventtime = $time;
+ }
+ }
- // Finally return the properties
- return $properties;
+ // Check if It has expired.
+ if ($event->timestart + $event->timeduration < $now) {
+ $eventtime = '' . str_replace(' href=', ' class="dimmed" href=', $eventtime) . '';
}
- /**
- * Toggles the visibility of an event
- *
- * @param null|bool $force If it is left null the events visibility is flipped,
- * If it is false the event is made hidden, if it is true it
- * is made visible.
- * @return bool if event is successfully updated, toggle will be visible
- */
- public function toggle_visibility($force=null) {
- global $CFG, $DB;
+ return $eventtime;
+}
- // Set visible to the default if it is not already set
- if (empty($this->properties->visible)) {
- $this->properties->visible = 1;
- }
+/**
+ * Checks to see if the requested type of event should be shown for the given user.
+ *
+ * @param int $type The type to check the display for (default is to display all)
+ * @param stdClass|int|null $user The user to check for - by default the current user
+ * @return bool True if the tyep should be displayed false otherwise
+ */
+function calendar_show_event_type($type, $user = null) {
+ $default = CALENDAR_EVENT_GLOBAL + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP + CALENDAR_EVENT_USER;
- if ($force === true || ($force !== false && $this->properties->visible == 0)) {
- // Make this event visible
- $this->properties->visible = 1;
- // Fire the hook
- self::calendar_event_hook('show_event', array($this->properties));
- } else {
- // Make this event hidden
- $this->properties->visible = 0;
- // Fire the hook
- self::calendar_event_hook('hide_event', array($this->properties));
+ if (get_user_preferences('calendar_persistflt', 0, $user) === 0) {
+ global $SESSION;
+ if (!isset($SESSION->calendarshoweventtype)) {
+ $SESSION->calendarshoweventtype = $default;
}
-
- // Update the database to reflect this change
- return $DB->set_field('event', 'visible', $this->properties->visible, array('id'=>$this->properties->id));
+ return $SESSION->calendarshoweventtype & $type;
+ } else {
+ return get_user_preferences('calendar_savedflt', $default, $user) & $type;
}
+}
- /**
- * Attempts to call the hook for the specified action should a calendar type
- * by set $CFG->calendar, and the appopriate function defined
- *
- * @param string $action One of `update_event`, `add_event`, `delete_event`, `show_event`, `hide_event`
- * @param array $args The args to pass to the hook, usually the event is the first element
- * @return bool attempts to call event hook
- */
- public static function calendar_event_hook($action, array $args) {
- global $CFG;
- static $extcalendarinc;
- if ($extcalendarinc === null) {
- if (!empty($CFG->calendar)) {
- if (is_readable($CFG->dirroot .'/calendar/'. $CFG->calendar .'/lib.php')) {
- include_once($CFG->dirroot .'/calendar/'. $CFG->calendar .'/lib.php');
- $extcalendarinc = true;
- } else {
- debugging("Calendar lib file missing or not readable at /calendar/{$CFG->calendar}/lib.php.",
- DEBUG_DEVELOPER);
- $extcalendarinc = false;
- }
- } else {
- $extcalendarinc = false;
- }
- }
- if($extcalendarinc === false) {
- return false;
- }
- $hook = $CFG->calendar .'_'.$action;
- if (function_exists($hook)) {
- call_user_func_array($hook, $args);
- return true;
+/**
+ * Sets the display of the event type given $display.
+ *
+ * If $display = true the event type will be shown.
+ * If $display = false the event type will NOT be shown.
+ * If $display = null the current value will be toggled and saved.
+ *
+ * @param int $type object of CALENDAR_EVENT_XXX
+ * @param bool $display option to display event type
+ * @param stdClass|int $user moodle user object or id, null means current user
+ */
+function calendar_set_event_type_display($type, $display = null, $user = null) {
+ $persist = get_user_preferences('calendar_persistflt', 0, $user);
+ $default = CALENDAR_EVENT_GLOBAL + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP + CALENDAR_EVENT_USER;
+ if ($persist === 0) {
+ global $SESSION;
+ if (!isset($SESSION->calendarshoweventtype)) {
+ $SESSION->calendarshoweventtype = $default;
}
- return false;
+ $preference = $SESSION->calendarshoweventtype;
+ } else {
+ $preference = get_user_preferences('calendar_savedflt', $default, $user);
}
-
- /**
- * Returns a calendar_event object when provided with an event id
- *
- * This function makes use of MUST_EXIST, if the event id passed in is invalid
- * it will result in an exception being thrown
- *
- * @param int|object $param event object or event id
- * @return calendar_event|false status for loading calendar_event
- */
- public static function load($param) {
- global $DB;
- if (is_object($param)) {
- $event = new calendar_event($param);
- } else {
- $event = $DB->get_record('event', array('id'=>(int)$param), '*', MUST_EXIST);
- $event = new calendar_event($event);
- }
- return $event;
+ $current = $preference & $type;
+ if ($display === null) {
+ $display = !$current;
}
-
- /**
- * Creates a new event and returns a calendar_event object
- *
- * @param stdClass|array $properties An object containing event properties
- * @param bool $checkcapability Check caps or not
- * @throws coding_exception
- *
- * @return calendar_event|bool The event object or false if it failed
- */
- public static function create($properties, $checkcapability = true) {
- if (is_array($properties)) {
- $properties = (object)$properties;
- }
- if (!is_object($properties)) {
- throw new coding_exception('When creating an event properties should be either an object or an assoc array');
- }
- $event = new calendar_event($properties);
- if ($event->update($properties, $checkcapability)) {
- return $event;
- } else {
- return false;
- }
+ if ($display && !$current) {
+ $preference += $type;
+ } else if (!$display && $current) {
+ $preference -= $type;
}
-
- /**
- * Format the text using the external API.
- * This function should we used when text formatting is required in external functions.
- *
- * @return array an array containing the text formatted and the text format
- */
- public function format_external_text() {
-
- if ($this->editorcontext === null) {
- // Switch on the event type to decide upon the appropriate context to use for this event.
- $this->editorcontext = $this->properties->context;
-
- if ($this->properties->eventtype != 'user' && $this->properties->eventtype != 'course'
- && $this->properties->eventtype != 'site' && $this->properties->eventtype != 'group') {
- // We don't have a context here, do a normal format_text.
- return external_format_text($this->properties->description, $this->properties->format, $this->editorcontext->id);
- }
- }
-
- // Work out the item id for the editor, if this is a repeated event then the files will be associated with the original.
- if (!empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
- $itemid = $this->properties->repeatid;
+ if ($persist === 0) {
+ $SESSION->calendarshoweventtype = $preference;
+ } else {
+ if ($preference == $default) {
+ unset_user_preference('calendar_savedflt', $user);
} else {
- $itemid = $this->properties->id;
+ set_user_preference('calendar_savedflt', $preference, $user);
}
-
- return external_format_text($this->properties->description, $this->properties->format, $this->editorcontext->id,
- 'calendar', 'event_description', $itemid);
}
}
/**
- * Calendar information class
- *
- * This class is used simply to organise the information pertaining to a calendar
- * and is used primarily to make information easily available.
+ * Get calendar's allowed types.
*
- * @package core_calendar
- * @category calendar
- * @copyright 2010 Sam Hemelryk
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @param stdClass $allowed list of allowed edit for event type
+ * @param stdClass|int $course object of a course or course id
*/
-class calendar_information {
-
- /**
- * @var int The timestamp
- *
- * Rather than setting the day, month and year we will set a timestamp which will be able
- * to be used by multiple calendars.
- */
- public $time;
-
- /** @var int A course id */
- public $courseid = null;
+function calendar_get_allowed_types(&$allowed, $course = null) {
+ global $USER, $DB;
- /** @var array An array of courses */
- public $courses = array();
+ $allowed = new \stdClass();
+ $allowed->user = has_capability('moodle/calendar:manageownentries', \context_system::instance());
+ $allowed->groups = false;
+ $allowed->courses = false;
+ $allowed->site = has_capability('moodle/calendar:manageentries', \context_course::instance(SITEID));
- /** @var array An array of groups */
- public $groups = array();
+ if (!empty($course)) {
+ if (!is_object($course)) {
+ $course = $DB->get_record('course', array('id' => $course), '*', MUST_EXIST);
+ }
+ if ($course->id != SITEID) {
+ $coursecontext = \context_course::instance($course->id);
+ $allowed->user = has_capability('moodle/calendar:manageownentries', $coursecontext);
- /** @var array An array of users */
- public $users = array();
+ if (has_capability('moodle/calendar:manageentries', $coursecontext)) {
+ $allowed->courses = array($course->id => 1);
- /**
- * Creates a new instance
- *
- * @param int $day the number of the day
- * @param int $month the number of the month
- * @param int $year the number of the year
- * @param int $time the unixtimestamp representing the date we want to view, this is used instead of $calmonth
- * and $calyear to support multiple calendars
- */
- public function __construct($day = 0, $month = 0, $year = 0, $time = 0) {
- // If a day, month and year were passed then convert it to a timestamp. If these were passed
- // then we can assume the day, month and year are passed as Gregorian, as no where in core
- // should we be passing these values rather than the time. This is done for BC.
- if (!empty($day) || !empty($month) || !empty($year)) {
- $date = usergetdate(time());
- if (empty($day)) {
- $day = $date['mday'];
- }
- if (empty($month)) {
- $month = $date['mon'];
- }
- if (empty($year)) {
- $year = $date['year'];
- }
- if (checkdate($month, $day, $year)) {
- $this->time = make_timestamp($year, $month, $day);
- } else {
- $this->time = time();
+ if ($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
+ if (has_capability('moodle/site:accessallgroups', $coursecontext)) {
+ $allowed->groups = groups_get_all_groups($course->id);
+ } else {
+ $allowed->groups = groups_get_all_groups($course->id, $USER->id);
+ }
+ }
+ } else if (has_capability('moodle/calendar:managegroupentries', $coursecontext)) {
+ if ($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
+ if (has_capability('moodle/site:accessallgroups', $coursecontext)) {
+ $allowed->groups = groups_get_all_groups($course->id);
+ } else {
+ $allowed->groups = groups_get_all_groups($course->id, $USER->id);
+ }
+ }
}
- } else if (!empty($time)) {
- $this->time = $time;
- } else {
- $this->time = time();
}
}
+}
- /**
- * Initialize calendar information
- *
- * @param stdClass $course object
- * @param array $coursestoload An array of courses [$course->id => $course]
- * @param bool $ignorefilters options to use filter
- */
- public function prepare_for_view(stdClass $course, array $coursestoload, $ignorefilters = false) {
- $this->courseid = $course->id;
- $this->course = $course;
- list($courses, $group, $user) = calendar_set_filters($coursestoload, $ignorefilters);
- $this->courses = $courses;
- $this->groups = $group;
- $this->users = $user;
+/**
+ * See if user can add calendar entries at all used to print the "New Event" button.
+ *
+ * @param stdClass $course object of a course or course id
+ * @return bool has the capability to add at least one event type
+ */
+function calendar_user_can_add_event($course) {
+ if (!isloggedin() || isguestuser()) {
+ return false;
}
- /**
- * Ensures the date for the calendar is correct and either sets it to now
- * or throws a moodle_exception if not
- *
- * @param bool $defaultonow use current time
- * @throws moodle_exception
- * @return bool validation of checkdate
- */
- public function checkdate($defaultonow = true) {
- if (!checkdate($this->month, $this->day, $this->year)) {
- if ($defaultonow) {
- $now = usergetdate(time());
- $this->day = intval($now['mday']);
- $this->month = intval($now['mon']);
- $this->year = intval($now['year']);
- return true;
- } else {
- throw new moodle_exception('invaliddate');
- }
- }
- return true;
- }
+ calendar_get_allowed_types($allowed, $course);
- /**
- * Gets todays timestamp for the calendar
- *
- * @return int today timestamp
- */
- public function timestamp_today() {
- return $this->time;
+ return (bool)($allowed->user || $allowed->groups || $allowed->courses || $allowed->site);
+}
+
+/**
+ * Check wether the current user is permitted to add events.
+ *
+ * @param stdClass $event object of event
+ * @return bool has the capability to add event
+ */
+function calendar_add_event_allowed($event) {
+ global $USER, $DB;
+
+ // Can not be using guest account.
+ if (!isloggedin() or isguestuser()) {
+ return false;
}
- /**
- * Gets tomorrows timestamp for the calendar
- *
- * @return int tomorrow timestamp
- */
- public function timestamp_tomorrow() {
- return strtotime('+1 day', $this->time);
+
+ $sitecontext = \context_system::instance();
+
+ // If user has manageentries at site level, always return true.
+ if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
+ return true;
}
- /**
- * Adds the pretend blocks for the calendar
- *
- * @param core_calendar_renderer $renderer
- * @param bool $showfilters display filters, false is set as default
- * @param string|null $view preference view options (eg: day, month, upcoming)
- */
- public function add_sidecalendar_blocks(core_calendar_renderer $renderer, $showfilters=false, $view=null) {
- if ($showfilters) {
- $filters = new block_contents();
- $filters->content = $renderer->fake_block_filters($this->courseid, 0, 0, 0, $view, $this->courses);
- $filters->footer = '';
- $filters->title = get_string('eventskey', 'calendar');
- $renderer->add_pretend_calendar_block($filters, BLOCK_POS_RIGHT);
- }
- $block = new block_contents;
- $block->content = $renderer->fake_block_threemonths($this);
- $block->footer = '';
- $block->title = get_string('monthlyview', 'calendar');
- $renderer->add_pretend_calendar_block($block, BLOCK_POS_RIGHT);
+
+ switch ($event->eventtype) {
+ case 'course':
+ return has_capability('moodle/calendar:manageentries', $event->context);
+ case 'group':
+ // Allow users to add/edit group events if -
+ // 1) They have manageentries (= entries for whole course).
+ // 2) They have managegroupentries AND are in the group.
+ $group = $DB->get_record('groups', array('id' => $event->groupid));
+ return $group && (
+ has_capability('moodle/calendar:manageentries', $event->context) ||
+ (has_capability('moodle/calendar:managegroupentries', $event->context)
+ && groups_is_member($event->groupid)));
+ case 'user':
+ if ($event->userid == $USER->id) {
+ return (has_capability('moodle/calendar:manageownentries', $event->context));
+ }
+ // There is intentionally no 'break'.
+ case 'site':
+ return has_capability('moodle/calendar:manageentries', $event->context);
+ default:
+ return has_capability('moodle/calendar:manageentries', $event->context);
}
}
@@ -2982,12 +2889,12 @@ public function add_sidecalendar_blocks(core_calendar_renderer $renderer, $showf
*/
function calendar_get_pollinterval_choices() {
return array(
- '0' => new lang_string('never', 'calendar'),
- HOURSECS => new lang_string('hourly', 'calendar'),
- DAYSECS => new lang_string('daily', 'calendar'),
- WEEKSECS => new lang_string('weekly', 'calendar'),
- '2628000' => new lang_string('monthly', 'calendar'),
- YEARSECS => new lang_string('annually', 'calendar')
+ '0' => new \lang_string('never', 'calendar'),
+ HOURSECS => new \lang_string('hourly', 'calendar'),
+ DAYSECS => new \lang_string('daily', 'calendar'),
+ WEEKSECS => new \lang_string('weekly', 'calendar'),
+ '2628000' => new \lang_string('monthly', 'calendar'),
+ YEARSECS => new \lang_string('annually', 'calendar')
);
}
@@ -2999,7 +2906,7 @@ function calendar_get_pollinterval_choices() {
*/
function calendar_get_eventtype_choices($courseid) {
$choices = array();
- $allowed = new stdClass;
+ $allowed = new \stdClass;
calendar_get_allowed_types($allowed, $courseid);
if ($allowed->user) {
@@ -3045,7 +2952,7 @@ function calendar_add_subscription($sub) {
if (!empty($sub->name)) {
if (empty($sub->id)) {
$id = $DB->insert_record('event_subscriptions', $sub);
- // we cannot cache the data here because $sub is not complete.
+ // We cannot cache the data here because $sub is not complete.
$sub->id = $id;
// Trigger event, calendar subscription added.
$eventparams = array('objectid' => $sub->id,
@@ -3088,7 +2995,7 @@ function calendar_add_icalendar_event($event, $courseid, $subscriptionid, $timez
$name = str_replace('\\', '', $name);
$name = preg_replace('/\s+/u', ' ', $name);
- $eventrecord = new stdClass;
+ $eventrecord = new \stdClass;
$eventrecord->name = clean_param($name, PARAM_NOTAGS);
if (empty($event->properties['DESCRIPTION'][0]->value)) {
@@ -3107,16 +3014,22 @@ function calendar_add_icalendar_event($event, $courseid, $subscriptionid, $timez
return 0;
}
- $tz = isset($event->properties['DTSTART'][0]->parameters['TZID']) ? $event->properties['DTSTART'][0]->parameters['TZID'] :
- $timezone;
- $tz = core_date::normalise_timezone($tz);
+ if (isset($event->properties['DTSTART'][0]->parameters['TZID'])) {
+ $tz = $event->properties['DTSTART'][0]->parameters['TZID'];
+ } else {
+ $tz = $timezone;
+ }
+ $tz = \core_date::normalise_timezone($tz);
$eventrecord->timestart = strtotime($event->properties['DTSTART'][0]->value . ' ' . $tz);
if (empty($event->properties['DTEND'])) {
- $eventrecord->timeduration = 0; // no duration if no end time specified
+ $eventrecord->timeduration = 0; // No duration if no end time specified.
} else {
- $endtz = isset($event->properties['DTEND'][0]->parameters['TZID']) ? $event->properties['DTEND'][0]->parameters['TZID'] :
- $timezone;
- $endtz = core_date::normalise_timezone($endtz);
+ if (isset($event->properties['DTEND'][0]->parameters['TZID'])) {
+ $endtz = $event->properties['DTEND'][0]->parameters['TZID'];
+ } else {
+ $endtz = $timezone;
+ }
+ $endtz = \core_date::normalise_timezone($endtz);
$eventrecord->timeduration = strtotime($event->properties['DTEND'][0]->value . ' ' . $endtz) - $eventrecord->timestart;
}
@@ -3128,7 +3041,7 @@ function calendar_add_icalendar_event($event, $courseid, $subscriptionid, $timez
// This event should be an all day event.
$eventrecord->timeduration = 0;
}
- core_date::set_default_server_timezone();
+ \core_date::set_default_server_timezone();
}
$eventrecord->uuid = $event->properties['UID'][0]->value;
@@ -3143,20 +3056,21 @@ function calendar_add_icalendar_event($event, $courseid, $subscriptionid, $timez
$eventrecord->courseid = $sub->courseid;
$eventrecord->eventtype = $sub->eventtype;
- if ($updaterecord = $DB->get_record('event', array('uuid' => $eventrecord->uuid, 'subscriptionid' => $eventrecord->subscriptionid))) {
+ if ($updaterecord = $DB->get_record('event', array('uuid' => $eventrecord->uuid,
+ 'subscriptionid' => $eventrecord->subscriptionid))) {
$eventrecord->id = $updaterecord->id;
$return = CALENDAR_IMPORT_EVENT_UPDATED; // Update.
} else {
$return = CALENDAR_IMPORT_EVENT_INSERTED; // Insert.
}
- if ($createdevent = calendar_event::create($eventrecord, false)) {
+ if ($createdevent = \calendar_event::create($eventrecord, false)) {
if (!empty($event->properties['RRULE'])) {
// Repeating events.
date_default_timezone_set($tz); // Change time zone to parse all events.
- $rrule = new \core_calendar\rrule_manager($event->properties['RRULE'][0]->value);
+ $rrule = new rrule_manager($event->properties['RRULE'][0]->value);
$rrule->parse_rrule();
$rrule->create_events($createdevent);
- core_date::set_default_server_timezone(); // Change time zone back to what it was.
+ \core_date::set_default_server_timezone(); // Change time zone back to what it was.
}
return $return;
} else {
@@ -3174,7 +3088,6 @@ function calendar_add_icalendar_event($event, $courseid, $subscriptionid, $timez
* @return string A log of the import progress, including errors
*/
function calendar_process_subscription_row($subscriptionid, $pollinterval, $action) {
-
// Fetch the subscription from the database making sure it exists.
$sub = calendar_get_subscription($subscriptionid);
@@ -3189,13 +3102,12 @@ function calendar_process_subscription_row($subscriptionid, $pollinterval, $acti
calendar_update_subscription($sub);
// Update the events.
- return "".get_string('subscriptionupdated', 'calendar', $sub->name)."
" . calendar_update_subscription_events($subscriptionid);
-
+ return "" . get_string('subscriptionupdated', 'calendar', $sub->name) . "
" .
+ calendar_update_subscription_events($subscriptionid);
case CALENDAR_SUBSCRIPTION_REMOVE:
calendar_delete_subscription($subscriptionid);
return get_string('subscriptionremoved', 'calendar', $sub->name);
break;
-
default:
break;
}
@@ -3213,10 +3125,11 @@ function calendar_delete_subscription($subscription) {
if (!is_object($subscription)) {
$subscription = $DB->get_record('event_subscriptions', array('id' => $subscription), '*', MUST_EXIST);
}
+
// Delete subscription and related events.
$DB->delete_records('event', array('subscriptionid' => $subscription->id));
$DB->delete_records('event_subscriptions', array('id' => $subscription->id));
- cache_helper::invalidate_by_definition('core', 'calendar_subscriptions', array(), array($subscription->id));
+ \cache_helper::invalidate_by_definition('core', 'calendar_subscriptions', array(), array($subscription->id));
// Trigger event, calendar subscription deleted.
$eventparams = array('objectid' => $subscription->id,
@@ -3226,47 +3139,51 @@ function calendar_delete_subscription($subscription) {
$event = \core\event\calendar_subscription_deleted::create($eventparams);
$event->trigger();
}
+
/**
* From a URL, fetch the calendar and return an iCalendar object.
*
* @param string $url The iCalendar URL
- * @return stdClass The iCalendar object
+ * @return iCalendar The iCalendar object
*/
function calendar_get_icalendar($url) {
global $CFG;
- require_once($CFG->libdir.'/filelib.php');
+ require_once($CFG->libdir . '/filelib.php');
- $curl = new curl();
+ $curl = new \curl();
$curl->setopt(array('CURLOPT_FOLLOWLOCATION' => 1, 'CURLOPT_MAXREDIRS' => 5));
$calendar = $curl->get($url);
+
// Http code validation should actually be the job of curl class.
if (!$calendar || $curl->info['http_code'] != 200 || !empty($curl->errorno)) {
- throw new moodle_exception('errorinvalidicalurl', 'calendar');
+ throw new \moodle_exception('errorinvalidicalurl', 'calendar');
}
- $ical = new iCalendar();
+ $ical = new \iCalendar();
$ical->unserialize($calendar);
+
return $ical;
}
/**
* Import events from an iCalendar object into a course calendar.
*
- * @param stdClass $ical The iCalendar object.
+ * @param iCalendar $ical The iCalendar object.
* @param int $courseid The course ID for the calendar.
* @param int $subscriptionid The subscription ID.
* @return string A log of the import progress, including errors.
*/
function calendar_import_icalendar_events($ical, $courseid, $subscriptionid = null) {
global $DB;
+
$return = '';
$eventcount = 0;
$updatecount = 0;
// Large calendars take a while...
if (!CLI_SCRIPT) {
- core_php_time_limit::raise(300);
+ \core_php_time_limit::raise(300);
}
// Mark all events in a subscription with a zero timestamp.
@@ -3274,36 +3191,45 @@ function calendar_import_icalendar_events($ical, $courseid, $subscriptionid = nu
$sql = "UPDATE {event} SET timemodified = :time WHERE subscriptionid = :id";
$DB->execute($sql, array('time' => 0, 'id' => $subscriptionid));
}
+
// Grab the timezone from the iCalendar file to be used later.
if (isset($ical->properties['X-WR-TIMEZONE'][0]->value)) {
$timezone = $ical->properties['X-WR-TIMEZONE'][0]->value;
} else {
$timezone = 'UTC';
}
+
+ $return = '';
foreach ($ical->components['VEVENT'] as $event) {
$res = calendar_add_icalendar_event($event, $courseid, $subscriptionid, $timezone);
switch ($res) {
- case CALENDAR_IMPORT_EVENT_UPDATED:
- $updatecount++;
- break;
- case CALENDAR_IMPORT_EVENT_INSERTED:
- $eventcount++;
- break;
- case 0:
- $return .= ''.get_string('erroraddingevent', 'calendar').': '.(empty($event->properties['SUMMARY'])?'('.get_string('notitle', 'calendar').')':$event->properties['SUMMARY'][0]->value)."
\n";
- break;
+ case CALENDAR_IMPORT_EVENT_UPDATED:
+ $updatecount++;
+ break;
+ case CALENDAR_IMPORT_EVENT_INSERTED:
+ $eventcount++;
+ break;
+ case 0:
+ $return .= '' . get_string('erroraddingevent', 'calendar') . ': ';
+ if (empty($event->properties['SUMMARY'])) {
+ $return .= '(' . get_string('notitle', 'calendar') . ')';
+ } else {
+ $return .= $event->properties['SUMMARY'][0]->value;
+ }
+ $return .= "
\n";
+ break;
}
}
- $return .= " ".get_string('eventsimported', 'calendar', $eventcount)."
";
- $return .= " ".get_string('eventsupdated', 'calendar', $updatecount)."
";
+
+ $return .= "" . get_string('eventsimported', 'calendar', $eventcount) . "
";
+ $return .= "" . get_string('eventsupdated', 'calendar', $updatecount) . "
";
// Delete remaining zero-marked events since they're not in remote calendar.
if (!empty($subscriptionid)) {
$deletecount = $DB->count_records('event', array('timemodified' => 0, 'subscriptionid' => $subscriptionid));
if (!empty($deletecount)) {
- $sql = "DELETE FROM {event} WHERE timemodified = :time AND subscriptionid = :id";
- $DB->execute($sql, array('time' => 0, 'id' => $subscriptionid));
- $return .= " ".get_string('eventsdeleted', 'calendar').": {$deletecount}
\n";
+ $DB->delete_records('event', array('timemodified' => 0, 'subscriptionid' => $subscriptionid));
+ $return .= " " . get_string('eventsdeleted', 'calendar') . ": {$deletecount}
\n";
}
}
@@ -3317,17 +3243,19 @@ function calendar_import_icalendar_events($ical, $courseid, $subscriptionid = nu
* @return string A log of the import progress, including errors.
*/
function calendar_update_subscription_events($subscriptionid) {
- global $DB;
-
$sub = calendar_get_subscription($subscriptionid);
- // Don't update a file subscription. TODO: Update from a new uploaded file.
+
+ // Don't update a file subscription.
if (empty($sub->url)) {
return 'File subscription not updated.';
}
+
$ical = calendar_get_icalendar($sub->url);
$return = calendar_import_icalendar_events($ical, $sub->courseid, $subscriptionid);
$sub->lastupdated = time();
+
calendar_update_subscription($sub);
+
return $return;
}
@@ -3345,19 +3273,21 @@ function calendar_update_subscription($subscription) {
$subscription = (object)$subscription;
}
if (empty($subscription->id) || !$DB->record_exists('event_subscriptions', array('id' => $subscription->id))) {
- throw new coding_exception('Cannot update a subscription without a valid id');
+ throw new \coding_exception('Cannot update a subscription without a valid id');
}
$DB->update_record('event_subscriptions', $subscription);
+
// Update cache.
- $cache = cache::make('core', 'calendar_subscriptions');
+ $cache = \cache::make('core', 'calendar_subscriptions');
$cache->set($subscription->id, $subscription);
+
// Trigger event, calendar subscription updated.
$eventparams = array('userid' => $subscription->userid,
'objectid' => $subscription->id,
'context' => calendar_get_calendar_context($subscription),
'other' => array('eventtype' => $subscription->eventtype, 'courseid' => $subscription->courseid)
- );
+ );
$event = \core\event\calendar_subscription_updated::create($eventparams);
$event->trigger();
}
@@ -3369,8 +3299,6 @@ function calendar_update_subscription($subscription) {
* @return bool true if current user can edit the subscription else false
*/
function calendar_can_edit_subscription($subscriptionorid) {
- global $DB;
-
if (is_array($subscriptionorid)) {
$subscription = (object)$subscriptionorid;
} else if (is_object($subscriptionorid)) {
@@ -3378,9 +3306,11 @@ function calendar_can_edit_subscription($subscriptionorid) {
} else {
$subscription = calendar_get_subscription($subscriptionorid);
}
- $allowed = new stdClass;
+
+ $allowed = new \stdClass;
$courseid = $subscription->courseid;
$groupid = $subscription->groupid;
+
calendar_get_allowed_types($allowed, $courseid);
switch ($subscription->eventtype) {
case 'user':
@@ -3404,37 +3334,6 @@ function calendar_can_edit_subscription($subscriptionorid) {
}
}
-/**
- * Update calendar subscriptions.
- *
- * @return bool
- */
-function calendar_cron() {
- global $CFG, $DB;
-
- // In order to execute this we need bennu.
- require_once($CFG->libdir.'/bennu/bennu.inc.php');
-
- mtrace('Updating calendar subscriptions:');
- cron_trace_time_and_memory();
-
- $time = time();
- $subscriptions = $DB->get_records_sql('SELECT * FROM {event_subscriptions} WHERE pollinterval > 0 AND lastupdated + pollinterval < ?', array($time));
- foreach ($subscriptions as $sub) {
- mtrace("Updating calendar subscription {$sub->name} in course {$sub->courseid}");
- try {
- $log = calendar_update_subscription_events($sub->id);
- mtrace(trim(strip_tags($log)));
- } catch (moodle_exception $ex) {
- mtrace('Error updating calendar subscription: ' . $ex->getMessage());
- }
- }
-
- mtrace('Finished updating calendar subscriptions.');
-
- return true;
-}
-
/**
* Helper function to determine the context of a calendar subscription.
* Subscriptions can be created in two contexts COURSE, or USER.
@@ -3443,14 +3342,13 @@ function calendar_cron() {
* @return context instance
*/
function calendar_get_calendar_context($subscription) {
-
// Determine context based on calendar type.
if ($subscription->eventtype === 'site') {
- $context = context_course::instance(SITEID);
+ $context = \context_course::instance(SITEID);
} else if ($subscription->eventtype === 'group' || $subscription->eventtype === 'course') {
- $context = context_course::instance($subscription->courseid);
+ $context = \context_course::instance($subscription->courseid);
} else {
- $context = context_user::instance($subscription->userid);
+ $context = \context_user::instance($subscription->userid);
}
return $context;
}
diff --git a/calendar/renderer.php b/calendar/renderer.php
index c68ca73608b56..014262c15a571 100644
--- a/calendar/renderer.php
+++ b/calendar/renderer.php
@@ -64,7 +64,8 @@ public function complete_layout() {
public function fake_block_filters($courseid, $day, $month, $year, $view, $courses) {
$returnurl = $this->page->url;
$returnurl->param('course', $courseid);
- return html_writer::tag('div', calendar_filter_controls($returnurl), array('class'=>'calendar_filters filters'));
+ return html_writer::tag('div', calendar_filter_controls($returnurl),
+ array('class' => 'calendar_filters filters'));
}
/**
@@ -92,13 +93,16 @@ public function fake_block_threemonths(calendar_information $calendar) {
$nextmonthtime['hour'], $nextmonthtime['minute']);
$content = html_writer::start_tag('div', array('class' => 'minicalendarblock'));
- $content .= calendar_get_mini($calendar->courses, $calendar->groups, $calendar->users, false, false, 'display', $calendar->courseid, $prevmonthtime);
+ $content .= calendar_get_mini($calendar->courses, $calendar->groups, $calendar->users,
+ false, false, 'display', $calendar->courseid, $prevmonthtime);
$content .= html_writer::end_tag('div');
$content .= html_writer::start_tag('div', array('class' => 'minicalendarblock'));
- $content .= calendar_get_mini($calendar->courses, $calendar->groups, $calendar->users, false, false, 'display', $calendar->courseid, $calendar->time);
+ $content .= calendar_get_mini($calendar->courses, $calendar->groups, $calendar->users,
+ false, false, 'display', $calendar->courseid, $calendar->time);
$content .= html_writer::end_tag('div');
$content .= html_writer::start_tag('div', array('class' => 'minicalendarblock'));
- $content .= calendar_get_mini($calendar->courses, $calendar->groups, $calendar->users, false, false, 'display', $calendar->courseid, $nextmonthtime);
+ $content .= calendar_get_mini($calendar->courses, $calendar->groups, $calendar->users,
+ false, false, 'display', $calendar->courseid, $nextmonthtime);
$content .= html_writer::end_tag('div');
return $content;
}
@@ -164,7 +168,8 @@ public function show_day(calendar_information $calendar, moodle_url $returnurl =
$returnurl = $this->page->url;
}
- $events = calendar_get_upcoming($calendar->courses, $calendar->groups, $calendar->users, 1, 100, $calendar->timestamp_today());
+ $events = calendar_get_upcoming($calendar->courses, $calendar->groups, $calendar->users,
+ 1, 100, $calendar->timestamp_today());
$output = html_writer::start_tag('div', array('class'=>'header'));
$output .= $this->course_filter_selector($returnurl, get_string('dayviewfor', 'calendar'));
@@ -173,7 +178,8 @@ public function show_day(calendar_information $calendar, moodle_url $returnurl =
}
$output .= html_writer::end_tag('div');
// Controls
- $output .= html_writer::tag('div', calendar_top_controls('day', array('id' => $calendar->courseid, 'time' => $calendar->time)), array('class'=>'controls'));
+ $output .= html_writer::tag('div', calendar_top_controls('day', array('id' => $calendar->courseid,
+ 'time' => $calendar->time)), array('class' => 'controls'));
if (empty($events)) {
// There is nothing to display today.
@@ -186,7 +192,8 @@ public function show_day(calendar_information $calendar, moodle_url $returnurl =
$event = new calendar_event($event);
$event->calendarcourseid = $calendar->courseid;
if ($event->timestart >= $calendar->timestamp_today() && $event->timestart <= $calendar->timestamp_tomorrow()-1) { // Print it now
- $event->time = calendar_format_event_time($event, time(), null, false, $calendar->timestamp_today());
+ $event->time = calendar_format_event_time($event, time(), null, false,
+ $calendar->timestamp_today());
$output .= $this->event($event);
} else { // Save this for later
$underway[] = $event;
@@ -198,7 +205,8 @@ public function show_day(calendar_information $calendar, moodle_url $returnurl =
$output .= html_writer::span(get_string('spanningevents', 'calendar'),
'calendar-information calendar-span-multiple-days');
foreach ($underway as $event) {
- $event->time = calendar_format_event_time($event, time(), null, false, $calendar->timestamp_today());
+ $event->time = calendar_format_event_time($event, time(), null, false,
+ $calendar->timestamp_today());
$output .= $this->event($event);
}
}
@@ -363,7 +371,8 @@ public function show_month_detailed(calendar_information $calendar, moodle_url $
}
// Get events from database
- $events = calendar_get_events($display->tstart, $display->tend, $calendar->users, $calendar->groups, $calendar->courses);
+ $events = \core_calendar\local\api::get_legacy_events($display->tstart, $display->tend, $calendar->users, $calendar->groups,
+ $calendar->courses);
if (!empty($events)) {
foreach($events as $eventid => $event) {
$event = new calendar_event($event);
@@ -377,7 +386,8 @@ public function show_month_detailed(calendar_information $calendar, moodle_url $
}
// Extract information: events vs. time
- calendar_events_by_day($events, $date['mon'], $date['year'], $eventsbyday, $durationbyday, $typesbyday, $calendar->courses);
+ calendar_events_by_day($events, $date['mon'], $date['year'], $eventsbyday, $durationbyday,
+ $typesbyday, $calendar->courses);
$output = html_writer::start_tag('div', array('class'=>'header'));
$output .= $this->course_filter_selector($returnurl, get_string('detailedmonthviewfor', 'calendar'));
@@ -386,7 +396,8 @@ public function show_month_detailed(calendar_information $calendar, moodle_url $
}
$output .= html_writer::end_tag('div', array('class'=>'header'));
// Controls
- $output .= html_writer::tag('div', calendar_top_controls('month', array('id' => $calendar->courseid, 'time' => $calendar->time)), array('class' => 'controls'));
+ $output .= html_writer::tag('div', calendar_top_controls('month', array('id' => $calendar->courseid,
+ 'time' => $calendar->time)), array('class' => 'controls'));
$table = new html_table();
$table->attributes = array('class'=>'calendarmonth calendartable');
@@ -432,7 +443,8 @@ public function show_month_detailed(calendar_information $calendar, moodle_url $
// Reset vars
$cell = new html_table_cell();
- $dayhref = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view' => 'day', 'course' => $calendar->courseid)), 0, 0, 0, $daytime);
+ $dayhref = calendar_get_link_href(new moodle_url(CALENDAR_URL . 'view.php',
+ array('view' => 'day', 'course' => $calendar->courseid)), 0, 0, 0, $daytime);
$cellclasses = array();
@@ -527,7 +539,8 @@ public function show_upcoming_events(calendar_information $calendar, $futuredays
$returnurl = $this->page->url;
}
- $events = calendar_get_upcoming($calendar->courses, $calendar->groups, $calendar->users, $futuredays, $maxevents);
+ $events = calendar_get_upcoming($calendar->courses, $calendar->groups, $calendar->users,
+ $futuredays, $maxevents);
$output = html_writer::start_tag('div', array('class'=>'header'));
$output .= $this->course_filter_selector($returnurl, get_string('upcomingeventsfor', 'calendar'));
@@ -539,8 +552,7 @@ public function show_upcoming_events(calendar_information $calendar, $futuredays
if ($events) {
$output .= html_writer::start_tag('div', array('class' => 'eventlist'));
foreach ($events as $event) {
- // Convert to calendar_event object so that we transform description
- // accordingly
+ // Convert to calendar_event object so that we transform description accordingly.
$event = new calendar_event($event);
$event->calendarcourseid = $calendar->courseid;
$output .= $this->event($event);
diff --git a/calendar/set.php b/calendar/set.php
index fab8aa54c02f1..c69de934a1a03 100644
--- a/calendar/set.php
+++ b/calendar/set.php
@@ -1,43 +1,26 @@
.
-/////////////////////////////////////////////////////////////////////////////
-// //
-// NOTICE OF COPYRIGHT //
-// //
-// Moodle - Calendar extension //
-// //
-// Copyright (C) 2003-2004 Greek School Network www.sch.gr //
-// //
-// Designed by: //
-// Avgoustos Tsinakos (tsinakos@teikav.edu.gr) //
-// Jon Papaioannou (pj@moodle.org) //
-// //
-// Programming and development: //
-// Jon Papaioannou (pj@moodle.org) //
-// //
-// For bugs, suggestions, etc contact: //
-// Jon Papaioannou (pj@moodle.org) //
-// //
-// The current module was developed at the University of Macedonia //
-// (www.uom.gr) under the funding of the Greek School Network (www.sch.gr) //
-// The aim of this project is to provide additional and improved //
-// functionality to the Asynchronous Distance Education service that the //
-// Greek School Network deploys. //
-// //
-// 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: //
-// //
-// http://www.gnu.org/copyleft/gpl.html //
-// //
-/////////////////////////////////////////////////////////////////////////////
-
+/**
+ * Sets the events filter for the calendar view.
+ *
+ * @package core_calendar
+ * @copyright 2003 Jon Papaioannou (pj@moodle.org)
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
require_once('../config.php');
require_once($CFG->dirroot.'/calendar/lib.php');
diff --git a/calendar/tests/action_event_test.php b/calendar/tests/action_event_test.php
new file mode 100644
index 0000000000000..c655f84e01ef2
--- /dev/null
+++ b/calendar/tests/action_event_test.php
@@ -0,0 +1,188 @@
+.
+
+/**
+ * Action event tests.
+ *
+ * @package core_calendar
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+use core_calendar\local\event\entities\action_event;
+use core_calendar\local\event\value_objects\action;
+use core_calendar\local\event\value_objects\event_description;
+use core_calendar\local\event\value_objects\event_times;
+use core_calendar\local\event\entities\event_collection_interface;
+use core_calendar\local\event\entities\event_interface;
+
+/**
+ * Action event testcase.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_action_event_testcase extends advanced_testcase {
+ /**
+ * Test event class getters.
+ *
+ * @dataProvider getters_testcases()
+ * @param array $constructorparams Associative array of constructor parameters.
+ */
+ public function test_getters($constructorparams) {
+ $event = new action_event(
+ $constructorparams['event'],
+ $constructorparams['action']
+ );
+
+ foreach ($constructorparams as $name => $value) {
+ if ($name !== 'event') {
+ $this->assertEquals($event->{'get_' . $name}(), $value);
+ }
+ }
+ }
+
+ /**
+ * Test cases for getters test.
+ */
+ public function getters_testcases() {
+ return [
+ 'Dataset 1' => [
+ 'constructorparams' => [
+ 'event' => new core_calendar_action_event_test_event(),
+ 'action' => new action(
+ 'action 1',
+ new moodle_url('http://example.com'),
+ 2,
+ true
+ )
+ ]
+ ],
+ 'Dataset 2' => [
+ 'constructorparams' => [
+ 'event' => new core_calendar_action_event_test_event(),
+ 'action' => new action(
+ 'action 2',
+ new moodle_url('http://example.com'),
+ 5,
+ false
+ )
+ ]
+ ],
+ ];
+ }
+}
+
+/**
+ * Test event.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_action_event_test_event implements event_interface {
+
+ public function get_id() {
+ return 1729;
+ }
+
+ public function get_name() {
+ return 'Jeff';
+ }
+
+ public function get_description() {
+ return new event_description('asdf', 1);
+ }
+
+ public function get_course() {
+ return new \stdClass();
+ }
+
+ public function get_course_module() {
+ return new \stdClass();
+ }
+
+ public function get_group() {
+ return new \stdClass();
+ }
+
+ public function get_user() {
+ return new \stdClass();
+ }
+
+ public function get_type() {
+ return 'asdf';
+ }
+
+ public function get_times() {
+ return new event_times(
+ (new \DateTimeImmutable())->setTimestamp('-2461276800'),
+ (new \DateTimeImmutable())->setTimestamp('115776000'),
+ (new \DateTimeImmutable())->setTimestamp('115776000'),
+ (new \DateTimeImmutable())->setTimestamp(time())
+ );
+ }
+
+ public function get_repeats() {
+ return new core_calendar_action_event_test_event_collection();
+ }
+
+ public function get_subscription() {
+ return new \stdClass();
+ }
+
+ public function is_visible() {
+ return true;
+ }
+}
+
+/**
+ * Test event collection.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_action_event_test_event_collection implements event_collection_interface {
+ /**
+ * @var array
+ */
+ protected $events;
+
+ /**
+ * core_calendar_action_event_test_event_collection constructor.
+ */
+ public function __construct() {
+ $this->events = [
+ 'not really an event hahaha',
+ 'also not really. gottem.'
+ ];
+ }
+
+ public function get_id() {
+ return 1729;
+ }
+
+ public function get_num() {
+ return 2;
+ }
+
+ public function getIterator() {
+ foreach ($this->events as $event) {
+ yield $event;
+ }
+ }
+}
diff --git a/calendar/tests/action_factory_test.php b/calendar/tests/action_factory_test.php
new file mode 100644
index 0000000000000..d58a4775b94b6
--- /dev/null
+++ b/calendar/tests/action_factory_test.php
@@ -0,0 +1,51 @@
+.
+
+/**
+ * Action factory test.
+ *
+ * @package core_calendar
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+use core_calendar\action_factory;
+use core_calendar\local\event\entities\action_interface;
+
+/**
+ * Action factory testcase.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_action_factory_test extends advanced_testcase {
+ /**
+ * Test action factory.
+ */
+ public function test_action_factory() {
+ $factory = new action_factory();
+ $instance = $factory->create_instance(
+ 'test',
+ new \moodle_url('http://example.com'),
+ 1729,
+ true
+ );
+
+ $this->assertInstanceOf(action_interface::class, $instance);
+ }
+}
diff --git a/calendar/tests/action_test.php b/calendar/tests/action_test.php
new file mode 100644
index 0000000000000..cc4dd6a3ccdd0
--- /dev/null
+++ b/calendar/tests/action_test.php
@@ -0,0 +1,82 @@
+.
+
+/**
+ * Action tests.
+ *
+ * @package core_calendar
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+use core_calendar\local\event\value_objects\action;
+
+/**
+ * Action testcase.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_action_testcase extends advanced_testcase {
+ /**
+ * Test action class getters.
+ *
+ * @dataProvider getters_testcases()
+ * @param array $constructorparams Associative array of constructor parameters.
+ */
+ public function test_getters($constructorparams) {
+ $action = new action(
+ $constructorparams['name'],
+ $constructorparams['url'],
+ $constructorparams['item_count'],
+ $constructorparams['actionable']
+ );
+
+ foreach ($constructorparams as $name => $value) {
+ if ($name == 'actionable') {
+ $this->assertEquals($action->is_actionable(), $value);
+ } else {
+ $this->assertEquals($action->{'get_' . $name}(), $value);
+ }
+ }
+ }
+
+ /**
+ * Test cases for getters test.
+ */
+ public function getters_testcases() {
+ return [
+ 'Dataset 1' => [
+ 'constructorparams' => [
+ 'name' => 'Hello',
+ 'url' => new moodle_url('http://example.com'),
+ 'item_count' => 1,
+ 'actionable' => true
+ ]
+ ],
+ 'Dataset 2' => [
+ 'constructorparams' => [
+ 'name' => 'Goodbye',
+ 'url' => new moodle_url('http://example.com'),
+ 'item_count' => 2,
+ 'actionable' => false
+ ]
+ ]
+ ];
+ }
+}
diff --git a/calendar/tests/behat/calendar.feature b/calendar/tests/behat/calendar.feature
index c026cfe4360f6..81689dbef7ca8 100644
--- a/calendar/tests/behat/calendar.feature
+++ b/calendar/tests/behat/calendar.feature
@@ -24,9 +24,7 @@ Feature: Perform basic calendar functionality
| user | group |
| student1 | G1 |
When I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add the "Calendar" block
Scenario: Create a site event
@@ -36,8 +34,7 @@ Feature: Perform basic calendar functionality
| Description | Come join this awesome event, sucka! |
And I log out
And I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "This month"
And I should see "Really awesome event!"
And I log out
@@ -52,8 +49,7 @@ Feature: Perform basic calendar functionality
| Description | Come join this awesome event, sucka! |
And I log out
And I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "This month"
And I should see "Really awesome event!"
And I log out
@@ -69,8 +65,7 @@ Feature: Perform basic calendar functionality
| Description | Come join this awesome event |
And I log out
And I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "This month"
And I follow "Really awesome event!"
And "Group 1" "text" should exist in the ".eventlist" "css_element"
@@ -86,8 +81,7 @@ Feature: Perform basic calendar functionality
| Description | Come join this awesome event, sucka! |
And I log out
And I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "This month"
And I should not see "Really awesome event!"
diff --git a/calendar/tests/behat/calendar_lookahead.feature b/calendar/tests/behat/calendar_lookahead.feature
index 9c6c046fd0dbe..819d03e2b30f5 100644
--- a/calendar/tests/behat/calendar_lookahead.feature
+++ b/calendar/tests/behat/calendar_lookahead.feature
@@ -17,8 +17,7 @@ Feature: Limit displayed upcoming events
And I log in as "teacher1"
Scenario: I view calendar details for a future event
- Given I follow "C1"
- And I turn editing mode on
+ Given I am on "Course 1" course homepage with editing mode on
And I add the "Calendar" block
And I add the "Upcoming events" block
And I follow "This month"
@@ -36,6 +35,5 @@ Feature: Limit displayed upcoming events
| Upcoming events look-ahead | 3 months |
And I press "Save changes"
And I wait to be redirected
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I should see "Two months away event"
diff --git a/calendar/tests/calendartype_test.php b/calendar/tests/calendartype_test.php
index c097cfd0759c9..5d9af035811d4 100644
--- a/calendar/tests/calendartype_test.php
+++ b/calendar/tests/calendartype_test.php
@@ -33,9 +33,6 @@
require_once($CFG->libdir . '/form/dateselector.php');
require_once($CFG->libdir . '/form/datetimeselector.php');
-// Used to test the calendar/lib.php functions.
-require_once($CFG->dirroot . '/calendar/lib.php');
-
// Used to test the user datetime profile field.
require_once($CFG->dirroot . '/user/profile/lib.php');
require_once($CFG->dirroot . '/user/profile/definelib.php');
@@ -108,8 +105,6 @@ public function test_calendar_type_core_functions() {
* different calendar types.
*/
public function test_calendar_type_dateselector_elements() {
- global $CFG;
-
// We want to reset the test data after this run.
$this->resetAfterTest();
diff --git a/calendar/tests/container_test.php b/calendar/tests/container_test.php
new file mode 100644
index 0000000000000..8f4f5a7f47f9f
--- /dev/null
+++ b/calendar/tests/container_test.php
@@ -0,0 +1,322 @@
+.
+
+/**
+ * Event container tests.
+ *
+ * @package core_calendar
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+require_once($CFG->dirroot . '/calendar/lib.php');
+
+use core_calendar\local\event\entities\action_event;
+use core_calendar\local\event\entities\event;
+use core_calendar\local\event\entities\event_interface;
+use core_calendar\local\event\factories\event_factory;
+use core_calendar\local\event\factories\event_factory_interface;
+use core_calendar\local\event\mappers\event_mapper;
+use core_calendar\local\event\mappers\event_mapper_interface;
+
+/**
+ * Core container testcase.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_container_testcase extends advanced_testcase {
+
+ /**
+ * Test setup.
+ */
+ public function setUp() {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ }
+
+ /**
+ * Test getting the event factory.
+ */
+ public function test_get_event_factory() {
+ $factory = \core_calendar\local\event\container::get_event_factory();
+
+ // Test that the container is returning the right type.
+ $this->assertInstanceOf(event_factory_interface::class, $factory);
+ // Test that the container is returning the right implementation.
+ $this->assertInstanceOf(event_factory::class, $factory);
+
+ // Test that getting the factory a second time returns the same instance.
+ $factory2 = \core_calendar\local\event\container::get_event_factory();
+ $this->assertTrue($factory === $factory2);
+ }
+
+ /**
+ * Test that the event factory correctly creates instances of events.
+ *
+ * @dataProvider get_event_factory_testcases()
+ * @param \stdClass $dbrow Row from the "database".
+ */
+ public function test_event_factory_create_instance($dbrow) {
+ $legacyevent = $this->create_event($dbrow);
+ $factory = \core_calendar\local\event\container::get_event_factory();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance = $generator->create_instance(['course' => $course->id]);
+
+ // Set some of the fake dbrow properties to match real data in the DB
+ // this is necessary as the factory hides things that modinfo doesn't
+ // know about.
+ $dbrow->id = $legacyevent->id;
+ $dbrow->courseid = $course->id;
+ $dbrow->instance = $moduleinstance->id;
+ $dbrow->modulename = 'assign';
+ $event = $factory->create_instance($dbrow);
+
+ // Test that the factory is returning the right type.
+ $this->assertInstanceOf(event_interface::class, $event);
+ // Test that the factory is returning the right implementation.
+ $this->assertTrue($event instanceof event || $event instanceof action_event);
+
+ // Test that the event created has the correct properties.
+ $this->assertEquals($legacyevent->id, $event->get_id());
+ $this->assertEquals($dbrow->description, $event->get_description()->get_value());
+ $this->assertEquals($dbrow->format, $event->get_description()->get_format());
+ $this->assertEquals($dbrow->courseid, $event->get_course()->get_id());
+
+ if ($dbrow->groupid == 0) {
+ $this->assertNull($event->get_group());
+ } else {
+ $this->assertEquals($dbrow->groupid, $event->get_group()->get_id());
+ }
+
+ $this->assertEquals($dbrow->userid, $event->get_user()->get_id());
+ $this->assertEquals($legacyevent->id, $event->get_repeats()->get_id());
+ $this->assertEquals($dbrow->modulename, $event->get_course_module()->get('modname'));
+ $this->assertEquals($dbrow->instance, $event->get_course_module()->get('instance'));
+ $this->assertEquals($dbrow->timestart, $event->get_times()->get_start_time()->getTimestamp());
+ $this->assertEquals($dbrow->timemodified, $event->get_times()->get_modified_time()->getTimestamp());
+ $this->assertEquals($dbrow->timesort, $event->get_times()->get_sort_time()->getTimestamp());
+
+ if ($dbrow->visible == 1) {
+ $this->assertTrue($event->is_visible());
+ } else {
+ $this->assertFalse($event->is_visible());
+ }
+
+ if (!$dbrow->subscriptionid) {
+ $this->assertNull($event->get_subscription());
+ } else {
+ $this->assertEquals($event->get_subscription()->get_id());
+ }
+ }
+
+ /**
+ * Test that the event factory deals with invisible modules properly as admin.
+ *
+ * @dataProvider get_event_factory_testcases()
+ * @param \stdClass $dbrow Row from the "database".
+ */
+ public function test_event_factory_when_module_visibility_is_toggled_as_admin($dbrow) {
+ $legacyevent = $this->create_event($dbrow);
+ $factory = \core_calendar\local\event\container::get_event_factory();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance = $generator->create_instance(['course' => $course->id]);
+
+ $dbrow->id = $legacyevent->id;
+ $dbrow->courseid = $course->id;
+ $dbrow->instance = $moduleinstance->id;
+ $dbrow->modulename = 'assign';
+
+ set_coursemodule_visible($moduleinstance->cmid, 0);
+
+ $event = $factory->create_instance($dbrow);
+
+ // Test that the factory is returning an event as the admin can see hidden course modules.
+ $this->assertInstanceOf(event_interface::class, $event);
+ }
+
+ /**
+ * Test that the event factory deals with invisible modules properly as a guest.
+ *
+ * @dataProvider get_event_factory_testcases()
+ * @param \stdClass $dbrow Row from the "database".
+ */
+ public function test_event_factory_when_module_visibility_is_toggled_as_guest($dbrow) {
+ $legacyevent = $this->create_event($dbrow);
+ $factory = \core_calendar\local\event\container::get_event_factory();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance = $generator->create_instance(['course' => $course->id]);
+
+ $dbrow->id = $legacyevent->id;
+ $dbrow->courseid = $course->id;
+ $dbrow->instance = $moduleinstance->id;
+ $dbrow->modulename = 'assign';
+
+ set_coursemodule_visible($moduleinstance->cmid, 0);
+
+ // Set to a user who can not view hidden course modules.
+ $this->setGuestUser();
+
+ $event = $factory->create_instance($dbrow);
+
+ // Module is invisible to guest users so this should return null.
+ $this->assertNull($event);
+ }
+
+ /**
+ * Test that the event factory deals with completion related events properly.
+ */
+ public function test_event_factory_with_completion_related_event() {
+ global $CFG;
+
+ $CFG->enablecompletion = true;
+
+ // Create the course we will be using.
+ $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
+
+ // Add the assignment.
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $assign = $generator->create_instance(array('course' => $course->id), array('completion' => 1));
+
+ // Create a completion event.
+ $event = new \stdClass();
+ $event->name = 'An event';
+ $event->description = 'Event description';
+ $event->format = FORMAT_HTML;
+ $event->eventtype = \core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED;
+ $event->userid = 1;
+ $event->modulename = 'assign';
+ $event->instance = $assign->id;
+ $event->courseid = $course->id;
+ $event->groupid = 0;
+ $event->timestart = time();
+ $event->timesort = time();
+ $event->timemodified = time();
+ $event->timeduration = 0;
+ $event->subscriptionid = null;
+ $event->repeatid = 0;
+ $legacyevent = $this->create_event($event);
+
+ // Update the id of the event that was created.
+ $event->id = $legacyevent->id;
+
+ // Create the factory we are going to be testing the behaviour of.
+ $factory = \core_calendar\local\event\container::get_event_factory();
+
+ // Check that we get the correct instance.
+ $this->assertInstanceOf(event_interface::class, $factory->create_instance($event));
+
+ // Now, disable completion.
+ $CFG->enablecompletion = false;
+
+ // The result should now be null since we have disabled completion.
+ $this->assertNull($factory->create_instance($event));
+ }
+
+ /**
+ * Test getting the event mapper.
+ */
+ public function test_get_event_mapper() {
+ $mapper = \core_calendar\local\event\container::get_event_mapper();
+
+ $this->assertInstanceOf(event_mapper_interface::class, $mapper);
+ $this->assertInstanceOf(event_mapper::class, $mapper);
+
+ $mapper2 = \core_calendar\local\event\container::get_event_mapper();
+
+ $this->assertTrue($mapper === $mapper2);
+ }
+
+ /**
+ * Test cases for the get event factory test.
+ */
+ public function get_event_factory_testcases() {
+ return [
+ 'Data set 1' => [
+ 'dbrow' => (object)[
+ 'name' => 'Test event',
+ 'description' => 'Hello',
+ 'format' => 1,
+ 'courseid' => 1,
+ 'groupid' => 0,
+ 'userid' => 1,
+ 'repeatid' => 0,
+ 'modulename' => 'assign',
+ 'instance' => 2,
+ 'eventtype' => 'due',
+ 'timestart' => 1486396800,
+ 'timeduration' => 0,
+ 'timesort' => 1486396800,
+ 'visible' => 1,
+ 'timemodified' => 1485793098,
+ 'subscriptionid' => null
+ ]
+ ],
+
+ 'Data set 2' => [
+ 'dbrow' => (object)[
+ 'name' => 'Test event',
+ 'description' => 'Hello',
+ 'format' => 1,
+ 'courseid' => 1,
+ 'groupid' => 1,
+ 'userid' => 1,
+ 'repeatid' => 0,
+ 'modulename' => 'assign',
+ 'instance' => 2,
+ 'eventtype' => 'due',
+ 'timestart' => 1486396800,
+ 'timeduration' => 0,
+ 'timesort' => 1486396800,
+ 'visible' => 1,
+ 'timemodified' => 1485793098,
+ 'subscriptionid' => null
+ ]
+ ]
+ ];
+ }
+
+ /**
+ * Helper function to create calendar events using the old code.
+ *
+ * @param array $properties A list of calendar event properties to set
+ * @return calendar_event|bool
+ */
+ protected function create_event($properties = []) {
+ $record = new \stdClass();
+ $record->name = 'event name';
+ $record->eventtype = 'global';
+ $record->timestart = time();
+ $record->timeduration = 0;
+ $record->timesort = 0;
+ $record->type = 1;
+ $record->courseid = 0;
+
+ foreach ($properties as $name => $value) {
+ $record->$name = $value;
+ }
+
+ $event = new calendar_event($record);
+ return $event->create($record, false);
+ }
+}
diff --git a/calendar/tests/event_description_test.php b/calendar/tests/event_description_test.php
new file mode 100644
index 0000000000000..b7c0e40ea4a23
--- /dev/null
+++ b/calendar/tests/event_description_test.php
@@ -0,0 +1,71 @@
+.
+
+/**
+ * Event description tests.
+ *
+ * @package core_calendar
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+use core_calendar\local\event\value_objects\event_description;
+
+/**
+ * Action testcase.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_event_description_testcase extends advanced_testcase {
+ /**
+ * Test event description class getters.
+ *
+ * @dataProvider getters_testcases()
+ * @param array $constructorparams Associative array of constructor parameters.
+ */
+ public function test_getters($constructorparams) {
+ $eventdescription = new event_description(
+ $constructorparams['value'],
+ $constructorparams['format']
+ );
+ foreach ($constructorparams as $name => $value) {
+ $this->assertEquals($eventdescription->{'get_' . $name}(), $value);
+ }
+ }
+
+ /**
+ * Test cases for getters test.
+ */
+ public function getters_testcases() {
+ return [
+ 'Dataset 1' => [
+ 'constructorparams' => [
+ 'value' => 'Hello',
+ 'format' => 1
+ ]
+ ],
+ 'Dataset 2' => [
+ 'constructorparams' => [
+ 'value' => 'Goodbye',
+ 'format' => 2
+ ]
+ ]
+ ];
+ }
+}
diff --git a/calendar/tests/event_factory_test.php b/calendar/tests/event_factory_test.php
new file mode 100644
index 0000000000000..b2f3039f764ab
--- /dev/null
+++ b/calendar/tests/event_factory_test.php
@@ -0,0 +1,468 @@
+.
+
+/**
+ * Event factory test.
+ *
+ * @package core_calendar
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once($CFG->dirroot . '/calendar/lib.php');
+
+use core_calendar\local\event\factories\event_factory;
+use core_calendar\local\event\entities\event_interface;
+
+/**
+ * Event factory testcase.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_event_factory_testcase extends advanced_testcase {
+ /**
+ * Test event class getters.
+ *
+ * @dataProvider create_instance_testcases()
+ * @param \stdClass $dbrow Row from the event table.
+ * @param callable $actioncallbackapplier Action callback applier.
+ * @param callable $visibilitycallbackapplier Visibility callback applier.
+ * @param callable $bailoutcheck Early bail out check function.
+ * @param string $expectedclass Class the factory is expected to produce.
+ * @param mixed $expectedattributevalue Expected value of the modified attribute.
+ */
+ public function test_create_instance(
+ $dbrow,
+ callable $actioncallbackapplier,
+ callable $visibilitycallbackapplier,
+ callable $bailoutcheck,
+ $expectedclass,
+ $expectedattributevalue
+ ) {
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+ $event = $this->create_event();
+ $coursecache = [];
+ $modulecache = [];
+ $factory = new event_factory(
+ $actioncallbackapplier,
+ $visibilitycallbackapplier,
+ $bailoutcheck,
+ $coursecache,
+ $modulecache
+ );
+ $dbrow->id = $event->id;
+ $instance = $factory->create_instance($dbrow);
+
+ if ($expectedclass) {
+ $this->assertInstanceOf($expectedclass, $instance);
+ }
+
+ if (is_null($expectedclass)) {
+ $this->assertNull($instance);
+ }
+
+ if ($expectedattributevalue) {
+ $this->assertEquals($instance->testattribute, $expectedattributevalue);
+ }
+ }
+
+ /**
+ * Test invalid callback exception.
+ */
+ public function test_invalid_action_callback() {
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+ $event = $this->create_event();
+ $coursecache = [];
+ $modulecache = [];
+ $factory = new event_factory(
+ function () {
+ return 'hello';
+ },
+ function () {
+ return true;
+ },
+ function () {
+ return false;
+ },
+ $coursecache,
+ $modulecache
+ );
+
+ $this->expectException('\core_calendar\local\event\exceptions\invalid_callback_exception');
+ $factory->create_instance(
+ (object)[
+ 'id' => $event->id,
+ 'name' => 'test',
+ 'description' => 'Test description',
+ 'format' => 2,
+ 'courseid' => 1,
+ 'groupid' => 1,
+ 'userid' => 1,
+ 'repeatid' => 0,
+ 'modulename' => 'assign',
+ 'instance' => 1,
+ 'eventtype' => 'due',
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'timestart' => 123456789,
+ 'timeduration' => 12,
+ 'timemodified' => 123456789,
+ 'timesort' => 123456789,
+ 'visible' => 1,
+ 'subscriptionid' => 1
+ ]
+ );
+ }
+
+ /**
+ * Test invalid callback exception.
+ */
+ public function test_invalid_visibility_callback() {
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+ $event = $this->create_event();
+ $coursecache = [];
+ $modulecache = [];
+ $factory = new event_factory(
+ function ($event) {
+ return $event;
+ },
+ function () {
+ return 'asdf';
+ },
+ function () {
+ return false;
+ },
+ $coursecache,
+ $modulecache
+ );
+
+ $this->expectException('\core_calendar\local\event\exceptions\invalid_callback_exception');
+ $factory->create_instance(
+ (object)[
+ 'id' => $event->id,
+ 'name' => 'test',
+ 'description' => 'Test description',
+ 'format' => 2,
+ 'courseid' => 1,
+ 'groupid' => 1,
+ 'userid' => 1,
+ 'repeatid' => 0,
+ 'modulename' => 'assign',
+ 'instance' => 1,
+ 'eventtype' => 'due',
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'timestart' => 123456789,
+ 'timeduration' => 12,
+ 'timemodified' => 123456789,
+ 'timesort' => 123456789,
+ 'visible' => 1,
+ 'subscriptionid' => 1
+ ]
+ );
+ }
+
+ /**
+ * Test invalid callback exception.
+ */
+ public function test_invalid_bail_callback() {
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+ $event = $this->create_event();
+ $coursecache = [];
+ $modulecache = [];
+ $factory = new event_factory(
+ function ($event) {
+ return $event;
+ },
+ function () {
+ return true;
+ },
+ function () {
+ return 'asdf';
+ },
+ $coursecache,
+ $modulecache
+ );
+
+ $this->expectException('\core_calendar\local\event\exceptions\invalid_callback_exception');
+ $factory->create_instance(
+ (object)[
+ 'id' => $event->id,
+ 'name' => 'test',
+ 'description' => 'Test description',
+ 'format' => 2,
+ 'courseid' => 1,
+ 'groupid' => 1,
+ 'userid' => 1,
+ 'repeatid' => 0,
+ 'modulename' => 'assign',
+ 'instance' => 1,
+ 'eventtype' => 'due',
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'timestart' => 123456789,
+ 'timeduration' => 12,
+ 'timemodified' => 123456789,
+ 'timesort' => 123456789,
+ 'visible' => 1,
+ 'subscriptionid' => 1
+ ]
+ );
+ }
+
+ /**
+ * Test the factory's course cache.
+ */
+ public function test_course_cache() {
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+ $course = self::getDataGenerator()->create_course();
+ $event = $this->create_event(['courseid' => $course->id]);
+ $coursecache = [];
+ $modulecache = [];
+ $factory = new event_factory(
+ function ($event) {
+ return $event;
+ },
+ function () {
+ return true;
+ },
+ function () {
+ return false;
+ },
+ $coursecache,
+ $modulecache
+ );
+
+ $instance = $factory->create_instance(
+ (object)[
+ 'id' => $event->id,
+ 'name' => 'test',
+ 'description' => 'Test description',
+ 'format' => 2,
+ 'courseid' => $course->id,
+ 'groupid' => 1,
+ 'userid' => 1,
+ 'repeatid' => 0,
+ 'modulename' => 'assign',
+ 'instance' => 1,
+ 'eventtype' => 'due',
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'timestart' => 123456789,
+ 'timeduration' => 12,
+ 'timemodified' => 123456789,
+ 'timesort' => 123456789,
+ 'visible' => 1,
+ 'subscriptionid' => 1
+ ]
+ );
+
+ $instance->get_course()->get('fullname');
+ $this->assertArrayHasKey($course->id, $coursecache);
+ }
+
+ /**
+ * Test the factory's module cache.
+ */
+ public function test_module_cache() {
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+ $course = self::getDataGenerator()->create_course();
+ $event = $this->create_event(['courseid' => $course->id]);
+ $plugingenerator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $assigninstance = $plugingenerator->create_instance(['course' => $course->id]);
+
+ $coursecache = [];
+ $modulecache = [];
+ $factory = new event_factory(
+ function ($event) {
+ return $event;
+ },
+ function () {
+ return true;
+ },
+ function () {
+ return false;
+ },
+ $coursecache,
+ $modulecache
+ );
+
+ $instance = $factory->create_instance(
+ (object)[
+ 'id' => $event->id,
+ 'name' => 'test',
+ 'description' => 'Test description',
+ 'format' => 2,
+ 'courseid' => $course->id,
+ 'groupid' => 1,
+ 'userid' => 1,
+ 'repeatid' => 0,
+ 'modulename' => 'assign',
+ 'instance' => $assigninstance->id,
+ 'eventtype' => 'due',
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'timestart' => 123456789,
+ 'timeduration' => 12,
+ 'timemodified' => 123456789,
+ 'timesort' => 123456789,
+ 'visible' => 1,
+ 'subscriptionid' => 1
+ ]
+ );
+
+ $instance->get_course_module()->get('course');
+ $this->assertArrayHasKey('assign' . '_' . $assigninstance->id, $modulecache);
+ }
+
+ /**
+ * Testcases for the create instance test.
+ *
+ * @return array Array of testcases.
+ */
+ public function create_instance_testcases() {
+ return [
+ 'Sample event record with event exposed' => [
+ 'dbrow' => (object)[
+ 'name' => 'Test event',
+ 'description' => 'Hello',
+ 'format' => 1,
+ 'courseid' => 1,
+ 'groupid' => 1,
+ 'userid' => 1,
+ 'repeatid' => 0,
+ 'modulename' => 'Test module',
+ 'instance' => 1,
+ 'eventtype' => 'Due',
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'timestart' => 123456789,
+ 'timeduration' => 123456789,
+ 'timemodified' => 123456789,
+ 'timesort' => 123456789,
+ 'visible' => true,
+ 'subscriptionid' => 1
+ ],
+ 'actioncallbackapplier' => function(event_interface $event) {
+ $event->testattribute = 'Hello';
+ return $event;
+ },
+ 'visibilitycallbackapplier' => function(event_interface $event) {
+ return true;
+ },
+ 'bailoutcheck' => function() {
+ return false;
+ },
+ event_interface::class,
+ 'Hello'
+ ],
+ 'Sample event record with event hidden' => [
+ 'dbrow' => (object)[
+ 'name' => 'Test event',
+ 'description' => 'Hello',
+ 'format' => 1,
+ 'courseid' => 1,
+ 'groupid' => 1,
+ 'userid' => 1,
+ 'repeatid' => 0,
+ 'modulename' => 'Test module',
+ 'instance' => 1,
+ 'eventtype' => 'Due',
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'timestart' => 123456789,
+ 'timeduration' => 123456789,
+ 'timemodified' => 123456789,
+ 'timesort' => 123456789,
+ 'visible' => true,
+ 'subscriptionid' => 1
+ ],
+ 'actioncallbackapplier' => function(event_interface $event) {
+ $event->testattribute = 'Hello';
+ return $event;
+ },
+ 'visibilitycallbackapplier' => function(event_interface $event) {
+ return false;
+ },
+ 'bailoutcheck' => function() {
+ return false;
+ },
+ null,
+ null
+ ],
+ 'Sample event record with early bail' => [
+ 'dbrow' => (object)[
+ 'name' => 'Test event',
+ 'description' => 'Hello',
+ 'format' => 1,
+ 'courseid' => 1,
+ 'groupid' => 1,
+ 'userid' => 1,
+ 'repeatid' => 0,
+ 'modulename' => 'Test module',
+ 'instance' => 1,
+ 'eventtype' => 'Due',
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'timestart' => 123456789,
+ 'timeduration' => 123456789,
+ 'timemodified' => 123456789,
+ 'timesort' => 123456789,
+ 'visible' => true,
+ 'subscriptionid' => 1
+ ],
+ 'actioncallbackapplier' => function(event_interface $event) {
+ $event->testattribute = 'Hello';
+ return $event;
+ },
+ 'visibilitycallbackapplier' => function(event_interface $event) {
+ return true;
+ },
+ 'bailoutcheck' => function() {
+ return true;
+ },
+ null,
+ null
+ ]
+ ];
+ }
+
+ /**
+ * Helper function to create calendar events using the old code.
+ *
+ * @param array $properties A list of calendar event properties to set
+ * @return calendar_event
+ */
+ protected function create_event($properties = []) {
+ $record = new \stdClass();
+ $record->name = 'event name';
+ $record->eventtype = 'global';
+ $record->timestart = time();
+ $record->timeduration = 0;
+ $record->timesort = 0;
+ $record->type = 1;
+ $record->courseid = 0;
+
+ foreach ($properties as $name => $value) {
+ $record->$name = $value;
+ }
+
+ $event = new calendar_event($record);
+ return $event->create($record, false);
+ }
+}
diff --git a/calendar/tests/event_mapper_test.php b/calendar/tests/event_mapper_test.php
new file mode 100644
index 0000000000000..67738f4f19049
--- /dev/null
+++ b/calendar/tests/event_mapper_test.php
@@ -0,0 +1,434 @@
+.
+
+/**
+ * Event mapper test.
+ *
+ * @package core_calendar
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once($CFG->dirroot . '/calendar/lib.php');
+
+use core_calendar\local\event\mappers\event_mapper;
+use core_calendar\local\event\value_objects\action;
+use core_calendar\local\event\value_objects\event_description;
+use core_calendar\local\event\value_objects\event_times;
+use core_calendar\local\event\factories\action_factory_interface;
+use core_calendar\local\event\entities\event_collection_interface;
+use core_calendar\local\event\factories\event_factory_interface;
+use core_calendar\local\event\entities\event_interface;
+use core_calendar\local\event\entities\action_event_interface;
+use core_calendar\local\event\proxies\proxy_interface;
+
+/**
+ * Event mapper testcase.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_event_mapper_testcase extends advanced_testcase {
+ /**
+ * Test legacy event -> event.
+ */
+ public function test_from_legacy_event_to_event() {
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+ $legacyevent = $this->create_event();
+ $mapper = new event_mapper(
+ new event_mapper_test_event_factory()
+ );
+ $event = $mapper->from_legacy_event_to_event($legacyevent);
+ $this->assertInstanceOf(event_interface::class, $event);
+ }
+
+ /**
+ * Test event -> legacy event.
+ */
+ public function test_from_event_to_legacy_event() {
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+ $legacyevent = $this->create_event(['modname' => 'assign', 'instance' => 1]);
+ $event = new event_mapper_test_event($legacyevent);
+ $mapper = new event_mapper(
+ new event_mapper_test_event_factory()
+ );
+ $legacyevent = $mapper->from_event_to_legacy_event($event);
+ $this->assertInstanceOf(calendar_event::class, $legacyevent);
+ }
+
+ /**
+ * Test event -> stdClass.
+ */
+ public function test_from_event_to_stdclass() {
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+ $legacyevent = $this->create_event(['modname' => 'assign', 'instance' => 1]);
+ $event = new event_mapper_test_event($legacyevent);
+ $mapper = new event_mapper(
+ new event_mapper_test_event_factory()
+ );
+ $obj = $mapper->from_event_to_stdclass($event);
+ $this->assertInstanceOf(\stdClass::class, $obj);
+ $this->assertEquals($obj->name, $event->get_name());
+ $this->assertEquals($obj->eventtype, $event->get_type());
+ $this->assertEquals($obj->timestart, $event->get_times()->get_start_time()->getTimestamp());
+ }
+
+ /**
+ * Test event -> array.
+ */
+ public function test_from_event_to_assoc_array() {
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+ $legacyevent = $this->create_event(['modname' => 'assign', 'instance' => 1]);
+ $event = new event_mapper_test_event($legacyevent);
+ $mapper = new event_mapper(
+ new event_mapper_test_event_factory()
+ );
+ $arr = $mapper->from_event_to_assoc_array($event);
+ $this->assertTrue(is_array($arr));
+ $this->assertEquals($arr['name'], $event->get_name());
+ $this->assertEquals($arr['eventtype'], $event->get_type());
+ $this->assertEquals($arr['timestart'], $event->get_times()->get_start_time()->getTimestamp());
+ }
+
+ /**
+ * Test for action event -> legacy event.
+ */
+ public function test_from_action_event_to_legacy_event() {
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+ $legacyevent = $this->create_event(['modname' => 'assign', 'instance' => 1]);
+ $event = new event_mapper_test_action_event(
+ new event_mapper_test_event($legacyevent)
+ );
+ $mapper = new event_mapper(
+ new event_mapper_test_event_factory()
+ );
+ $legacyevent = $mapper->from_event_to_legacy_event($event);
+
+ $this->assertInstanceOf(calendar_event::class, $legacyevent);
+ $this->assertEquals($legacyevent->actionname, 'test action');
+ $this->assertInstanceOf(\moodle_url::class, $legacyevent->actionurl);
+ $this->assertEquals($legacyevent->actionnum, 1729);
+ $this->assertEquals($legacyevent->actionactionable, $event->get_action()->is_actionable());
+ }
+
+ /**
+ * Helper function to create calendar events using the old code.
+ *
+ * @param array $properties A list of calendar event properties to set
+ * @return calendar_event
+ */
+ protected function create_event($properties = []) {
+ $record = new \stdClass();
+ $record->name = 'event name';
+ $record->eventtype = 'global';
+ $record->timestart = time();
+ $record->timeduration = 0;
+ $record->timesort = 0;
+ $record->type = 1;
+ $record->courseid = 0;
+
+ foreach ($properties as $name => $value) {
+ $record->$name = $value;
+ }
+
+ $event = new calendar_event($record);
+ return $event->create($record, false);
+ }
+}
+
+/**
+ * A test event factory.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class event_mapper_test_event_factory implements event_factory_interface {
+
+ public function create_instance(\stdClass $dbrow) {
+ return new event_mapper_test_event();
+ }
+}
+
+/**
+ * A test action event
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class event_mapper_test_action_event implements action_event_interface {
+ /**
+ * @var event_interface $event The event to delegate to.
+ */
+ protected $event;
+
+ /**
+ * event_mapper_test_action_event constructor.
+ * @param event_interface $event
+ */
+ public function __construct(event_interface $event) {
+ $this->event = $event;
+ }
+
+ public function get_id() {
+ return $this->event->get_id();
+ }
+
+ public function get_name() {
+ return $this->event->get_name();
+ }
+
+ public function get_description() {
+ return $this->event->get_description();
+ }
+
+ public function get_course() {
+ return $this->event->get_course();
+ }
+
+ public function get_course_module() {
+ return $this->event->get_course_module();
+ }
+
+ public function get_group() {
+ return $this->event->get_group();
+ }
+
+ public function get_user() {
+ return $this->event->get_user();
+ }
+
+ public function get_type() {
+ return $this->event->get_type();
+ }
+
+ public function get_times() {
+ return $this->event->get_times();
+ }
+
+ public function get_repeats() {
+ return $this->event->get_repeats();
+ }
+
+ public function get_subscription() {
+ return $this->event->get_subscription();
+ }
+
+ public function is_visible() {
+ return $this->event->is_visible();
+ }
+
+ public function get_action() {
+ return new action(
+ 'test action',
+ new \moodle_url('http://example.com'),
+ 1729,
+ true
+ );
+ }
+}
+
+/**
+ * A test event.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class event_mapper_test_event implements event_interface {
+ /**
+ * @var proxy_interface $courseproxy Course proxy.
+ */
+ protected $courseproxy;
+
+ /**
+ * @var proxy_interface $cmproxy Course module proxy.
+ */
+ protected $cmproxy;
+
+ /**
+ * @var proxy_interface $groupproxy Group proxy.
+ */
+ protected $groupproxy;
+
+ /**
+ * @var proxy_interface $userproxy User proxy.
+ */
+ protected $userproxy;
+
+ /**
+ * @var proxy_interface $subscriptionproxy Subscription proxy.
+ */
+ protected $subscriptionproxy;
+
+ /**
+ * Constructor.
+ *
+ * @param calendar_event $legacyevent Legacy event to exctract IDs etc from.
+ */
+ public function __construct($legacyevent = null) {
+ if ($legacyevent) {
+ $this->courseproxy = new event_mapper_test_proxy($legacyevent->courseid);
+ $this->cmproxy = new event_mapper_test_proxy(1729,
+ [
+ 'modname' => $legacyevent->modname,
+ 'instance' => $legacyevent->instance
+ ]
+ );
+ $this->groupproxy = new event_mapper_test_proxy(0);
+ $this->userproxy = new event_mapper_test_proxy($legacyevent->userid);
+ $this->subscriptionproxy = new event_mapper_test_proxy(null);
+ }
+ }
+
+ public function get_id() {
+ return 1729;
+ }
+
+ public function get_name() {
+ return 'Jeff';
+ }
+
+ public function get_description() {
+ return new event_description('asdf', 1);
+ }
+
+ public function get_course() {
+ return $this->courseproxy;
+ }
+
+ public function get_course_module() {
+ return $this->cmproxy;
+ }
+
+ public function get_group() {
+ return $this->groupproxy;
+ }
+
+ public function get_user() {
+ return $this->userproxy;
+ }
+
+ public function get_type() {
+ return 'asdf';
+ }
+
+ public function get_times() {
+ return new event_times(
+ (new \DateTimeImmutable())->setTimestamp('-2461276800'),
+ (new \DateTimeImmutable())->setTimestamp('115776000'),
+ (new \DateTimeImmutable())->setTimestamp('115776000'),
+ (new \DateTimeImmutable())->setTimestamp(time())
+ );
+ }
+
+ public function get_repeats() {
+ return new core_calendar_event_mapper_test_event_collection();
+ }
+
+ public function get_subscription() {
+ return $this->subscriptionproxy;
+ }
+
+ public function is_visible() {
+ return true;
+ }
+}
+
+/**
+ * A test proxy.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class event_mapper_test_proxy implements proxy_interface {
+ /**
+ * @var int $id Proxied ID.
+ */
+ protected $id;
+
+ /**
+ * @var array $params Params to proxy.
+ */
+ protected $params;
+
+ /**
+ * Constructor.
+ *
+ * @param int $id Proxied ID.
+ * @param array $params Params to proxy.
+ */
+ public function __construct($id, $params = []) {
+ $this->params = $params;
+ }
+
+ public function get($member) {
+ return isset($params[$member]) ? $params[$member] : null;
+ }
+
+ public function get_id() {
+ return $this->id;
+ }
+
+ public function set($member, $value) {
+ }
+
+ public function get_proxied_instance() {
+ }
+}
+
+/**
+ * A test event.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_event_mapper_test_event_collection implements event_collection_interface {
+ /**
+ * @var array $events Array of events.
+ */
+ protected $events;
+
+ /**
+ * Constructor.
+ */
+ public function __construct() {
+ $this->events = [
+ 'not really an event hahaha',
+ 'also not really. gottem.'
+ ];
+ }
+
+ public function get_id() {
+ return 1729;
+ }
+
+ public function get_num() {
+ return 2;
+ }
+
+ public function getIterator() {
+ foreach ($this->events as $event) {
+ yield $event;
+ }
+ }
+}
diff --git a/calendar/tests/event_test.php b/calendar/tests/event_test.php
new file mode 100644
index 0000000000000..c1ddaf96f27d2
--- /dev/null
+++ b/calendar/tests/event_test.php
@@ -0,0 +1,140 @@
+.
+
+/**
+ * Event tests.
+ *
+ * @package core_calendar
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+use core_calendar\local\event\entities\event;
+use core_calendar\local\event\proxies\std_proxy;
+use core_calendar\local\event\value_objects\event_description;
+use core_calendar\local\event\value_objects\event_times;
+use core_calendar\local\event\entities\event_collection_interface;
+
+/**
+ * Event testcase.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_event_testcase extends advanced_testcase {
+ /**
+ * Test event class getters.
+ *
+ * @dataProvider getters_testcases()
+ * @param array $constructorparams Associative array of constructor parameters.
+ */
+ public function test_getters($constructorparams) {
+ $event = new event(
+ $constructorparams['id'],
+ $constructorparams['name'],
+ $constructorparams['description'],
+ $constructorparams['course'],
+ $constructorparams['group'],
+ $constructorparams['user'],
+ $constructorparams['repeats'],
+ $constructorparams['course_module'],
+ $constructorparams['type'],
+ $constructorparams['times'],
+ $constructorparams['visible'],
+ $constructorparams['subscription']
+ );
+
+ foreach ($constructorparams as $name => $value) {
+ if ($name !== 'visible') {
+ $this->assertEquals($event->{'get_' . $name}(), $value);
+ }
+ }
+
+ $this->assertEquals($event->is_visible(), $constructorparams['visible']);
+ }
+
+ /**
+ * Test cases for getters test.
+ */
+ public function getters_testcases() {
+ $lamecallable = function($id) {
+ return (object)['id' => $id];
+ };
+
+ return [
+ 'Dataset 1' => [
+ 'constructorparams' => [
+ 'id' => 1,
+ 'name' => 'Test event 1',
+ 'description' => new event_description('asdf', 1),
+ 'course' => new std_proxy(1, $lamecallable),
+ 'group' => new std_proxy(1, $lamecallable),
+ 'user' => new std_proxy(1, $lamecallable),
+ 'repeats' => new core_calendar_event_test_event_collection(),
+ 'course_module' => new std_proxy(1, $lamecallable),
+ 'type' => 'dunno what this actually is meant to be',
+ 'times' => new event_times(
+ (new \DateTimeImmutable())->setTimestamp('-2461276800'),
+ (new \DateTimeImmutable())->setTimestamp('115776000'),
+ (new \DateTimeImmutable())->setTimestamp('115776000'),
+ (new \DateTimeImmutable())->setTimestamp(time())
+ ),
+ 'visible' => true,
+ 'subscription' => new std_proxy(1, $lamecallable)
+ ]
+ ],
+ ];
+ }
+}
+
+/**
+ * Test event class.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_event_test_event_collection implements event_collection_interface {
+ /**
+ * @var array $events Array of events.
+ */
+ protected $events;
+
+ /**
+ * Constructor.
+ */
+ public function __construct() {
+ $this->events = [
+ 'not really an event hahaha',
+ 'also not really. gottem.'
+ ];
+ }
+
+ public function get_id() {
+ return 1729;
+ }
+
+ public function get_num() {
+ return 2;
+ }
+
+ public function getIterator() {
+ foreach ($this->events as $event) {
+ yield $event;
+ }
+ }
+}
diff --git a/calendar/tests/event_times_test.php b/calendar/tests/event_times_test.php
new file mode 100644
index 0000000000000..9a6c55cf4b3cf
--- /dev/null
+++ b/calendar/tests/event_times_test.php
@@ -0,0 +1,80 @@
+.
+
+/**
+ * Event times tests.
+ *
+ * @package core_calendar
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+use core_calendar\local\event\value_objects\event_times;
+
+/**
+ * Event times testcase.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_event_times_testcase extends advanced_testcase {
+ /**
+ * Test event times class getters.
+ *
+ * @dataProvider getters_testcases()
+ * @param array $constructorparams Associative array of constructor parameters.
+ */
+ public function test_getters($constructorparams) {
+ $eventtimes = new event_times(
+ $constructorparams['start_time'],
+ $constructorparams['end_time'],
+ $constructorparams['sort_time'],
+ $constructorparams['modified_time']
+ );
+
+ foreach ($constructorparams as $name => $value) {
+ $this->assertEquals($eventtimes->{'get_' . $name}(), $value);
+ }
+
+ $this->assertEquals($eventtimes->get_duration(), $constructorparams['end_time']->diff($constructorparams['start_time']));
+ }
+
+ /**
+ * Test cases for getters test.
+ */
+ public function getters_testcases() {
+ return [
+ 'Dataset 1' => [
+ 'constructorparams' => [
+ 'start_time' => (new \DateTimeImmutable())->setTimestamp('-2461276800'),
+ 'end_time' => (new \DateTimeImmutable())->setTimestamp('115776000'),
+ 'sort_time' => (new \DateTimeImmutable())->setTimestamp('115776000'),
+ 'modified_time' => (new \DateTimeImmutable())->setTimestamp(time())
+ ]
+ ],
+ 'Dataset 2' => [
+ 'constructorparams' => [
+ 'start_time' => (new \DateTimeImmutable())->setTimestamp('123456'),
+ 'end_time' => (new \DateTimeImmutable())->setTimestamp('12345678'),
+ 'sort_time' => (new \DateTimeImmutable())->setTimestamp('1111'),
+ 'modified_time' => (new \DateTimeImmutable())->setTimestamp(time())
+ ]
+ ]
+ ];
+ }
+}
diff --git a/calendar/tests/event_vault_test.php b/calendar/tests/event_vault_test.php
new file mode 100644
index 0000000000000..1d57d1db9d217
--- /dev/null
+++ b/calendar/tests/event_vault_test.php
@@ -0,0 +1,901 @@
+.
+
+/**
+ * This file contains the class that handles testing of the calendar event vault.
+ *
+ * @package core_calendar
+ * @copyright 2017 Ryan Wyllie
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once($CFG->dirroot . '/calendar/tests/helpers.php');
+
+use core_calendar\local\event\data_access\event_vault;
+use core_calendar\local\event\strategies\raw_event_retrieval_strategy;
+
+/**
+ * This file contains the class that handles testing of the calendar event vault.
+ *
+ * @package core_calendar
+ * @copyright 2017 Ryan Wyllie
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_event_vault_testcase extends advanced_testcase {
+
+ /**
+ * Test that get_action_events_by_timesort returns events after the
+ * provided timesort value.
+ */
+ public function test_get_action_events_by_timesort_after_time() {
+ $this->resetAfterTest(true);
+
+ $user = $this->getDataGenerator()->create_user();
+ $factory = new action_event_test_factory();
+ $strategy = new raw_event_retrieval_strategy();
+ $vault = new event_vault($factory, $strategy);
+
+ $this->setUser($user);
+
+ for ($i = 1; $i < 6; $i++) {
+ create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION
+ ]);
+ }
+
+ $events = $vault->get_action_events_by_timesort($user, 3);
+
+ $this->assertCount(3, $events);
+ $this->assertEquals('Event 3', $events[0]->get_name());
+ $this->assertEquals('Event 4', $events[1]->get_name());
+ $this->assertEquals('Event 5', $events[2]->get_name());
+
+ $events = $vault->get_action_events_by_timesort($user, 3, null, null, 1);
+
+ $this->assertCount(1, $events);
+ $this->assertEquals('Event 3', $events[0]->get_name());
+
+ $events = $vault->get_action_events_by_timesort($user, 6);
+
+ $this->assertCount(0, $events);
+ }
+
+ /**
+ * Test that get_action_events_by_timesort returns events before the
+ * provided timesort value.
+ */
+ public function test_get_action_events_by_timesort_before_time() {
+ $this->resetAfterTest(true);
+ $this->setAdminuser();
+
+ $user = $this->getDataGenerator()->create_user();
+ $factory = new action_event_test_factory();
+ $strategy = new raw_event_retrieval_strategy();
+ $vault = new event_vault($factory, $strategy);
+
+ for ($i = 1; $i < 6; $i++) {
+ create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => 1
+ ]);
+ }
+
+ $events = $vault->get_action_events_by_timesort($user, null, 3);
+
+ $this->assertCount(3, $events);
+ $this->assertEquals('Event 1', $events[0]->get_name());
+ $this->assertEquals('Event 2', $events[1]->get_name());
+ $this->assertEquals('Event 3', $events[2]->get_name());
+
+ $events = $vault->get_action_events_by_timesort($user, null, 3, null, 1);
+
+ $this->assertCount(1, $events);
+ $this->assertEquals('Event 1', $events[0]->get_name());
+
+ $events = $vault->get_action_events_by_timesort($user, 6);
+
+ $this->assertCount(0, $events);
+ }
+
+ /**
+ * Test that get_action_events_by_timesort returns events between the
+ * provided timesort values.
+ */
+ public function test_get_action_events_by_timesort_between_time() {
+ $this->resetAfterTest(true);
+ $this->setAdminuser();
+
+ $user = $this->getDataGenerator()->create_user();
+ $factory = new action_event_test_factory();
+ $strategy = new raw_event_retrieval_strategy();
+ $vault = new event_vault($factory, $strategy);
+
+ for ($i = 1; $i < 6; $i++) {
+ create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => 1
+ ]);
+ }
+
+ $events = $vault->get_action_events_by_timesort($user, 2, 4);
+
+ $this->assertCount(3, $events);
+ $this->assertEquals('Event 2', $events[0]->get_name());
+ $this->assertEquals('Event 3', $events[1]->get_name());
+ $this->assertEquals('Event 4', $events[2]->get_name());
+
+ $events = $vault->get_action_events_by_timesort($user, 2, 4, null, 1);
+
+ $this->assertCount(1, $events);
+ $this->assertEquals('Event 2', $events[0]->get_name());
+ }
+
+ /**
+ * Test that get_action_events_by_timesort returns events between the
+ * provided timesort values and after the last seen event when one is
+ * provided.
+ */
+ public function test_get_action_events_by_timesort_between_time_after_event() {
+ $this->resetAfterTest(true);
+ $this->setAdminuser();
+
+ $user = $this->getDataGenerator()->create_user();
+ $factory = new action_event_test_factory();
+ $strategy = new raw_event_retrieval_strategy();
+ $vault = new event_vault($factory, $strategy);
+
+ $records = [];
+ for ($i = 1; $i < 21; $i++) {
+ $records[] = create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => 1
+ ]);
+ }
+
+ $aftereventid = $records[6]->id;
+ $afterevent = $vault->get_event_by_id($aftereventid);
+ $events = $vault->get_action_events_by_timesort($user, 3, 15, $afterevent);
+
+ $this->assertCount(8, $events);
+ $this->assertEquals('Event 8', $events[0]->get_name());
+
+ $events = $vault->get_action_events_by_timesort($user, 3, 15, $afterevent, 3);
+
+ $this->assertCount(3, $events);
+ }
+
+ /**
+ * Test that get_action_events_by_timesort returns events between the
+ * provided timesort values and the last seen event can be provided to
+ * get paginated results.
+ */
+ public function test_get_action_events_by_timesort_between_time_skip_even_records() {
+ $this->resetAfterTest(true);
+ $this->setAdminuser();
+
+ $user = $this->getDataGenerator()->create_user();
+ // The factory will skip events with even ids.
+ $factory = new action_event_test_factory(function($actionevent) {
+ return ($actionevent->get_id() % 2) ? false : true;
+ });
+ $strategy = new raw_event_retrieval_strategy();
+ $vault = new event_vault($factory, $strategy);
+
+ for ($i = 1; $i < 41; $i++) {
+ create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => 1
+ ]);
+ }
+
+ $events = $vault->get_action_events_by_timesort($user, 3, 35, null, 5);
+
+ $this->assertCount(5, $events);
+ $this->assertEquals('Event 3', $events[0]->get_name());
+ $this->assertEquals('Event 5', $events[1]->get_name());
+ $this->assertEquals('Event 7', $events[2]->get_name());
+ $this->assertEquals('Event 9', $events[3]->get_name());
+ $this->assertEquals('Event 11', $events[4]->get_name());
+
+ $afterevent = $events[4];
+ $events = $vault->get_action_events_by_timesort($user, 3, 35, $afterevent, 5);
+
+ $this->assertCount(5, $events);
+ $this->assertEquals('Event 13', $events[0]->get_name());
+ $this->assertEquals('Event 15', $events[1]->get_name());
+ $this->assertEquals('Event 17', $events[2]->get_name());
+ $this->assertEquals('Event 19', $events[3]->get_name());
+ $this->assertEquals('Event 21', $events[4]->get_name());
+ }
+
+ /**
+ * Test that get_action_events_by_timesort returns events between the
+ * provided timesort values. The database will continue to be read until the
+ * number of events requested has been satisfied. In this case the first
+ * five events are rejected so it should require two database requests.
+ */
+ public function test_get_action_events_by_timesort_between_time_skip_first_records() {
+ $this->resetAfterTest(true);
+ $this->setAdminuser();
+
+ $user = $this->getDataGenerator()->create_user();
+ $limit = 5;
+ $seen = 0;
+ // The factory will skip the first $limit events.
+ $factory = new action_event_test_factory(function($actionevent) use (&$seen, $limit) {
+ if ($seen < $limit) {
+ $seen++;
+ return false;
+ } else {
+ return true;
+ }
+ });
+ $strategy = new raw_event_retrieval_strategy();
+ $vault = new event_vault($factory, $strategy);
+
+ for ($i = 1; $i < 21; $i++) {
+ create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => 1
+ ]);
+ }
+
+ $events = $vault->get_action_events_by_timesort($user, 1, 20, null, $limit);
+
+ $this->assertCount($limit, $events);
+ $this->assertEquals(sprintf('Event %d', $limit + 1), $events[0]->get_name());
+ $this->assertEquals(sprintf('Event %d', $limit + 2), $events[1]->get_name());
+ $this->assertEquals(sprintf('Event %d', $limit + 3), $events[2]->get_name());
+ $this->assertEquals(sprintf('Event %d', $limit + 4), $events[3]->get_name());
+ $this->assertEquals(sprintf('Event %d', $limit + 5), $events[4]->get_name());
+ }
+
+ /**
+ * Test that get_action_events_by_timesort returns events between the
+ * provided timesort values and after the last seen event when one is
+ * provided. This should work even when the event ids aren't ordered the
+ * same as the timesort order.
+ */
+ public function test_get_action_events_by_timesort_non_consecutive_ids() {
+ $this->resetAfterTest(true);
+ $this->setAdminuser();
+
+ $user = $this->getDataGenerator()->create_user();
+ $factory = new action_event_test_factory();
+ $strategy = new raw_event_retrieval_strategy();
+ $vault = new event_vault($factory, $strategy);
+
+ /*
+ * The events should be ordered by timesort as follows:
+ *
+ * 1 event 1
+ * 2 event 1
+ * 1 event 2
+ * 2 event 2
+ * 1 event 3
+ * 2 event 3
+ * 1 event 4
+ * 2 event 4
+ * 1 event 5
+ * 2 event 5
+ * 1 event 6
+ * 2 event 6
+ * 1 event 7
+ * 2 event 7
+ * 1 event 8
+ * 2 event 8
+ * 1 event 9
+ * 2 event 9
+ * 1 event 10
+ * 2 event 10
+ */
+ $records = [];
+ for ($i = 1; $i < 11; $i++) {
+ $records[] = create_event([
+ 'name' => sprintf('1 event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => 1
+ ]);
+ }
+
+ for ($i = 1; $i < 11; $i++) {
+ $records[] = create_event([
+ 'name' => sprintf('2 event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => 1
+ ]);
+ }
+
+ /*
+ * Expected result set:
+ *
+ * 2 event 4
+ * 1 event 5
+ * 2 event 5
+ * 1 event 6
+ * 2 event 6
+ * 1 event 7
+ * 2 event 7
+ * 1 event 8
+ * 2 event 8
+ */
+ $aftereventid = $records[3]->id;
+ $afterevent = $vault->get_event_by_id($aftereventid);
+ // Offset results by event with name "1 event 4" which has the same timesort
+ // value as the lower boundary of this query (3). Confirm that the given
+ // $afterevent is used to ignore events with the same timesortfrom values.
+ $events = $vault->get_action_events_by_timesort($user, 3, 8, $afterevent);
+
+ $this->assertCount(9, $events);
+ $this->assertEquals('2 event 4', $events[0]->get_name());
+ $this->assertEquals('2 event 8', $events[8]->get_name());
+
+ /*
+ * Expected result set:
+ *
+ * 2 event 4
+ * 1 event 5
+ */
+ $events = $vault->get_action_events_by_timesort($user, 3, 8, $afterevent, 2);
+
+ $this->assertCount(2, $events);
+ $this->assertEquals('2 event 4', $events[0]->get_name());
+ $this->assertEquals('1 event 5', $events[1]->get_name());
+
+ /*
+ * Expected result set:
+ *
+ * 2 event 8
+ */
+ $aftereventid = $records[7]->id;
+ $afterevent = $vault->get_event_by_id($aftereventid);
+ // Offset results by event with name "1 event 8" which has the same timesort
+ // value as the upper boundary of this query (8). Confirm that the given
+ // $afterevent is used to ignore events with the same timesortto values.
+ $events = $vault->get_action_events_by_timesort($user, 3, 8, $afterevent);
+
+ $this->assertCount(1, $events);
+ $this->assertEquals('2 event 8', $events[0]->get_name());
+
+ /*
+ * Expected empty result set.
+ */
+ $aftereventid = $records[18]->id;
+ $afterevent = $vault->get_event_by_id($aftereventid);
+ // Offset results by event with name "2 event 9" which has a timesort
+ // value larger than the upper boundary of this query (9 > 8). Confirm
+ // that the given $afterevent is used for filtering events.
+ $events = $vault->get_action_events_by_timesort($user, 3, 8, $afterevent);
+ $this->assertEmpty($events);
+ }
+
+ /**
+ * Test that get_action_events_by_course returns events after the
+ * provided timesort value.
+ */
+ public function test_get_action_events_by_course_after_time() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $factory = new action_event_test_factory();
+ $strategy = new raw_event_retrieval_strategy();
+ $vault = new event_vault($factory, $strategy);
+
+ $this->resetAfterTest(true);
+ $this->setAdminuser();
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+
+ for ($i = 1; $i < 6; $i++) {
+ create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course1->id,
+ ]);
+ }
+
+ for ($i = 6; $i < 12; $i++) {
+ create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course2->id,
+ ]);
+ }
+
+ $events = $vault->get_action_events_by_course($user, $course1, 3);
+ $this->assertCount(3, $events);
+ $this->assertEquals('Event 3', $events[0]->get_name());
+ $this->assertEquals('Event 4', $events[1]->get_name());
+ $this->assertEquals('Event 5', $events[2]->get_name());
+
+ $events = $vault->get_action_events_by_course($user, $course1, 3, null, null, 1);
+
+ $this->assertCount(1, $events);
+ $this->assertEquals('Event 3', $events[0]->get_name());
+
+ $events = $vault->get_action_events_by_course($user, $course1, 6);
+
+ $this->assertCount(0, $events);
+ }
+
+ /**
+ * Test that get_action_events_by_course returns events before the
+ * provided timesort value.
+ */
+ public function test_get_action_events_by_course_before_time() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $factory = new action_event_test_factory();
+ $strategy = new raw_event_retrieval_strategy();
+ $vault = new event_vault($factory, $strategy);
+
+ $this->resetAfterTest(true);
+ $this->setAdminuser();
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+
+ for ($i = 1; $i < 6; $i++) {
+ create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course1->id,
+ ]);
+ }
+
+ for ($i = 6; $i < 12; $i++) {
+ create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course2->id,
+ ]);
+ }
+
+ $events = $vault->get_action_events_by_course($user, $course1, null, 3);
+
+ $this->assertCount(3, $events);
+ $this->assertEquals('Event 1', $events[0]->get_name());
+ $this->assertEquals('Event 2', $events[1]->get_name());
+ $this->assertEquals('Event 3', $events[2]->get_name());
+
+ $events = $vault->get_action_events_by_course($user, $course1, null, 3, null, 1);
+
+ $this->assertCount(1, $events);
+ $this->assertEquals('Event 1', $events[0]->get_name());
+
+ $events = $vault->get_action_events_by_course($user, $course1, 6);
+
+ $this->assertCount(0, $events);
+ }
+
+ /**
+ * Test that get_action_events_by_course returns events between the
+ * provided timesort values.
+ */
+ public function test_get_action_events_by_course_between_time() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $factory = new action_event_test_factory();
+ $strategy = new raw_event_retrieval_strategy();
+ $vault = new event_vault($factory, $strategy);
+
+ $this->resetAfterTest(true);
+ $this->setAdminuser();
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+
+ for ($i = 1; $i < 6; $i++) {
+ create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course1->id,
+ ]);
+ }
+
+ for ($i = 6; $i < 12; $i++) {
+ create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course2->id,
+ ]);
+ }
+
+ $events = $vault->get_action_events_by_course($user, $course1, 2, 4);
+
+ $this->assertCount(3, $events);
+ $this->assertEquals('Event 2', $events[0]->get_name());
+ $this->assertEquals('Event 3', $events[1]->get_name());
+ $this->assertEquals('Event 4', $events[2]->get_name());
+
+ $events = $vault->get_action_events_by_course($user, $course1, 2, 4, null, 1);
+
+ $this->assertCount(1, $events);
+ $this->assertEquals('Event 2', $events[0]->get_name());
+ }
+
+ /**
+ * Test that get_action_events_by_course returns events between the
+ * provided timesort values and after the last seen event when one is
+ * provided.
+ */
+ public function test_get_action_events_by_course_between_time_after_event() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $factory = new action_event_test_factory();
+ $strategy = new raw_event_retrieval_strategy();
+ $vault = new event_vault($factory, $strategy);
+ $records = [];
+
+ $this->resetAfterTest(true);
+ $this->setAdminuser();
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+
+ for ($i = 1; $i < 21; $i++) {
+ $records[] = create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course1->id,
+ ]);
+ }
+
+ for ($i = 21; $i < 41; $i++) {
+ $records[] = create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course2->id,
+ ]);
+ }
+
+ $aftereventid = $records[6]->id;
+ $afterevent = $vault->get_event_by_id($aftereventid);
+ $events = $vault->get_action_events_by_course($user, $course1, 3, 15, $afterevent);
+
+ $this->assertCount(8, $events);
+ $this->assertEquals('Event 8', $events[0]->get_name());
+
+ $events = $vault->get_action_events_by_course($user, $course1, 3, 15, $afterevent, 3);
+
+ $this->assertCount(3, $events);
+ }
+
+ /**
+ * Test that get_action_events_by_course returns events between the
+ * provided timesort values and the last seen event can be provided to
+ * get paginated results.
+ */
+ public function test_get_action_events_by_course_between_time_skip_even_records() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ // The factory will skip events with even ids.
+ $factory = new action_event_test_factory(function($actionevent) {
+ return ($actionevent->get_id() % 2) ? false : true;
+ });
+ $strategy = new raw_event_retrieval_strategy();
+ $vault = new event_vault($factory, $strategy);
+
+ $this->resetAfterTest(true);
+ $this->setAdminuser();
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+
+ for ($i = 1; $i < 41; $i++) {
+ create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course1->id,
+ ]);
+ }
+
+ for ($i = 41; $i < 81; $i++) {
+ create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course2->id,
+ ]);
+ }
+
+ $events = $vault->get_action_events_by_course($user, $course1, 3, 35, null, 5);
+
+ $this->assertCount(5, $events);
+ $this->assertEquals('Event 3', $events[0]->get_name());
+ $this->assertEquals('Event 5', $events[1]->get_name());
+ $this->assertEquals('Event 7', $events[2]->get_name());
+ $this->assertEquals('Event 9', $events[3]->get_name());
+ $this->assertEquals('Event 11', $events[4]->get_name());
+
+ $afterevent = $events[4];
+ $events = $vault->get_action_events_by_course($user, $course1, 3, 35, $afterevent, 5);
+
+ $this->assertCount(5, $events);
+ $this->assertEquals('Event 13', $events[0]->get_name());
+ $this->assertEquals('Event 15', $events[1]->get_name());
+ $this->assertEquals('Event 17', $events[2]->get_name());
+ $this->assertEquals('Event 19', $events[3]->get_name());
+ $this->assertEquals('Event 21', $events[4]->get_name());
+ }
+
+ /**
+ * Test that get_action_events_by_course returns events between the
+ * provided timesort values. The database will continue to be read until the
+ * number of events requested has been satisfied. In this case the first
+ * five events are rejected so it should require two database requests.
+ */
+ public function test_get_action_events_by_course_between_time_skip_first_records() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $limit = 5;
+ $seen = 0;
+ // The factory will skip the first $limit events.
+ $factory = new action_event_test_factory(function($actionevent) use (&$seen, $limit) {
+ if ($seen < $limit) {
+ $seen++;
+ return false;
+ } else {
+ return true;
+ }
+ });
+ $strategy = new raw_event_retrieval_strategy();
+ $vault = new event_vault($factory, $strategy);
+
+ $this->resetAfterTest(true);
+ $this->setAdminuser();
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+
+ for ($i = 1; $i < 21; $i++) {
+ create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course1->id,
+ ]);
+ }
+
+ for ($i = 21; $i < 41; $i++) {
+ create_event([
+ 'name' => sprintf('Event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course2->id,
+ ]);
+ }
+
+ $events = $vault->get_action_events_by_course($user, $course1, 1, 20, null, $limit);
+
+ $this->assertCount($limit, $events);
+ $this->assertEquals(sprintf('Event %d', $limit + 1), $events[0]->get_name());
+ $this->assertEquals(sprintf('Event %d', $limit + 2), $events[1]->get_name());
+ $this->assertEquals(sprintf('Event %d', $limit + 3), $events[2]->get_name());
+ $this->assertEquals(sprintf('Event %d', $limit + 4), $events[3]->get_name());
+ $this->assertEquals(sprintf('Event %d', $limit + 5), $events[4]->get_name());
+ }
+
+ /**
+ * Test that get_action_events_by_course returns events between the
+ * provided timesort values and after the last seen event when one is
+ * provided. This should work even when the event ids aren't ordered the
+ * same as the timesort order.
+ */
+ public function test_get_action_events_by_course_non_consecutive_ids() {
+ $this->resetAfterTest(true);
+ $this->setAdminuser();
+
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $factory = new action_event_test_factory();
+ $strategy = new raw_event_retrieval_strategy();
+ $vault = new event_vault($factory, $strategy);
+
+ $this->setAdminuser();
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+
+ /*
+ * The events should be ordered by timesort as follows:
+ *
+ * 1 event 1
+ * 2 event 1
+ * 1 event 2
+ * 2 event 2
+ * 1 event 3
+ * 2 event 3
+ * 1 event 4
+ * 2 event 4
+ * 1 event 5
+ * 2 event 5
+ * 1 event 6
+ * 2 event 6
+ * 1 event 7
+ * 2 event 7
+ * 1 event 8
+ * 2 event 8
+ * 1 event 9
+ * 2 event 9
+ * 1 event 10
+ * 2 event 10
+ */
+ $records = [];
+ for ($i = 1; $i < 11; $i++) {
+ $records[] = create_event([
+ 'name' => sprintf('1 event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course1->id,
+ ]);
+ }
+
+ for ($i = 1; $i < 11; $i++) {
+ $records[] = create_event([
+ 'name' => sprintf('2 event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course1->id,
+ ]);
+ }
+
+ // Create events for the other course.
+ for ($i = 1; $i < 11; $i++) {
+ $records[] = create_event([
+ 'name' => sprintf('3 event %d', $i),
+ 'eventtype' => 'user',
+ 'userid' => $user->id,
+ 'timesort' => $i,
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course2->id,
+ ]);
+ }
+
+ /*
+ * Expected result set:
+ *
+ * 2 event 4
+ * 1 event 5
+ * 2 event 5
+ * 1 event 6
+ * 2 event 6
+ * 1 event 7
+ * 2 event 7
+ * 1 event 8
+ * 2 event 8
+ */
+ $aftereventid = $records[3]->id;
+ $afterevent = $vault->get_event_by_id($aftereventid);
+ // Offset results by event with name "1 event 4" which has the same timesort
+ // value as the lower boundary of this query (3). Confirm that the given
+ // $afterevent is used to ignore events with the same timesortfrom values.
+ $events = $vault->get_action_events_by_course($user, $course1, 3, 8, $afterevent);
+
+ $this->assertCount(9, $events);
+ $this->assertEquals('2 event 4', $events[0]->get_name());
+ $this->assertEquals('2 event 8', $events[8]->get_name());
+
+ /*
+ * Expected result set:
+ *
+ * 2 event 4
+ * 1 event 5
+ */
+ $events = $vault->get_action_events_by_course($user, $course1, 3, 8, $afterevent, 2);
+
+ $this->assertCount(2, $events);
+ $this->assertEquals('2 event 4', $events[0]->get_name());
+ $this->assertEquals('1 event 5', $events[1]->get_name());
+
+ /*
+ * Expected result set:
+ *
+ * 2 event 8
+ */
+ $aftereventid = $records[7]->id;
+ $afterevent = $vault->get_event_by_id($aftereventid);
+ // Offset results by event with name "1 event 8" which has the same timesort
+ // value as the upper boundary of this query (8). Confirm that the given
+ // $afterevent is used to ignore events with the same timesortto values.
+ $events = $vault->get_action_events_by_course($user, $course1, 3, 8, $afterevent);
+
+ $this->assertCount(1, $events);
+ $this->assertEquals('2 event 8', $events[0]->get_name());
+
+ /*
+ * Expected empty result set.
+ */
+ $aftereventid = $records[18]->id;
+ $afterevent = $vault->get_event_by_id($aftereventid);
+ // Offset results by event with name "2 event 9" which has a timesort
+ // value larger than the upper boundary of this query (9 > 8). Confirm
+ // that the given $afterevent is used for filtering events.
+ $events = $vault->get_action_events_by_course($user, $course1, 3, 8, $afterevent);
+
+ $this->assertEmpty($events);
+ }
+}
diff --git a/calendar/tests/events_test.php b/calendar/tests/events_test.php
index 207d66a6a4fc0..6f78848a05965 100644
--- a/calendar/tests/events_test.php
+++ b/calendar/tests/events_test.php
@@ -219,6 +219,41 @@ public function test_calendar_event_updated() {
}
}
+ /**
+ * Tests for calendar_event_updated event.
+ */
+ public function test_calendar_event_updated_toggle_visibility() {
+ global $DB, $SITE;
+
+ $this->resetAfterTest();
+
+ // Create a calendar event.
+ $time = time();
+ $calevent = core_calendar_externallib_testcase::create_calendar_event('Some wickedly awesome event yo!',
+ $this->user->id, 'user', 0, $time);
+
+ // Updated the visibility of the calendar event.
+ $sink = $this->redirectEvents();
+ $calevent->toggle_visibility();
+ $dbrecord = $DB->get_record('event', array('id' => $calevent->id), '*', MUST_EXIST);
+ $events = $sink->get_events();
+
+ // Validate the calendar_event_updated event.
+ $event = $events[0];
+ $this->assertInstanceOf('\core\event\calendar_event_updated', $event);
+ $this->assertEquals('event', $event->objecttable);
+ $this->assertEquals($SITE->id, $event->courseid);
+ $this->assertEquals($calevent->context, $event->get_context());
+ $expectedlog = array($SITE->id, 'calendar', 'edit', 'event.php?action=edit&id=' . $calevent->id ,
+ $calevent->name);
+ $this->assertEventLegacyLogData($expectedlog, $event);
+ $other = array('repeatid' => 0, 'timestart' => $time, 'name' => 'Some wickedly awesome event yo!');
+ $this->assertEquals($other, $event->other);
+ $this->assertEventContextNotUsed($event);
+ $this->assertEquals($dbrecord, $event->get_record_snapshot('event', $event->objectid));
+
+ }
+
/**
* Tests for event validations related to calendar_event_created event.
*/
diff --git a/calendar/tests/externallib_test.php b/calendar/tests/externallib_test.php
index 9baf24918bea8..62f9336310444 100644
--- a/calendar/tests/externallib_test.php
+++ b/calendar/tests/externallib_test.php
@@ -85,6 +85,12 @@ public static function create_calendar_event($name, $userid = 0, $type = 'user',
if (empty($prop->timeduration)) {
$prop->timeduration = 0;
}
+ if (empty($prop->timesort)) {
+ $prop->timesort = 0;
+ }
+ if (empty($prop->type)) {
+ $prop->type = CALENDAR_EVENT_TYPE_STANDARD;
+ }
if (empty($prop->repeats)) {
$prop->repeat = 0;
} else {
@@ -542,4 +548,657 @@ public function test_core_create_calendar_events() {
$this->assertEquals(1, count($eventsret['events']));
$this->assertEquals(2, count($eventsret['warnings']));
}
+
+ /**
+ * Requesting calendar events from a given time should return all events with a sort
+ * time at or after the requested time. All events prior to that time should not
+ * be return.
+ *
+ * If there are no events on or after the given time then an empty result set should
+ * be returned.
+ */
+ public function test_get_calendar_action_events_by_timesort_after_time() {
+ $user = $this->getDataGenerator()->create_user();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance = $generator->create_instance(['course' => $course->id]);
+
+ $this->getDataGenerator()->enrol_user($user->id, $course->id);
+ $this->resetAfterTest(true);
+ $this->setUser($user);
+
+ $params = [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'modulename' => 'assign',
+ 'instance' => $moduleinstance->id,
+ 'courseid' => $course->id,
+ ];
+
+ $event1 = $this->create_calendar_event('Event 1', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 1]));
+ $event2 = $this->create_calendar_event('Event 2', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 2]));
+ $event3 = $this->create_calendar_event('Event 3', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 3]));
+ $event4 = $this->create_calendar_event('Event 4', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 4]));
+ $event5 = $this->create_calendar_event('Event 5', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 5]));
+ $event6 = $this->create_calendar_event('Event 6', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 6]));
+ $event7 = $this->create_calendar_event('Event 7', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 7]));
+ $event8 = $this->create_calendar_event('Event 8', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 8]));
+
+ $result = core_calendar_external::get_calendar_action_events_by_timesort(5);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_timesort_returns(),
+ $result
+ );
+ $events = $result['events'];
+
+ $this->assertCount(4, $events);
+ $this->assertEquals('Event 5', $events[0]['name']);
+ $this->assertEquals('Event 6', $events[1]['name']);
+ $this->assertEquals('Event 7', $events[2]['name']);
+ $this->assertEquals('Event 8', $events[3]['name']);
+ $this->assertEquals($event5->id, $result['firstid']);
+ $this->assertEquals($event8->id, $result['lastid']);
+
+ $result = core_calendar_external::get_calendar_action_events_by_timesort(9);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_timesort_returns(),
+ $result
+ );
+
+ $this->assertEmpty($result['events']);
+ $this->assertNull($result['firstid']);
+ $this->assertNull($result['lastid']);
+ }
+
+ /**
+ * Requesting calendar events before a given time should return all events with a sort
+ * time at or before the requested time (inclusive). All events after that time
+ * should not be returned.
+ *
+ * If there are no events before the given time then an empty result set should be
+ * returned.
+ */
+ public function test_get_calendar_action_events_by_timesort_before_time() {
+ $user = $this->getDataGenerator()->create_user();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance = $generator->create_instance(['course' => $course->id]);
+
+ $this->getDataGenerator()->enrol_user($user->id, $course->id);
+ $this->resetAfterTest(true);
+ $this->setUser($user);
+
+ $params = [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'modulename' => 'assign',
+ 'instance' => $moduleinstance->id,
+ 'courseid' => $course->id,
+ ];
+
+ $event1 = $this->create_calendar_event('Event 1', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 2]));
+ $event2 = $this->create_calendar_event('Event 2', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 3]));
+ $event3 = $this->create_calendar_event('Event 3', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 4]));
+ $event4 = $this->create_calendar_event('Event 4', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 5]));
+ $event5 = $this->create_calendar_event('Event 5', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 6]));
+ $event6 = $this->create_calendar_event('Event 6', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 7]));
+ $event7 = $this->create_calendar_event('Event 7', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 8]));
+ $event8 = $this->create_calendar_event('Event 8', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 9]));
+
+ $result = core_calendar_external::get_calendar_action_events_by_timesort(null, 5);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_timesort_returns(),
+ $result
+ );
+ $events = $result['events'];
+
+ $this->assertCount(4, $events);
+ $this->assertEquals('Event 1', $events[0]['name']);
+ $this->assertEquals('Event 2', $events[1]['name']);
+ $this->assertEquals('Event 3', $events[2]['name']);
+ $this->assertEquals('Event 4', $events[3]['name']);
+ $this->assertEquals($event1->id, $result['firstid']);
+ $this->assertEquals($event4->id, $result['lastid']);
+
+ $result = core_calendar_external::get_calendar_action_events_by_timesort(null, 1);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_timesort_returns(),
+ $result
+ );
+
+ $this->assertEmpty($result['events']);
+ $this->assertNull($result['firstid']);
+ $this->assertNull($result['lastid']);
+ }
+
+ /**
+ * Requesting calendar events within a given time range should return all events with
+ * a sort time between the lower and upper time bound (inclusive).
+ *
+ * If there are no events in the given time range then an empty result set should be
+ * returned.
+ */
+ public function test_get_calendar_action_events_by_timesort_time_range() {
+ $user = $this->getDataGenerator()->create_user();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance = $generator->create_instance(['course' => $course->id]);
+
+ $this->getDataGenerator()->enrol_user($user->id, $course->id);
+ $this->resetAfterTest(true);
+ $this->setUser($user);
+
+ $params = [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'modulename' => 'assign',
+ 'instance' => $moduleinstance->id,
+ 'courseid' => $course->id,
+ ];
+
+ $event1 = $this->create_calendar_event('Event 1', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 1]));
+ $event2 = $this->create_calendar_event('Event 2', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 2]));
+ $event3 = $this->create_calendar_event('Event 3', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 3]));
+ $event4 = $this->create_calendar_event('Event 4', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 4]));
+ $event5 = $this->create_calendar_event('Event 5', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 5]));
+ $event6 = $this->create_calendar_event('Event 6', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 6]));
+ $event7 = $this->create_calendar_event('Event 7', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 7]));
+ $event8 = $this->create_calendar_event('Event 8', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 8]));
+
+ $result = core_calendar_external::get_calendar_action_events_by_timesort(3, 6);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_timesort_returns(),
+ $result
+ );
+ $events = $result['events'];
+
+ $this->assertCount(4, $events);
+ $this->assertEquals('Event 3', $events[0]['name']);
+ $this->assertEquals('Event 4', $events[1]['name']);
+ $this->assertEquals('Event 5', $events[2]['name']);
+ $this->assertEquals('Event 6', $events[3]['name']);
+ $this->assertEquals($event3->id, $result['firstid']);
+ $this->assertEquals($event6->id, $result['lastid']);
+
+ $result = core_calendar_external::get_calendar_action_events_by_timesort(10, 15);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_timesort_returns(),
+ $result
+ );
+
+ $this->assertEmpty($result['events']);
+ $this->assertNull($result['firstid']);
+ $this->assertNull($result['lastid']);
+ }
+
+ /**
+ * Requesting calendar events within a given time range and a limit and offset should return
+ * the number of events up to the given limit value that have a sort time between the lower
+ * and uppper time bound (inclusive) where the result set is shifted by the offset value.
+ *
+ * If there are no events in the given time range then an empty result set should be
+ * returned.
+ */
+ public function test_get_calendar_action_events_by_timesort_time_limit_offset() {
+ $user = $this->getDataGenerator()->create_user();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance = $generator->create_instance(['course' => $course->id]);
+
+ $this->getDataGenerator()->enrol_user($user->id, $course->id);
+ $this->resetAfterTest(true);
+ $this->setUser($user);
+
+ $params = [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'modulename' => 'assign',
+ 'instance' => $moduleinstance->id,
+ 'courseid' => $course->id,
+ ];
+
+ $event1 = $this->create_calendar_event('Event 1', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 1]));
+ $event2 = $this->create_calendar_event('Event 2', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 2]));
+ $event3 = $this->create_calendar_event('Event 3', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 3]));
+ $event4 = $this->create_calendar_event('Event 4', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 4]));
+ $event5 = $this->create_calendar_event('Event 5', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 5]));
+ $event6 = $this->create_calendar_event('Event 6', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 6]));
+ $event7 = $this->create_calendar_event('Event 7', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 7]));
+ $event8 = $this->create_calendar_event('Event 8', $user->id, 'user', 0, 1, array_merge($params, ['timesort' => 8]));
+
+ $result = core_calendar_external::get_calendar_action_events_by_timesort(2, 7, $event3->id, 2);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_timesort_returns(),
+ $result
+ );
+ $events = $result['events'];
+
+ $this->assertCount(2, $events);
+ $this->assertEquals('Event 4', $events[0]['name']);
+ $this->assertEquals('Event 5', $events[1]['name']);
+ $this->assertEquals($event4->id, $result['firstid']);
+ $this->assertEquals($event5->id, $result['lastid']);
+
+ $result = core_calendar_external::get_calendar_action_events_by_timesort(2, 7, $event5->id, 2);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_timesort_returns(),
+ $result
+ );
+ $events = $result['events'];
+
+ $this->assertCount(2, $events);
+ $this->assertEquals('Event 6', $events[0]['name']);
+ $this->assertEquals('Event 7', $events[1]['name']);
+ $this->assertEquals($event6->id, $result['firstid']);
+ $this->assertEquals($event7->id, $result['lastid']);
+
+ $result = core_calendar_external::get_calendar_action_events_by_timesort(2, 7, $event7->id, 2);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_timesort_returns(),
+ $result
+ );
+
+ $this->assertEmpty($result['events']);
+ $this->assertNull($result['firstid']);
+ $this->assertNull($result['lastid']);
+ }
+
+ /**
+ * Requesting calendar events from a given course and time should return all
+ * events with a sort time at or after the requested time. All events prior
+ * to that time should not be return.
+ *
+ * If there are no events on or after the given time then an empty result set should
+ * be returned.
+ */
+ public function test_get_calendar_action_events_by_course_after_time() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $instance1 = $generator->create_instance(['course' => $course1->id]);
+ $instance2 = $generator->create_instance(['course' => $course2->id]);
+ $records = [];
+
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+ $this->resetAfterTest(true);
+ $this->setUser($user);
+
+ for ($i = 1; $i < 19; $i++) {
+ $courseid = ($i < 9) ? $course1->id : $course2->id;
+ $instance = ($i < 9) ? $instance1->id : $instance2->id;
+ $records[] = $this->create_calendar_event(
+ sprintf('Event %d', $i),
+ $user->id,
+ 'user',
+ 0,
+ 1,
+ [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $courseid,
+ 'timesort' => $i,
+ 'modulename' => 'assign',
+ 'instance' => $instance,
+ ]
+ );
+ }
+
+ $result = core_calendar_external::get_calendar_action_events_by_course($course1->id, 5);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_course_returns(),
+ $result
+ );
+ $result = $result['events'];
+
+ $this->assertCount(4, $result);
+ $this->assertEquals('Event 5', $result[0]['name']);
+ $this->assertEquals('Event 6', $result[1]['name']);
+ $this->assertEquals('Event 7', $result[2]['name']);
+ $this->assertEquals('Event 8', $result[3]['name']);
+
+ $result = core_calendar_external::get_calendar_action_events_by_course($course1->id, 9);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_course_returns(),
+ $result
+ );
+ $result = $result['events'];
+
+ $this->assertEmpty($result);
+ }
+
+ /**
+ * Requesting calendar events for a course and before a given time should return
+ * all events with a sort time at or before the requested time (inclusive). All
+ * events after that time should not be returned.
+ *
+ * If there are no events before the given time then an empty result set should be
+ * returned.
+ */
+ public function test_get_calendar_action_events_by_course_before_time() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $instance1 = $generator->create_instance(['course' => $course1->id]);
+ $instance2 = $generator->create_instance(['course' => $course2->id]);
+ $records = [];
+
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+ $this->resetAfterTest(true);
+ $this->setUser($user);
+
+ for ($i = 1; $i < 19; $i++) {
+ $courseid = ($i < 9) ? $course1->id : $course2->id;
+ $instance = ($i < 9) ? $instance1->id : $instance2->id;
+ $records[] = $this->create_calendar_event(
+ sprintf('Event %d', $i),
+ $user->id,
+ 'user',
+ 0,
+ 1,
+ [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $courseid,
+ 'timesort' => $i + 1,
+ 'modulename' => 'assign',
+ 'instance' => $instance,
+ ]
+ );
+ }
+
+ $result = core_calendar_external::get_calendar_action_events_by_course($course1->id, null, 5);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_course_returns(),
+ $result
+ );
+ $result = $result['events'];
+
+ $this->assertCount(4, $result);
+ $this->assertEquals('Event 1', $result[0]['name']);
+ $this->assertEquals('Event 2', $result[1]['name']);
+ $this->assertEquals('Event 3', $result[2]['name']);
+ $this->assertEquals('Event 4', $result[3]['name']);
+
+ $result = core_calendar_external::get_calendar_action_events_by_course($course1->id, null, 1);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_course_returns(),
+ $result
+ );
+ $result = $result['events'];
+
+ $this->assertEmpty($result);
+ }
+
+ /**
+ * Requesting calendar events for a course and within a given time range should
+ * return all events with a sort time between the lower and upper time bound
+ * (inclusive).
+ *
+ * If there are no events in the given time range then an empty result set should be
+ * returned.
+ */
+ public function test_get_calendar_action_events_by_course_time_range() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $instance1 = $generator->create_instance(['course' => $course1->id]);
+ $instance2 = $generator->create_instance(['course' => $course2->id]);
+ $records = [];
+
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+ $this->resetAfterTest(true);
+ $this->setUser($user);
+
+ for ($i = 1; $i < 19; $i++) {
+ $courseid = ($i < 9) ? $course1->id : $course2->id;
+ $instance = ($i < 9) ? $instance1->id : $instance2->id;
+ $records[] = $this->create_calendar_event(
+ sprintf('Event %d', $i),
+ $user->id,
+ 'user',
+ 0,
+ 1,
+ [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $courseid,
+ 'timesort' => $i,
+ 'modulename' => 'assign',
+ 'instance' => $instance,
+ ]
+ );
+ }
+
+ $result = core_calendar_external::get_calendar_action_events_by_course($course1->id, 3, 6);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_course_returns(),
+ $result
+ );
+ $result = $result['events'];
+
+ $this->assertCount(4, $result);
+ $this->assertEquals('Event 3', $result[0]['name']);
+ $this->assertEquals('Event 4', $result[1]['name']);
+ $this->assertEquals('Event 5', $result[2]['name']);
+ $this->assertEquals('Event 6', $result[3]['name']);
+
+ $result = core_calendar_external::get_calendar_action_events_by_course($course1->id, 10, 15);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_course_returns(),
+ $result
+ );
+ $result = $result['events'];
+
+ $this->assertEmpty($result);
+ }
+
+ /**
+ * Requesting calendar events for a course and within a given time range and a limit
+ * and offset should return the number of events up to the given limit value that have
+ * a sort time between the lower and uppper time bound (inclusive) where the result
+ * set is shifted by the offset value.
+ *
+ * If there are no events in the given time range then an empty result set should be
+ * returned.
+ */
+ public function test_get_calendar_action_events_by_course_time_limit_offset() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $instance1 = $generator->create_instance(['course' => $course1->id]);
+ $instance2 = $generator->create_instance(['course' => $course2->id]);
+ $records = [];
+
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+ $this->resetAfterTest(true);
+ $this->setUser($user);
+
+ for ($i = 1; $i < 19; $i++) {
+ $courseid = ($i < 9) ? $course1->id : $course2->id;
+ $instance = ($i < 9) ? $instance1->id : $instance2->id;
+ $records[] = $this->create_calendar_event(
+ sprintf('Event %d', $i),
+ $user->id,
+ 'user',
+ 0,
+ 1,
+ [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $courseid,
+ 'timesort' => $i,
+ 'modulename' => 'assign',
+ 'instance' => $instance,
+ ]
+ );
+ }
+
+ $result = core_calendar_external::get_calendar_action_events_by_course(
+ $course1->id, 2, 7, $records[2]->id, 2);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_course_returns(),
+ $result
+ );
+ $result = $result['events'];
+
+ $this->assertCount(2, $result);
+ $this->assertEquals('Event 4', $result[0]['name']);
+ $this->assertEquals('Event 5', $result[1]['name']);
+
+ $result = core_calendar_external::get_calendar_action_events_by_course(
+ $course1->id, 2, 7, $records[4]->id, 2);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_course_returns(),
+ $result
+ );
+ $result = $result['events'];
+
+ $this->assertCount(2, $result);
+ $this->assertEquals('Event 6', $result[0]['name']);
+ $this->assertEquals('Event 7', $result[1]['name']);
+
+ $result = core_calendar_external::get_calendar_action_events_by_course(
+ $course1->id, 2, 7, $records[6]->id, 2);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_course_returns(),
+ $result
+ );
+ $result = $result['events'];
+
+ $this->assertEmpty($result);
+ }
+
+ /**
+ * Test that get_action_events_by_courses will return a list of events for each
+ * course you provided as long as the user is enrolled in the course.
+ */
+ public function test_get_action_events_by_courses() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $course3 = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $instance1 = $generator->create_instance(['course' => $course1->id]);
+ $instance2 = $generator->create_instance(['course' => $course2->id]);
+ $instance3 = $generator->create_instance(['course' => $course3->id]);
+ $records = [];
+ $mapresult = function($result) {
+ $groupedbycourse = [];
+ foreach ($result['groupedbycourse'] as $group) {
+ $events = $group['events'];
+ $courseid = $group['courseid'];
+ $groupedbycourse[$courseid] = $events;
+ }
+
+ return $groupedbycourse;
+ };
+
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+ $this->resetAfterTest(true);
+ $this->setUser($user);
+
+ for ($i = 1; $i < 10; $i++) {
+ if ($i < 3) {
+ $courseid = $course1->id;
+ $instance = $instance1->id;
+ } else if ($i < 6) {
+ $courseid = $course2->id;
+ $instance = $instance2->id;
+ } else {
+ $courseid = $course3->id;
+ $instance = $instance3->id;
+ }
+
+ $records[] = $this->create_calendar_event(
+ sprintf('Event %d', $i),
+ $user->id,
+ 'user',
+ 0,
+ 1,
+ [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $courseid,
+ 'timesort' => $i,
+ 'modulename' => 'assign',
+ 'instance' => $instance,
+ ]
+ );
+ }
+
+ $result = core_calendar_external::get_calendar_action_events_by_courses([], 1);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_courses_returns(),
+ $result
+ );
+ $result = $result['groupedbycourse'];
+
+ $this->assertEmpty($result);
+
+ $result = core_calendar_external::get_calendar_action_events_by_courses([$course1->id], 3);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_courses_returns(),
+ $result
+ );
+
+ $groupedbycourse = $mapresult($result);
+
+ $this->assertEmpty($groupedbycourse[$course1->id]);
+
+ $result = core_calendar_external::get_calendar_action_events_by_courses([$course1->id], 1);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_courses_returns(),
+ $result
+ );
+ $groupedbycourse = $mapresult($result);
+
+ $this->assertCount(2, $groupedbycourse[$course1->id]);
+ $this->assertEquals('Event 1', $groupedbycourse[$course1->id][0]['name']);
+ $this->assertEquals('Event 2', $groupedbycourse[$course1->id][1]['name']);
+
+ $result = core_calendar_external::get_calendar_action_events_by_courses(
+ [$course1->id, $course2->id], 1);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_courses_returns(),
+ $result
+ );
+ $groupedbycourse = $mapresult($result);
+
+ $this->assertCount(2, $groupedbycourse[$course1->id]);
+ $this->assertEquals('Event 1', $groupedbycourse[$course1->id][0]['name']);
+ $this->assertEquals('Event 2', $groupedbycourse[$course1->id][1]['name']);
+ $this->assertCount(3, $groupedbycourse[$course2->id]);
+ $this->assertEquals('Event 3', $groupedbycourse[$course2->id][0]['name']);
+ $this->assertEquals('Event 4', $groupedbycourse[$course2->id][1]['name']);
+ $this->assertEquals('Event 5', $groupedbycourse[$course2->id][2]['name']);
+
+ $result = core_calendar_external::get_calendar_action_events_by_courses(
+ [$course1->id, $course2->id], 2, 4);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_courses_returns(),
+ $result
+ );
+ $groupedbycourse = $mapresult($result);
+
+ $this->assertCount(2, $groupedbycourse);
+ $this->assertCount(1, $groupedbycourse[$course1->id]);
+ $this->assertEquals('Event 2', $groupedbycourse[$course1->id][0]['name']);
+ $this->assertCount(2, $groupedbycourse[$course2->id]);
+ $this->assertEquals('Event 3', $groupedbycourse[$course2->id][0]['name']);
+ $this->assertEquals('Event 4', $groupedbycourse[$course2->id][1]['name']);
+
+ $result = core_calendar_external::get_calendar_action_events_by_courses(
+ [$course1->id, $course2->id], 1, null, 1);
+ $result = external_api::clean_returnvalue(
+ core_calendar_external::get_calendar_action_events_by_courses_returns(),
+ $result
+ );
+ $groupedbycourse = $mapresult($result);
+
+ $this->assertCount(2, $groupedbycourse);
+ $this->assertCount(1, $groupedbycourse[$course1->id]);
+ $this->assertEquals('Event 1', $groupedbycourse[$course1->id][0]['name']);
+ $this->assertCount(1, $groupedbycourse[$course2->id]);
+ $this->assertEquals('Event 3', $groupedbycourse[$course2->id][0]['name']);
+ }
}
diff --git a/calendar/tests/helpers.php b/calendar/tests/helpers.php
new file mode 100644
index 0000000000000..c990d4de37d7f
--- /dev/null
+++ b/calendar/tests/helpers.php
@@ -0,0 +1,160 @@
+.
+
+/**
+ * This file contains helper classes and functions for testing.
+ *
+ * @package core_calendar
+ * @copyright 2017 Ryan Wyllie
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+require_once($CFG->dirroot . '/calendar/lib.php');
+
+use core_calendar\local\event\entities\action_event;
+use core_calendar\local\event\entities\event;
+use core_calendar\local\event\entities\repeat_event_collection;
+use core_calendar\local\event\proxies\std_proxy;
+use core_calendar\local\event\value_objects\action;
+use core_calendar\local\event\value_objects\event_description;
+use core_calendar\local\event\value_objects\event_times;
+use core_calendar\local\event\factories\event_factory_interface;
+
+/**
+ * Create a calendar event with the given properties.
+ *
+ * @param array $properties The properties to set on the event
+ * @return \calendar_event
+ */
+function create_event($properties) {
+ $record = new \stdClass();
+ $record->name = 'event name';
+ $record->eventtype = 'global';
+ $record->repeat = 0;
+ $record->repeats = 0;
+ $record->timestart = time();
+ $record->timeduration = 0;
+ $record->timesort = 0;
+ $record->type = CALENDAR_EVENT_TYPE_STANDARD;
+ $record->courseid = 0;
+
+ foreach ($properties as $name => $value) {
+ $record->$name = $value;
+ }
+
+ $event = new \calendar_event($record);
+ return $event->create($record);
+}
+
+/**
+ * A test factory that will create action events.
+ *
+ * @copyright 2017 Ryan Wyllie
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late
+ */
+class action_event_test_factory implements event_factory_interface {
+
+ /**
+ * @var callable $callback.
+ */
+ private $callback;
+
+ /**
+ * A test factory that will create action events. The factory accepts a callback
+ * that will be used to determine if the event should be returned or not.
+ *
+ * The callback will be given the event and should return true if the event
+ * should be returned and false otherwise.
+ *
+ * @param callable $callback The callback.
+ */
+ public function __construct($callback = null) {
+ $this->callback = $callback;
+ }
+
+ public function create_instance(\stdClass $record) {
+ $module = null;
+ $subscription = null;
+
+ if ($record->instance && $record->modulename) {
+ $modulename = $record->modulename;
+ $module = new std_proxy($record->instance, function($id) use ($modulename) {
+ return get_coursemodule_from_instance($modulename, $id);
+ },
+ (object)[
+ 'modname' => $modulename,
+ 'instance' => $record->instance
+ ]);
+ }
+
+ if ($record->subscriptionid) {
+ $subscription = new std_proxy($record->subscriptionid, function($id) {
+ return (object)['id' => $id];
+ });
+ }
+
+ $event = new event(
+ $record->id,
+ $record->name,
+ new event_description($record->description, $record->format),
+ new std_proxy($record->courseid, function($id) {
+ $course = new \stdClass();
+ $course->id = $id;
+ return $course;
+ }),
+ new std_proxy($record->groupid, function($id) {
+ $group = new \stdClass();
+ $group->id = $id;
+ return $group;
+ }),
+ new std_proxy($record->userid, function($id) {
+ $user = new \stdClass();
+ $user->id = $id;
+ return $user;
+ }),
+ new repeat_event_collection($record->id, null, $this),
+ $module,
+ $record->eventtype,
+ new event_times(
+ (new \DateTimeImmutable())->setTimestamp($record->timestart),
+ (new \DateTimeImmutable())->setTimestamp($record->timestart + $record->timeduration),
+ (new \DateTimeImmutable())->setTimestamp($record->timesort ? $record->timesort : $record->timestart),
+ (new \DateTimeImmutable())->setTimestamp($record->timemodified)
+ ),
+ !empty($record->visible),
+ $subscription
+ );
+
+ $action = new action(
+ 'Test action',
+ new \moodle_url('/'),
+ 1,
+ true
+ );
+
+ $actionevent = new action_event($event, $action);
+
+ if ($callback = $this->callback) {
+ return $callback($actionevent) ? $actionevent : false;
+ } else {
+ return $actionevent;
+ }
+ }
+}
diff --git a/calendar/tests/ical_test.php b/calendar/tests/ical_test.php
deleted file mode 100644
index d2223b538c29d..0000000000000
--- a/calendar/tests/ical_test.php
+++ /dev/null
@@ -1,138 +0,0 @@
-.
-
-/**
- * Calendar Ical unit tests
- *
- * @package core_calendar
- * @copyright 2013 Ankit Agarwal
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-defined('MOODLE_INTERNAL') || die();
-
-global $CFG;
-
-
-/**
- * Unit tests for ical APIs.
- *
- * @package core_calendar
- * @copyright 2013 Ankit Agarwal
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since Moodle 2.5
- */
-class core_calendar_ical_testcase extends advanced_testcase {
-
- /**
- * Tests set up
- */
- protected function setUp() {
- global $CFG;
- require_once($CFG->dirroot . '/calendar/lib.php');
- }
-
- /**
- * @expectedException coding_exception
- */
- public function test_calendar_update_subscription() {
- $this->resetAfterTest(true);
-
- $subscription = new stdClass();
- $subscription->eventtype = 'site';
- $subscription->name = 'test';
- $id = calendar_add_subscription($subscription);
-
- $subscription = new stdClass();
- $subscription = calendar_get_subscription($id);
- $subscription->name = 'awesome';
- calendar_update_subscription($subscription);
- $sub = calendar_get_subscription($id);
- $this->assertEquals($subscription->name, $sub->name);
-
- $subscription = new stdClass();
- $subscription = calendar_get_subscription($id);
- $subscription->name = 'awesome2';
- $subscription->pollinterval = 604800;
- calendar_update_subscription($subscription);
- $sub = calendar_get_subscription($id);
- $this->assertEquals($subscription->name, $sub->name);
- $this->assertEquals($subscription->pollinterval, $sub->pollinterval);
-
- $subscription = new stdClass();
- $subscription->name = 'awesome4';
- calendar_update_subscription($subscription);
- }
-
- public function test_calendar_add_subscription() {
- global $DB, $CFG;
-
- require_once($CFG->dirroot . '/lib/bennu/bennu.inc.php');
-
- $this->resetAfterTest(true);
-
- // Test for Microsoft Outlook 2010.
- $subscription = new stdClass();
- $subscription->name = 'Microsoft Outlook 2010';
- $subscription->importfrom = CALENDAR_IMPORT_FROM_FILE;
- $subscription->eventtype = 'site';
- $id = calendar_add_subscription($subscription);
-
- $calendar = file_get_contents($CFG->dirroot . '/lib/tests/fixtures/ms_outlook_2010.ics');
- $ical = new iCalendar();
- $ical->unserialize($calendar);
- $this->assertEquals($ical->parser_errors, array());
-
- $sub = calendar_get_subscription($id);
- $result = calendar_import_icalendar_events($ical, $sub->courseid, $sub->id);
- $count = $DB->count_records('event', array('subscriptionid' => $sub->id));
- $this->assertEquals($count, 1);
-
- // Test for OSX Yosemite.
- $subscription = new stdClass();
- $subscription->name = 'OSX Yosemite';
- $subscription->importfrom = CALENDAR_IMPORT_FROM_FILE;
- $subscription->eventtype = 'site';
- $id = calendar_add_subscription($subscription);
-
- $calendar = file_get_contents($CFG->dirroot . '/lib/tests/fixtures/osx_yosemite.ics');
- $ical = new iCalendar();
- $ical->unserialize($calendar);
- $this->assertEquals($ical->parser_errors, array());
-
- $sub = calendar_get_subscription($id);
- $result = calendar_import_icalendar_events($ical, $sub->courseid, $sub->id);
- $count = $DB->count_records('event', array('subscriptionid' => $sub->id));
- $this->assertEquals($count, 1);
-
- // Test for Google Gmail.
- $subscription = new stdClass();
- $subscription->name = 'Google Gmail';
- $subscription->importfrom = CALENDAR_IMPORT_FROM_FILE;
- $subscription->eventtype = 'site';
- $id = calendar_add_subscription($subscription);
-
- $calendar = file_get_contents($CFG->dirroot . '/lib/tests/fixtures/google_gmail.ics');
- $ical = new iCalendar();
- $ical->unserialize($calendar);
- $this->assertEquals($ical->parser_errors, array());
-
- $sub = calendar_get_subscription($id);
- $result = calendar_import_icalendar_events($ical, $sub->courseid, $sub->id);
- $count = $DB->count_records('event', array('subscriptionid' => $sub->id));
- $this->assertEquals($count, 1);
- }
-}
diff --git a/calendar/tests/lib_test.php b/calendar/tests/lib_test.php
index 3e3bb3948241b..797dc891c42c7 100644
--- a/calendar/tests/lib_test.php
+++ b/calendar/tests/lib_test.php
@@ -15,116 +15,48 @@
// along with Moodle. If not, see .
/**
- * Calendar lib unit tests
+ * Contains the class containing unit tests for the calendar lib.
*
* @package core_calendar
- * @copyright 2013 Dan Poltawski
+ * @copyright 2017 Mark Nelson
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
-global $CFG;
-require_once($CFG->dirroot . '/calendar/lib.php');
+
+require_once(__DIR__ . '/helpers.php');
/**
- * Unit tests for calendar lib
+ * Class contaning unit tests for the calendar lib.
*
* @package core_calendar
- * @copyright 2013 Dan Poltawski
+ * @copyright 2017 Mark Nelson
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_calendar_lib_testcase extends advanced_testcase {
- protected function setUp() {
- $this->resetAfterTest(true);
- }
-
- public function test_calendar_get_course_cached() {
- // Setup some test courses.
- $course1 = $this->getDataGenerator()->create_course();
- $course2 = $this->getDataGenerator()->create_course();
- $course3 = $this->getDataGenerator()->create_course();
-
- // Load courses into cache.
- $coursecache = null;
- calendar_get_course_cached($coursecache, $course1->id);
- calendar_get_course_cached($coursecache, $course2->id);
- calendar_get_course_cached($coursecache, $course3->id);
-
- // Verify the cache.
- $this->assertArrayHasKey($course1->id, $coursecache);
- $cachedcourse1 = $coursecache[$course1->id];
- $this->assertEquals($course1->id, $cachedcourse1->id);
- $this->assertEquals($course1->shortname, $cachedcourse1->shortname);
- $this->assertEquals($course1->fullname, $cachedcourse1->fullname);
-
- $this->assertArrayHasKey($course2->id, $coursecache);
- $cachedcourse2 = $coursecache[$course2->id];
- $this->assertEquals($course2->id, $cachedcourse2->id);
- $this->assertEquals($course2->shortname, $cachedcourse2->shortname);
- $this->assertEquals($course2->fullname, $cachedcourse2->fullname);
-
- $this->assertArrayHasKey($course3->id, $coursecache);
- $cachedcourse3 = $coursecache[$course3->id];
- $this->assertEquals($course3->id, $cachedcourse3->id);
- $this->assertEquals($course3->shortname, $cachedcourse3->shortname);
- $this->assertEquals($course3->fullname, $cachedcourse3->fullname);
- }
-
/**
- * Test calendar cron with a working subscription URL.
+ * Tests set up
*/
- public function test_calendar_cron_working_url() {
- global $CFG;
- require_once($CFG->dirroot . '/lib/cronlib.php');
-
- // ICal URL from external test repo.
- $subscriptionurl = $this->getExternalTestFileUrl('/ical.ics');
-
- $subscription = new stdClass();
- $subscription->eventtype = 'site';
- $subscription->name = 'test';
- $subscription->url = $subscriptionurl;
- $subscription->pollinterval = 86400;
- $subscription->lastupdated = 0;
- calendar_add_subscription($subscription);
-
- $this->expectOutputRegex('/Events imported: .* Events updated:/');
- calendar_cron();
- }
-
- /**
- * Test calendar cron with a broken subscription URL.
- */
- public function test_calendar_cron_broken_url() {
- global $CFG;
- require_once($CFG->dirroot . '/lib/cronlib.php');
-
- $subscription = new stdClass();
- $subscription->eventtype = 'site';
- $subscription->name = 'test';
- $subscription->url = 'brokenurl';
- $subscription->pollinterval = 86400;
- $subscription->lastupdated = 0;
- calendar_add_subscription($subscription);
-
- $this->expectOutputRegex('/Error updating calendar subscription: The given iCal URL is invalid/');
- calendar_cron();
+ protected function setUp() {
+ $this->resetAfterTest();
}
/**
- * Test the calendar_get_events() function only returns activity
- * events that are enabled.
+ * Test that the get_events() function only returns activity events that are enabled.
*/
- public function test_calendar_get_events_with_disabled_module() {
+ public function test_get_events_with_disabled_module() {
global $DB;
-
+ $this->setAdminUser();
$generator = $this->getDataGenerator();
$course = $generator->create_course();
+ $assigngenerator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $assigninstance = $assigngenerator->create_instance(['course' => $course->id]);
+ $lessongenerator = $this->getDataGenerator()->get_plugin_generator('mod_lesson');
+ $lessoninstance = $lessongenerator->create_instance(['course' => $course->id]);
$student = $generator->create_user();
$generator->enrol_user($student->id, $course->id, 'student');
$this->setUser($student);
-
$events = [
[
'name' => 'Start of assignment',
@@ -134,13 +66,12 @@ public function test_calendar_get_events_with_disabled_module() {
'groupid' => 0,
'userid' => 2,
'modulename' => 'assign',
- 'instance' => 1,
+ 'instance' => $assigninstance->id,
'eventtype' => 'due',
'timestart' => time(),
'timeduration' => 86400,
'visible' => 1
], [
-
'name' => 'Start of lesson',
'description' => '',
'format' => 1,
@@ -148,30 +79,25 @@ public function test_calendar_get_events_with_disabled_module() {
'groupid' => 0,
'userid' => 2,
'modulename' => 'lesson',
- 'instance' => 1,
+ 'instance' => $lessoninstance->id,
'eventtype' => 'end',
'timestart' => time(),
'timeduration' => 86400,
'visible' => 1
]
];
-
foreach ($events as $event) {
calendar_event::create($event, false);
}
-
$timestart = time() - 60;
$timeend = time() + 60;
-
// Get all events.
$events = calendar_get_events($timestart, $timeend, true, 0, true);
$this->assertCount(2, $events);
-
// Disable the lesson module.
$modulerecord = $DB->get_record('modules', ['name' => 'lesson']);
$modulerecord->visible = 0;
$DB->update_record('modules', $modulerecord);
-
// Check that we only return the assign event.
$events = calendar_get_events($timestart, $timeend, true, 0, true);
$this->assertCount(1, $events);
@@ -184,7 +110,6 @@ public function test_calendar_get_events_with_disabled_module() {
*/
public function test_calendar_get_events_with_overrides() {
global $DB;
-
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$plugingenerator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
@@ -192,31 +117,26 @@ public function test_calendar_get_events_with_overrides() {
$params['course'] = $course->id;
}
$instance = $plugingenerator->create_instance($params);
-
// Create users.
$useroverridestudent = $generator->create_user();
$group1student = $generator->create_user();
$group2student = $generator->create_user();
$group12student = $generator->create_user();
$nogroupstudent = $generator->create_user();
-
// Enrol users.
$generator->enrol_user($useroverridestudent->id, $course->id, 'student');
$generator->enrol_user($group1student->id, $course->id, 'student');
$generator->enrol_user($group2student->id, $course->id, 'student');
$generator->enrol_user($group12student->id, $course->id, 'student');
$generator->enrol_user($nogroupstudent->id, $course->id, 'student');
-
// Create groups.
$group1 = $generator->create_group(['courseid' => $course->id]);
$group2 = $generator->create_group(['courseid' => $course->id]);
-
// Add members to groups.
$generator->create_group_member(['groupid' => $group1->id, 'userid' => $group1student->id]);
$generator->create_group_member(['groupid' => $group2->id, 'userid' => $group2student->id]);
$generator->create_group_member(['groupid' => $group1->id, 'userid' => $group12student->id]);
$generator->create_group_member(['groupid' => $group2->id, 'userid' => $group12student->id]);
-
$now = time();
// Events with the same module name, instance and event type.
$events = [
@@ -277,48 +197,39 @@ public function test_calendar_get_events_with_overrides() {
'priority' => 2,
],
];
-
foreach ($events as $event) {
calendar_event::create($event, false);
}
-
$timestart = $now - 100;
$timeend = $now + (3 * 86400);
-
$groups = [$group1->id, $group2->id];
-
// Get user override events.
$this->setUser($useroverridestudent);
$events = calendar_get_events($timestart, $timeend, $useroverridestudent->id, $groups, $course->id);
$this->assertCount(1, $events);
$event = reset($events);
$this->assertEquals('Assignment 1 due date - User override', $event->name);
-
// Get event for user with override but with the timestart and timeend parameters only covering the original event.
$events = calendar_get_events($timestart, $now, $useroverridestudent->id, $groups, $course->id);
$this->assertCount(0, $events);
-
// Get events for user that does not belong to any group and has no user override events.
$this->setUser($nogroupstudent);
$events = calendar_get_events($timestart, $timeend, $nogroupstudent->id, $groups, $course->id);
$this->assertCount(1, $events);
$event = reset($events);
$this->assertEquals('Assignment 1 due date', $event->name);
-
// Get events for user that belongs to groups A and B and has no user override events.
$this->setUser($group12student);
$events = calendar_get_events($timestart, $timeend, $group12student->id, $groups, $course->id);
$this->assertCount(1, $events);
$event = reset($events);
$this->assertEquals('Assignment 1 due date - Group B override', $event->name);
-
// Get events for user that belongs to group A and has no user override events.
$this->setUser($group1student);
$events = calendar_get_events($timestart, $timeend, $group1student->id, $groups, $course->id);
$this->assertCount(1, $events);
$event = reset($events);
$this->assertEquals('Assignment 1 due date - Group A override', $event->name);
-
// Add repeating events.
$repeatingevents = [
[
@@ -328,7 +239,7 @@ public function test_calendar_get_events_with_overrides() {
'courseid' => SITEID,
'groupid' => 0,
'userid' => 2,
- 'repeatid' => 1,
+ 'repeatid' => $event->id,
'modulename' => '0',
'instance' => 0,
'eventtype' => 'site',
@@ -343,7 +254,7 @@ public function test_calendar_get_events_with_overrides() {
'courseid' => SITEID,
'groupid' => 0,
'userid' => 2,
- 'repeatid' => 1,
+ 'repeatid' => $event->id,
'modulename' => '0',
'instance' => 0,
'eventtype' => 'site',
@@ -355,9 +266,130 @@ public function test_calendar_get_events_with_overrides() {
foreach ($repeatingevents as $event) {
calendar_event::create($event, false);
}
-
// Make sure repeating events are not filtered out.
$events = calendar_get_events($timestart, $timeend, true, true, true);
$this->assertCount(3, $events);
}
-}
+
+ public function test_get_course_cached() {
+ // Setup some test courses.
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $course3 = $this->getDataGenerator()->create_course();
+
+ // Load courses into cache.
+ $coursecache = null;
+ calendar_get_course_cached($coursecache, $course1->id);
+ calendar_get_course_cached($coursecache, $course2->id);
+ calendar_get_course_cached($coursecache, $course3->id);
+
+ // Verify the cache.
+ $this->assertArrayHasKey($course1->id, $coursecache);
+ $cachedcourse1 = $coursecache[$course1->id];
+ $this->assertEquals($course1->id, $cachedcourse1->id);
+ $this->assertEquals($course1->shortname, $cachedcourse1->shortname);
+ $this->assertEquals($course1->fullname, $cachedcourse1->fullname);
+
+ $this->assertArrayHasKey($course2->id, $coursecache);
+ $cachedcourse2 = $coursecache[$course2->id];
+ $this->assertEquals($course2->id, $cachedcourse2->id);
+ $this->assertEquals($course2->shortname, $cachedcourse2->shortname);
+ $this->assertEquals($course2->fullname, $cachedcourse2->fullname);
+
+ $this->assertArrayHasKey($course3->id, $coursecache);
+ $cachedcourse3 = $coursecache[$course3->id];
+ $this->assertEquals($course3->id, $cachedcourse3->id);
+ $this->assertEquals($course3->shortname, $cachedcourse3->shortname);
+ $this->assertEquals($course3->fullname, $cachedcourse3->fullname);
+ }
+
+ /**
+ * Test the update_subscription() function.
+ */
+ public function test_update_subscription() {
+ $this->resetAfterTest(true);
+
+ $subscription = new stdClass();
+ $subscription->eventtype = 'site';
+ $subscription->name = 'test';
+ $id = calendar_add_subscription($subscription);
+
+ $subscription = calendar_get_subscription($id);
+ $subscription->name = 'awesome';
+ calendar_update_subscription($subscription);
+ $sub = calendar_get_subscription($id);
+ $this->assertEquals($subscription->name, $sub->name);
+
+ $subscription = calendar_get_subscription($id);
+ $subscription->name = 'awesome2';
+ $subscription->pollinterval = 604800;
+ calendar_update_subscription($subscription);
+ $sub = calendar_get_subscription($id);
+ $this->assertEquals($subscription->name, $sub->name);
+ $this->assertEquals($subscription->pollinterval, $sub->pollinterval);
+
+ $subscription = new stdClass();
+ $subscription->name = 'awesome4';
+ $this->expectException('coding_exception');
+ calendar_update_subscription($subscription);
+ }
+
+ public function test_add_subscription() {
+ global $DB, $CFG;
+
+ require_once($CFG->dirroot . '/lib/bennu/bennu.inc.php');
+
+ $this->resetAfterTest(true);
+
+ // Test for Microsoft Outlook 2010.
+ $subscription = new stdClass();
+ $subscription->name = 'Microsoft Outlook 2010';
+ $subscription->importfrom = CALENDAR_IMPORT_FROM_FILE;
+ $subscription->eventtype = 'site';
+ $id = calendar_add_subscription($subscription);
+
+ $calendar = file_get_contents($CFG->dirroot . '/lib/tests/fixtures/ms_outlook_2010.ics');
+ $ical = new iCalendar();
+ $ical->unserialize($calendar);
+ $this->assertEquals($ical->parser_errors, array());
+
+ $sub = calendar_get_subscription($id);
+ calendar_import_icalendar_events($ical, $sub->courseid, $sub->id);
+ $count = $DB->count_records('event', array('subscriptionid' => $sub->id));
+ $this->assertEquals($count, 1);
+
+ // Test for OSX Yosemite.
+ $subscription = new stdClass();
+ $subscription->name = 'OSX Yosemite';
+ $subscription->importfrom = CALENDAR_IMPORT_FROM_FILE;
+ $subscription->eventtype = 'site';
+ $id = calendar_add_subscription($subscription);
+
+ $calendar = file_get_contents($CFG->dirroot . '/lib/tests/fixtures/osx_yosemite.ics');
+ $ical = new iCalendar();
+ $ical->unserialize($calendar);
+ $this->assertEquals($ical->parser_errors, array());
+
+ $sub = calendar_get_subscription($id);
+ calendar_import_icalendar_events($ical, $sub->courseid, $sub->id);
+ $count = $DB->count_records('event', array('subscriptionid' => $sub->id));
+ $this->assertEquals($count, 1);
+
+ // Test for Google Gmail.
+ $subscription = new stdClass();
+ $subscription->name = 'Google Gmail';
+ $subscription->importfrom = CALENDAR_IMPORT_FROM_FILE;
+ $subscription->eventtype = 'site';
+ $id = calendar_add_subscription($subscription);
+
+ $calendar = file_get_contents($CFG->dirroot . '/lib/tests/fixtures/google_gmail.ics');
+ $ical = new iCalendar();
+ $ical->unserialize($calendar);
+ $this->assertEquals($ical->parser_errors, array());
+
+ $sub = calendar_get_subscription($id);
+ calendar_import_icalendar_events($ical, $sub->courseid, $sub->id);
+ $count = $DB->count_records('event', array('subscriptionid' => $sub->id));
+ $this->assertEquals($count, 1);
+ }
+}
\ No newline at end of file
diff --git a/calendar/tests/local_api_test.php b/calendar/tests/local_api_test.php
new file mode 100644
index 0000000000000..599a605204869
--- /dev/null
+++ b/calendar/tests/local_api_test.php
@@ -0,0 +1,861 @@
+.
+
+/**
+ * Contains the class containing unit tests for the calendar local API.
+ *
+ * @package core_calendar
+ * @copyright 2017 Mark Nelson
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once(__DIR__ . '/helpers.php');
+
+/**
+ * Class contaning unit tests for the calendar local API.
+ *
+ * @package core_calendar
+ * @copyright 2017 Mark Nelson
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_local_api_testcase extends advanced_testcase {
+
+ /**
+ * Tests set up
+ */
+ protected function setUp() {
+ $this->resetAfterTest();
+ }
+
+ /**
+ * Requesting calendar events from a given time should return all events with a sort
+ * time at or after the requested time. All events prior to that time should not
+ * be return.
+ *
+ * If there are no events on or after the given time then an empty result set should
+ * be returned.
+ */
+ public function test_get_calendar_action_events_by_timesort_after_time() {
+ $user = $this->getDataGenerator()->create_user();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance = $generator->create_instance(['course' => $course->id]);
+
+ $this->getDataGenerator()->enrol_user($user->id, $course->id);
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+
+ $params = [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course->id,
+ 'modulename' => 'assign',
+ 'instance' => $moduleinstance->id,
+ 'userid' => $user->id,
+ 'eventtype' => 'user',
+ 'repeats' => 0,
+ 'timestart' => 1,
+ ];
+
+ $event1 = create_event(array_merge($params, ['name' => 'Event 1', 'timesort' => 1]));
+ $event2 = create_event(array_merge($params, ['name' => 'Event 2', 'timesort' => 2]));
+ $event3 = create_event(array_merge($params, ['name' => 'Event 3', 'timesort' => 3]));
+ $event4 = create_event(array_merge($params, ['name' => 'Event 4', 'timesort' => 4]));
+ $event5 = create_event(array_merge($params, ['name' => 'Event 5', 'timesort' => 5]));
+ $event6 = create_event(array_merge($params, ['name' => 'Event 6', 'timesort' => 6]));
+ $event7 = create_event(array_merge($params, ['name' => 'Event 7', 'timesort' => 7]));
+ $event8 = create_event(array_merge($params, ['name' => 'Event 8', 'timesort' => 8]));
+
+ $this->setUser($user);
+ $result = \core_calendar\local\api::get_action_events_by_timesort(5);
+
+ $this->assertCount(4, $result);
+ $this->assertEquals('Event 5', $result[0]->get_name());
+ $this->assertEquals('Event 6', $result[1]->get_name());
+ $this->assertEquals('Event 7', $result[2]->get_name());
+ $this->assertEquals('Event 8', $result[3]->get_name());
+
+ $result = \core_calendar\local\api::get_action_events_by_timesort(9);
+
+ $this->assertEmpty($result);
+ }
+
+ /**
+ * Requesting calendar events before a given time should return all events with a sort
+ * time at or before the requested time (inclusive). All events after that time
+ * should not be returned.
+ *
+ * If there are no events before the given time then an empty result set should be
+ * returned.
+ */
+ public function test_get_calendar_action_events_by_timesort_before_time() {
+ $user = $this->getDataGenerator()->create_user();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance = $generator->create_instance(['course' => $course->id]);
+
+ $this->getDataGenerator()->enrol_user($user->id, $course->id);
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+
+ $params = [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course->id,
+ 'modulename' => 'assign',
+ 'instance' => $moduleinstance->id,
+ 'userid' => 1,
+ 'eventtype' => 'user',
+ 'repeats' => 0,
+ 'timestart' => 1,
+ ];
+
+ $event1 = create_event(array_merge($params, ['name' => 'Event 1', 'timesort' => 2]));
+ $event2 = create_event(array_merge($params, ['name' => 'Event 2', 'timesort' => 3]));
+ $event3 = create_event(array_merge($params, ['name' => 'Event 3', 'timesort' => 4]));
+ $event4 = create_event(array_merge($params, ['name' => 'Event 4', 'timesort' => 5]));
+ $event5 = create_event(array_merge($params, ['name' => 'Event 5', 'timesort' => 6]));
+ $event6 = create_event(array_merge($params, ['name' => 'Event 6', 'timesort' => 7]));
+ $event7 = create_event(array_merge($params, ['name' => 'Event 7', 'timesort' => 8]));
+ $event8 = create_event(array_merge($params, ['name' => 'Event 8', 'timesort' => 9]));
+
+ $this->setUser($user);
+ $result = \core_calendar\local\api::get_action_events_by_timesort(null, 5);
+
+ $this->assertCount(4, $result);
+ $this->assertEquals('Event 1', $result[0]->get_name());
+ $this->assertEquals('Event 2', $result[1]->get_name());
+ $this->assertEquals('Event 3', $result[2]->get_name());
+ $this->assertEquals('Event 4', $result[3]->get_name());
+
+ $result = \core_calendar\local\api::get_action_events_by_timesort(null, 1);
+
+ $this->assertEmpty($result);
+ }
+
+ /**
+ * Requesting calendar events within a given time range should return all events with
+ * a sort time between the lower and upper time bound (inclusive).
+ *
+ * If there are no events in the given time range then an empty result set should be
+ * returned.
+ */
+ public function test_get_calendar_action_events_by_timesort_time_range() {
+ $user = $this->getDataGenerator()->create_user();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance = $generator->create_instance(['course' => $course->id]);
+
+ $this->getDataGenerator()->enrol_user($user->id, $course->id);
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+
+ $params = [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course->id,
+ 'modulename' => 'assign',
+ 'instance' => $moduleinstance->id,
+ 'userid' => 1,
+ 'eventtype' => 'user',
+ 'repeats' => 0,
+ 'timestart' => 1,
+ ];
+
+ $event1 = create_event(array_merge($params, ['name' => 'Event 1', 'timesort' => 1]));
+ $event2 = create_event(array_merge($params, ['name' => 'Event 2', 'timesort' => 2]));
+ $event3 = create_event(array_merge($params, ['name' => 'Event 3', 'timesort' => 3]));
+ $event4 = create_event(array_merge($params, ['name' => 'Event 4', 'timesort' => 4]));
+ $event5 = create_event(array_merge($params, ['name' => 'Event 5', 'timesort' => 5]));
+ $event6 = create_event(array_merge($params, ['name' => 'Event 6', 'timesort' => 6]));
+ $event7 = create_event(array_merge($params, ['name' => 'Event 7', 'timesort' => 7]));
+ $event8 = create_event(array_merge($params, ['name' => 'Event 8', 'timesort' => 8]));
+
+ $this->setUser($user);
+ $result = \core_calendar\local\api::get_action_events_by_timesort(3, 6);
+
+ $this->assertCount(4, $result);
+ $this->assertEquals('Event 3', $result[0]->get_name());
+ $this->assertEquals('Event 4', $result[1]->get_name());
+ $this->assertEquals('Event 5', $result[2]->get_name());
+ $this->assertEquals('Event 6', $result[3]->get_name());
+
+ $result = \core_calendar\local\api::get_action_events_by_timesort(10, 15);
+
+ $this->assertEmpty($result);
+ }
+
+ /**
+ * Requesting calendar events within a given time range and a limit and offset should return
+ * the number of events up to the given limit value that have a sort time between the lower
+ * and uppper time bound (inclusive) where the result set is shifted by the offset value.
+ *
+ * If there are no events in the given time range then an empty result set should be
+ * returned.
+ */
+ public function test_get_calendar_action_events_by_timesort_time_limit_offset() {
+ $user = $this->getDataGenerator()->create_user();
+ $course = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance = $generator->create_instance(['course' => $course->id]);
+
+ $this->getDataGenerator()->enrol_user($user->id, $course->id);
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+
+ $params = [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'courseid' => $course->id,
+ 'modulename' => 'assign',
+ 'instance' => $moduleinstance->id,
+ 'userid' => 1,
+ 'eventtype' => 'user',
+ 'repeats' => 0,
+ 'timestart' => 1,
+ ];
+
+ $event1 = create_event(array_merge($params, ['name' => 'Event 1', 'timesort' => 1]));
+ $event2 = create_event(array_merge($params, ['name' => 'Event 2', 'timesort' => 2]));
+ $event3 = create_event(array_merge($params, ['name' => 'Event 3', 'timesort' => 3]));
+ $event4 = create_event(array_merge($params, ['name' => 'Event 4', 'timesort' => 4]));
+ $event5 = create_event(array_merge($params, ['name' => 'Event 5', 'timesort' => 5]));
+ $event6 = create_event(array_merge($params, ['name' => 'Event 6', 'timesort' => 6]));
+ $event7 = create_event(array_merge($params, ['name' => 'Event 7', 'timesort' => 7]));
+ $event8 = create_event(array_merge($params, ['name' => 'Event 8', 'timesort' => 8]));
+
+ $this->setUser($user);
+ $result = \core_calendar\local\api::get_action_events_by_timesort(2, 7, $event3->id, 2);
+
+ $this->assertCount(2, $result);
+ $this->assertEquals('Event 4', $result[0]->get_name());
+ $this->assertEquals('Event 5', $result[1]->get_name());
+
+ $result = \core_calendar\local\api::get_action_events_by_timesort(2, 7, $event5->id, 2);
+
+ $this->assertCount(2, $result);
+ $this->assertEquals('Event 6', $result[0]->get_name());
+ $this->assertEquals('Event 7', $result[1]->get_name());
+
+ $result = \core_calendar\local\api::get_action_events_by_timesort(2, 7, $event7->id, 2);
+
+ $this->assertEmpty($result);
+ }
+
+ /**
+ * Requesting calendar events from a given course and time should return all
+ * events with a sort time at or after the requested time. All events prior
+ * to that time should not be return.
+ *
+ * If there are no events on or after the given time then an empty result set should
+ * be returned.
+ */
+ public function test_get_calendar_action_events_by_course_after_time() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance1 = $generator->create_instance(['course' => $course1->id]);
+ $moduleinstance2 = $generator->create_instance(['course' => $course2->id]);
+
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+ $this->resetAfterTest(true);
+ $this->setUser($user);
+
+ $params = [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'modulename' => 'assign',
+ 'instance' => $moduleinstance1->id,
+ 'userid' => $user->id,
+ 'courseid' => $course1->id,
+ 'eventtype' => 'user',
+ 'repeats' => 0,
+ 'timestart' => 1,
+ ];
+
+ $event1 = create_event(array_merge($params, ['name' => 'Event 1', 'timesort' => 1]));
+ $event2 = create_event(array_merge($params, ['name' => 'Event 2', 'timesort' => 2]));
+ $event3 = create_event(array_merge($params, ['name' => 'Event 3', 'timesort' => 3]));
+ $event4 = create_event(array_merge($params, ['name' => 'Event 4', 'timesort' => 4]));
+ $event5 = create_event(array_merge($params, ['name' => 'Event 5', 'timesort' => 5]));
+ $event6 = create_event(array_merge($params, ['name' => 'Event 6', 'timesort' => 6]));
+ $event7 = create_event(array_merge($params, ['name' => 'Event 7', 'timesort' => 7]));
+ $event8 = create_event(array_merge($params, ['name' => 'Event 8', 'timesort' => 8]));
+
+ $params['courseid'] = $course2->id;
+ $params['instance'] = $moduleinstance2->id;
+ $event9 = create_event(array_merge($params, ['name' => 'Event 9', 'timesort' => 1]));
+ $event10 = create_event(array_merge($params, ['name' => 'Event 10', 'timesort' => 2]));
+ $event11 = create_event(array_merge($params, ['name' => 'Event 11', 'timesort' => 3]));
+ $event12 = create_event(array_merge($params, ['name' => 'Event 12', 'timesort' => 4]));
+ $event13 = create_event(array_merge($params, ['name' => 'Event 13', 'timesort' => 5]));
+ $event14 = create_event(array_merge($params, ['name' => 'Event 14', 'timesort' => 6]));
+ $event15 = create_event(array_merge($params, ['name' => 'Event 15', 'timesort' => 7]));
+ $event16 = create_event(array_merge($params, ['name' => 'Event 16', 'timesort' => 8]));
+
+ $result = \core_calendar\local\api::get_action_events_by_course($course1, 5);
+
+ $this->assertCount(4, $result);
+ $this->assertEquals('Event 5', $result[0]->get_name());
+ $this->assertEquals('Event 6', $result[1]->get_name());
+ $this->assertEquals('Event 7', $result[2]->get_name());
+ $this->assertEquals('Event 8', $result[3]->get_name());
+
+ $result = \core_calendar\local\api::get_action_events_by_course($course1, 9);
+
+ $this->assertEmpty($result);
+ }
+
+ /**
+ * Requesting calendar events for a course and before a given time should return
+ * all events with a sort time at or before the requested time (inclusive). All
+ * events after that time should not be returned.
+ *
+ * If there are no events before the given time then an empty result set should be
+ * returned.
+ */
+ public function test_get_calendar_action_events_by_course_before_time() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance1 = $generator->create_instance(['course' => $course1->id]);
+ $moduleinstance2 = $generator->create_instance(['course' => $course2->id]);
+
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+ $this->resetAfterTest(true);
+ $this->setUser($user);
+
+ $params = [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'modulename' => 'assign',
+ 'instance' => $moduleinstance1->id,
+ 'userid' => $user->id,
+ 'courseid' => $course1->id,
+ 'eventtype' => 'user',
+ 'repeats' => 0,
+ 'timestart' => 1,
+ ];
+
+ $event1 = create_event(array_merge($params, ['name' => 'Event 1', 'timesort' => 2]));
+ $event2 = create_event(array_merge($params, ['name' => 'Event 2', 'timesort' => 3]));
+ $event3 = create_event(array_merge($params, ['name' => 'Event 3', 'timesort' => 4]));
+ $event4 = create_event(array_merge($params, ['name' => 'Event 4', 'timesort' => 5]));
+ $event5 = create_event(array_merge($params, ['name' => 'Event 5', 'timesort' => 6]));
+ $event6 = create_event(array_merge($params, ['name' => 'Event 6', 'timesort' => 7]));
+ $event7 = create_event(array_merge($params, ['name' => 'Event 7', 'timesort' => 8]));
+ $event8 = create_event(array_merge($params, ['name' => 'Event 8', 'timesort' => 9]));
+
+ $params['courseid'] = $course2->id;
+ $params['instance'] = $moduleinstance2->id;
+ $event9 = create_event(array_merge($params, ['name' => 'Event 9', 'timesort' => 2]));
+ $event10 = create_event(array_merge($params, ['name' => 'Event 10', 'timesort' => 3]));
+ $event11 = create_event(array_merge($params, ['name' => 'Event 11', 'timesort' => 4]));
+ $event12 = create_event(array_merge($params, ['name' => 'Event 12', 'timesort' => 5]));
+ $event13 = create_event(array_merge($params, ['name' => 'Event 13', 'timesort' => 6]));
+ $event14 = create_event(array_merge($params, ['name' => 'Event 14', 'timesort' => 7]));
+ $event15 = create_event(array_merge($params, ['name' => 'Event 15', 'timesort' => 8]));
+ $event16 = create_event(array_merge($params, ['name' => 'Event 16', 'timesort' => 9]));
+
+ $result = \core_calendar\local\api::get_action_events_by_course($course1, null, 5);
+
+ $this->assertCount(4, $result);
+ $this->assertEquals('Event 1', $result[0]->get_name());
+ $this->assertEquals('Event 2', $result[1]->get_name());
+ $this->assertEquals('Event 3', $result[2]->get_name());
+ $this->assertEquals('Event 4', $result[3]->get_name());
+
+ $result = \core_calendar\local\api::get_action_events_by_course($course1, null, 1);
+
+ $this->assertEmpty($result);
+ }
+
+ /**
+ * Requesting calendar events for a course and within a given time range should
+ * return all events with a sort time between the lower and upper time bound
+ * (inclusive).
+ *
+ * If there are no events in the given time range then an empty result set should be
+ * returned.
+ */
+ public function test_get_calendar_action_events_by_course_time_range() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance1 = $generator->create_instance(['course' => $course1->id]);
+ $moduleinstance2 = $generator->create_instance(['course' => $course2->id]);
+
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+ $this->resetAfterTest(true);
+ $this->setUser($user);
+
+ $params = [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'modulename' => 'assign',
+ 'instance' => $moduleinstance1->id,
+ 'userid' => $user->id,
+ 'courseid' => $course1->id,
+ 'eventtype' => 'user',
+ 'repeats' => 0,
+ 'timestart' => 1,
+ ];
+
+ $event1 = create_event(array_merge($params, ['name' => 'Event 1', 'timesort' => 1]));
+ $event2 = create_event(array_merge($params, ['name' => 'Event 2', 'timesort' => 2]));
+ $event3 = create_event(array_merge($params, ['name' => 'Event 3', 'timesort' => 3]));
+ $event4 = create_event(array_merge($params, ['name' => 'Event 4', 'timesort' => 4]));
+ $event5 = create_event(array_merge($params, ['name' => 'Event 5', 'timesort' => 5]));
+ $event6 = create_event(array_merge($params, ['name' => 'Event 6', 'timesort' => 6]));
+ $event7 = create_event(array_merge($params, ['name' => 'Event 7', 'timesort' => 7]));
+ $event8 = create_event(array_merge($params, ['name' => 'Event 8', 'timesort' => 8]));
+
+ $params['courseid'] = $course2->id;
+ $params['instance'] = $moduleinstance2->id;
+ $event9 = create_event(array_merge($params, ['name' => 'Event 9', 'timesort' => 1]));
+ $event10 = create_event(array_merge($params, ['name' => 'Event 10', 'timesort' => 2]));
+ $event11 = create_event(array_merge($params, ['name' => 'Event 11', 'timesort' => 3]));
+ $event12 = create_event(array_merge($params, ['name' => 'Event 12', 'timesort' => 4]));
+ $event13 = create_event(array_merge($params, ['name' => 'Event 13', 'timesort' => 5]));
+ $event14 = create_event(array_merge($params, ['name' => 'Event 14', 'timesort' => 6]));
+ $event15 = create_event(array_merge($params, ['name' => 'Event 15', 'timesort' => 7]));
+ $event16 = create_event(array_merge($params, ['name' => 'Event 16', 'timesort' => 8]));
+
+ $result = \core_calendar\local\api::get_action_events_by_course($course1, 3, 6);
+
+ $this->assertCount(4, $result);
+ $this->assertEquals('Event 3', $result[0]->get_name());
+ $this->assertEquals('Event 4', $result[1]->get_name());
+ $this->assertEquals('Event 5', $result[2]->get_name());
+ $this->assertEquals('Event 6', $result[3]->get_name());
+
+ $result = \core_calendar\local\api::get_action_events_by_course($course1, 10, 15);
+
+ $this->assertEmpty($result);
+ }
+
+ /**
+ * Requesting calendar events for a course and within a given time range and a limit
+ * and offset should return the number of events up to the given limit value that have
+ * a sort time between the lower and uppper time bound (inclusive) where the result
+ * set is shifted by the offset value.
+ *
+ * If there are no events in the given time range then an empty result set should be
+ * returned.
+ */
+ public function test_get_calendar_action_events_by_course_time_limit_offset() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance1 = $generator->create_instance(['course' => $course1->id]);
+ $moduleinstance2 = $generator->create_instance(['course' => $course2->id]);
+
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+ $this->resetAfterTest(true);
+ $this->setUser($user);
+
+ $params = [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'modulename' => 'assign',
+ 'instance' => $moduleinstance1->id,
+ 'userid' => $user->id,
+ 'courseid' => $course1->id,
+ 'eventtype' => 'user',
+ 'repeats' => 0,
+ 'timestart' => 1,
+ ];
+
+ $event1 = create_event(array_merge($params, ['name' => 'Event 1', 'timesort' => 1]));
+ $event2 = create_event(array_merge($params, ['name' => 'Event 2', 'timesort' => 2]));
+ $event3 = create_event(array_merge($params, ['name' => 'Event 3', 'timesort' => 3]));
+ $event4 = create_event(array_merge($params, ['name' => 'Event 4', 'timesort' => 4]));
+ $event5 = create_event(array_merge($params, ['name' => 'Event 5', 'timesort' => 5]));
+ $event6 = create_event(array_merge($params, ['name' => 'Event 6', 'timesort' => 6]));
+ $event7 = create_event(array_merge($params, ['name' => 'Event 7', 'timesort' => 7]));
+ $event8 = create_event(array_merge($params, ['name' => 'Event 8', 'timesort' => 8]));
+
+ $params['courseid'] = $course2->id;
+ $params['instance'] = $moduleinstance2->id;
+ $event9 = create_event(array_merge($params, ['name' => 'Event 9', 'timesort' => 1]));
+ $event10 = create_event(array_merge($params, ['name' => 'Event 10', 'timesort' => 2]));
+ $event11 = create_event(array_merge($params, ['name' => 'Event 11', 'timesort' => 3]));
+ $event12 = create_event(array_merge($params, ['name' => 'Event 12', 'timesort' => 4]));
+ $event13 = create_event(array_merge($params, ['name' => 'Event 13', 'timesort' => 5]));
+ $event14 = create_event(array_merge($params, ['name' => 'Event 14', 'timesort' => 6]));
+ $event15 = create_event(array_merge($params, ['name' => 'Event 15', 'timesort' => 7]));
+ $event16 = create_event(array_merge($params, ['name' => 'Event 16', 'timesort' => 8]));
+
+ $result = \core_calendar\local\api::get_action_events_by_course($course1, 2, 7, $event3->id, 2);
+
+ $this->assertCount(2, $result);
+ $this->assertEquals('Event 4', $result[0]->get_name());
+ $this->assertEquals('Event 5', $result[1]->get_name());
+
+ $result = \core_calendar\local\api::get_action_events_by_course($course1, 2, 7, $event5->id, 2);
+
+ $this->assertCount(2, $result);
+ $this->assertEquals('Event 6', $result[0]->get_name());
+ $this->assertEquals('Event 7', $result[1]->get_name());
+
+ $result = \core_calendar\local\api::get_action_events_by_course($course1, 2, 7, $event7->id, 2);
+
+ $this->assertEmpty($result);
+ }
+
+ /**
+ * Test that get_action_events_by_courses will return a list of events for each
+ * course you provided as long as the user is enrolled in the course.
+ */
+ public function test_get_action_events_by_courses() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $course3 = $this->getDataGenerator()->create_course();
+ $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $moduleinstance1 = $generator->create_instance(['course' => $course1->id]);
+ $moduleinstance2 = $generator->create_instance(['course' => $course2->id]);
+ $moduleinstance3 = $generator->create_instance(['course' => $course3->id]);
+
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course3->id);
+ $this->resetAfterTest(true);
+ $this->setUser($user);
+
+ $params = [
+ 'type' => CALENDAR_EVENT_TYPE_ACTION,
+ 'modulename' => 'assign',
+ 'instance' => $moduleinstance1->id,
+ 'userid' => $user->id,
+ 'courseid' => $course1->id,
+ 'eventtype' => 'user',
+ 'repeats' => 0,
+ 'timestart' => 1,
+ ];
+
+ $event1 = create_event(array_merge($params, ['name' => 'Event 1', 'timesort' => 1]));
+ $event2 = create_event(array_merge($params, ['name' => 'Event 2', 'timesort' => 2]));
+
+ $params['courseid'] = $course2->id;
+ $params['instance'] = $moduleinstance2->id;
+ $event3 = create_event(array_merge($params, ['name' => 'Event 3', 'timesort' => 3]));
+ $event4 = create_event(array_merge($params, ['name' => 'Event 4', 'timesort' => 4]));
+ $event5 = create_event(array_merge($params, ['name' => 'Event 5', 'timesort' => 5]));
+
+ $params['courseid'] = $course3->id;
+ $params['instance'] = $moduleinstance3->id;
+ $event6 = create_event(array_merge($params, ['name' => 'Event 6', 'timesort' => 6]));
+ $event7 = create_event(array_merge($params, ['name' => 'Event 7', 'timesort' => 7]));
+ $event8 = create_event(array_merge($params, ['name' => 'Event 8', 'timesort' => 8]));
+ $event9 = create_event(array_merge($params, ['name' => 'Event 9', 'timesort' => 9]));
+
+ $result = \core_calendar\local\api::get_action_events_by_courses([], 1);
+
+ $this->assertEmpty($result);
+
+ $result = \core_calendar\local\api::get_action_events_by_courses([$course1], 3);
+
+ $this->assertEmpty($result[$course1->id]);
+
+ $result = \core_calendar\local\api::get_action_events_by_courses([$course1], 1);
+
+ $this->assertCount(2, $result[$course1->id]);
+ $this->assertEquals('Event 1', $result[$course1->id][0]->get_name());
+ $this->assertEquals('Event 2', $result[$course1->id][1]->get_name());
+
+ $result = \core_calendar\local\api::get_action_events_by_courses([$course1, $course2], 1);
+
+ $this->assertCount(2, $result[$course1->id]);
+ $this->assertEquals('Event 1', $result[$course1->id][0]->get_name());
+ $this->assertEquals('Event 2', $result[$course1->id][1]->get_name());
+ $this->assertCount(3, $result[$course2->id]);
+ $this->assertEquals('Event 3', $result[$course2->id][0]->get_name());
+ $this->assertEquals('Event 4', $result[$course2->id][1]->get_name());
+ $this->assertEquals('Event 5', $result[$course2->id][2]->get_name());
+
+ $result = \core_calendar\local\api::get_action_events_by_courses([$course1, $course2], 2, 4);
+
+ $this->assertCount(1, $result[$course1->id]);
+ $this->assertEquals('Event 2', $result[$course1->id][0]->get_name());
+ $this->assertCount(2, $result[$course2->id]);
+ $this->assertEquals('Event 3', $result[$course2->id][0]->get_name());
+ $this->assertEquals('Event 4', $result[$course2->id][1]->get_name());
+
+ $result = \core_calendar\local\api::get_action_events_by_courses([$course1, $course2, $course3], 1, null, 1);
+
+ $this->assertCount(1, $result[$course1->id]);
+ $this->assertEquals('Event 1', $result[$course1->id][0]->get_name());
+ $this->assertCount(1, $result[$course2->id]);
+ $this->assertEquals('Event 3', $result[$course2->id][0]->get_name());
+ $this->assertCount(1, $result[$course3->id]);
+ $this->assertEquals('Event 6', $result[$course3->id][0]->get_name());
+ }
+
+ /**
+ * Test that the get_legacy_events() function only returns activity events that are enabled.
+ */
+ public function test_get_legacy_events_with_disabled_module() {
+ global $DB;
+
+ $this->setAdminUser();
+
+ $course = $this->getDataGenerator()->create_course();
+
+ $assigngenerator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ $assigninstance = $assigngenerator->create_instance(['course' => $course->id]);
+
+ $lessongenerator = $this->getDataGenerator()->get_plugin_generator('mod_lesson');
+ $lessoninstance = $lessongenerator->create_instance(['course' => $course->id]);
+ $student = $this->getDataGenerator()->create_user();
+ $this->getDataGenerator()->enrol_user($student->id, $course->id, 'student');
+ $this->setUser($student);
+ $events = [
+ [
+ 'name' => 'Start of assignment',
+ 'description' => '',
+ 'format' => 1,
+ 'courseid' => $course->id,
+ 'groupid' => 0,
+ 'userid' => 2,
+ 'modulename' => 'assign',
+ 'instance' => $assigninstance->id,
+ 'eventtype' => 'due',
+ 'timestart' => time(),
+ 'timeduration' => 86400,
+ 'visible' => 1
+ ], [
+ 'name' => 'Start of lesson',
+ 'description' => '',
+ 'format' => 1,
+ 'courseid' => $course->id,
+ 'groupid' => 0,
+ 'userid' => 2,
+ 'modulename' => 'lesson',
+ 'instance' => $lessoninstance->id,
+ 'eventtype' => 'end',
+ 'timestart' => time(),
+ 'timeduration' => 86400,
+ 'visible' => 1
+ ]
+ ];
+ foreach ($events as $event) {
+ calendar_event::create($event, false);
+ }
+ $timestart = time() - 60;
+ $timeend = time() + 60;
+
+ // Get all events.
+ $events = \core_calendar\local\api::get_legacy_events($timestart, $timeend, true, 0, true);
+ $this->assertCount(2, $events);
+
+ // Disable the lesson module.
+ $modulerecord = $DB->get_record('modules', ['name' => 'lesson']);
+ $modulerecord->visible = 0;
+ $DB->update_record('modules', $modulerecord);
+
+ // Check that we only return the assign event.
+ $events = \core_calendar\local\api::get_legacy_events($timestart, $timeend, true, 0, true);
+ $this->assertCount(1, $events);
+ $event = reset($events);
+ $this->assertEquals('assign', $event->modulename);
+ }
+
+ /**
+ * Test for \core_calendar\local\api::get_legacy_events() when there are user and group overrides.
+ */
+ public function test_get_legacy_events_with_overrides() {
+ $generator = $this->getDataGenerator();
+
+ $course = $generator->create_course();
+
+ $plugingenerator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+ if (!isset($params['course'])) {
+ $params['course'] = $course->id;
+ }
+
+ $instance = $plugingenerator->create_instance($params);
+
+ // Create users.
+ $useroverridestudent = $generator->create_user();
+ $group1student = $generator->create_user();
+ $group2student = $generator->create_user();
+ $group12student = $generator->create_user();
+ $nogroupstudent = $generator->create_user();
+
+ // Enrol users.
+ $generator->enrol_user($useroverridestudent->id, $course->id, 'student');
+ $generator->enrol_user($group1student->id, $course->id, 'student');
+ $generator->enrol_user($group2student->id, $course->id, 'student');
+ $generator->enrol_user($group12student->id, $course->id, 'student');
+ $generator->enrol_user($nogroupstudent->id, $course->id, 'student');
+
+ // Create groups.
+ $group1 = $generator->create_group(['courseid' => $course->id]);
+ $group2 = $generator->create_group(['courseid' => $course->id]);
+
+ // Add members to groups.
+ $generator->create_group_member(['groupid' => $group1->id, 'userid' => $group1student->id]);
+ $generator->create_group_member(['groupid' => $group2->id, 'userid' => $group2student->id]);
+ $generator->create_group_member(['groupid' => $group1->id, 'userid' => $group12student->id]);
+ $generator->create_group_member(['groupid' => $group2->id, 'userid' => $group12student->id]);
+ $now = time();
+
+ // Events with the same module name, instance and event type.
+ $events = [
+ [
+ 'name' => 'Assignment 1 due date',
+ 'description' => '',
+ 'format' => 0,
+ 'courseid' => $course->id,
+ 'groupid' => 0,
+ 'userid' => 2,
+ 'modulename' => 'assign',
+ 'instance' => $instance->id,
+ 'eventtype' => 'due',
+ 'timestart' => $now,
+ 'timeduration' => 0,
+ 'visible' => 1
+ ], [
+ 'name' => 'Assignment 1 due date - User override',
+ 'description' => '',
+ 'format' => 1,
+ 'courseid' => 0,
+ 'groupid' => 0,
+ 'userid' => $useroverridestudent->id,
+ 'modulename' => 'assign',
+ 'instance' => $instance->id,
+ 'eventtype' => 'due',
+ 'timestart' => $now + 86400,
+ 'timeduration' => 0,
+ 'visible' => 1,
+ 'priority' => CALENDAR_EVENT_USER_OVERRIDE_PRIORITY
+ ], [
+ 'name' => 'Assignment 1 due date - Group A override',
+ 'description' => '',
+ 'format' => 1,
+ 'courseid' => $course->id,
+ 'groupid' => $group1->id,
+ 'userid' => 2,
+ 'modulename' => 'assign',
+ 'instance' => $instance->id,
+ 'eventtype' => 'due',
+ 'timestart' => $now + (2 * 86400),
+ 'timeduration' => 0,
+ 'visible' => 1,
+ 'priority' => 1,
+ ], [
+ 'name' => 'Assignment 1 due date - Group B override',
+ 'description' => '',
+ 'format' => 1,
+ 'courseid' => $course->id,
+ 'groupid' => $group2->id,
+ 'userid' => 2,
+ 'modulename' => 'assign',
+ 'instance' => $instance->id,
+ 'eventtype' => 'due',
+ 'timestart' => $now + (3 * 86400),
+ 'timeduration' => 0,
+ 'visible' => 1,
+ 'priority' => 2,
+ ],
+ ];
+
+ foreach ($events as $event) {
+ calendar_event::create($event, false);
+ }
+
+ $timestart = $now - 100;
+ $timeend = $now + (3 * 86400);
+ $groups = [$group1->id, $group2->id];
+
+ // Get user override events.
+ $this->setUser($useroverridestudent);
+ $events = \core_calendar\local\api::get_legacy_events($timestart, $timeend, $useroverridestudent->id, $groups, $course->id);
+ $this->assertCount(1, $events);
+ $event = reset($events);
+ $this->assertEquals('Assignment 1 due date - User override', $event->name);
+
+ // Get event for user with override but with the timestart and timeend parameters only covering the original event.
+ $events = \core_calendar\local\api::get_legacy_events($timestart, $now, $useroverridestudent->id, $groups, $course->id);
+ $this->assertCount(0, $events);
+
+ // Get events for user that does not belong to any group and has no user override events.
+ $this->setUser($nogroupstudent);
+ $events = \core_calendar\local\api::get_legacy_events($timestart, $timeend, $nogroupstudent->id, $groups, $course->id);
+ $this->assertCount(1, $events);
+ $event = reset($events);
+ $this->assertEquals('Assignment 1 due date', $event->name);
+
+ // Get events for user that belongs to groups A and B and has no user override events.
+ $this->setUser($group12student);
+ $events = \core_calendar\local\api::get_legacy_events($timestart, $timeend, $group12student->id, $groups, $course->id);
+ $this->assertCount(1, $events);
+ $event = reset($events);
+ $this->assertEquals('Assignment 1 due date - Group B override', $event->name);
+
+ // Get events for user that belongs to group A and has no user override events.
+ $this->setUser($group1student);
+ $events = \core_calendar\local\api::get_legacy_events($timestart, $timeend, $group1student->id, $groups, $course->id);
+ $this->assertCount(1, $events);
+ $event = reset($events);
+ $this->assertEquals('Assignment 1 due date - Group A override', $event->name);
+
+ // Add repeating events.
+ $repeatingevents = [
+ [
+ 'name' => 'Repeating site event',
+ 'description' => '',
+ 'format' => 1,
+ 'courseid' => SITEID,
+ 'groupid' => 0,
+ 'userid' => 2,
+ 'repeatid' => $event->id,
+ 'modulename' => '0',
+ 'instance' => 0,
+ 'eventtype' => 'site',
+ 'timestart' => $now + 86400,
+ 'timeduration' => 0,
+ 'visible' => 1,
+ ],
+ [
+ 'name' => 'Repeating site event',
+ 'description' => '',
+ 'format' => 1,
+ 'courseid' => SITEID,
+ 'groupid' => 0,
+ 'userid' => 2,
+ 'repeatid' => $event->id,
+ 'modulename' => '0',
+ 'instance' => 0,
+ 'eventtype' => 'site',
+ 'timestart' => $now + (2 * 86400),
+ 'timeduration' => 0,
+ 'visible' => 1,
+ ],
+ ];
+
+ foreach ($repeatingevents as $event) {
+ calendar_event::create($event, false);
+ }
+
+ // Make sure repeating events are not filtered out.
+ $events = \core_calendar\local\api::get_legacy_events($timestart, $timeend, true, true, true);
+ $this->assertCount(3, $events);
+ }
+}
diff --git a/calendar/tests/module_std_proxy_test.php b/calendar/tests/module_std_proxy_test.php
new file mode 100644
index 0000000000000..c279eec806bd3
--- /dev/null
+++ b/calendar/tests/module_std_proxy_test.php
@@ -0,0 +1,219 @@
+.
+
+/**
+ * module_std_proxy tests.
+ *
+ * @package core_calendar
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+use core_calendar\local\event\proxies\module_std_proxy;
+
+/**
+ * std_proxy testcase.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_module_std_proxy_testcase extends advanced_testcase {
+ /**
+ * @var \stdClass[] $objects Array of objects to proxy.
+ */
+ public $objects;
+
+ /**
+ * Sets up the fixture. This method is called before a test is executed.
+ */
+ public function setUp() {
+ $this->objects = [
+ 'somemodule_someinstance' => (object) [
+ 'member1' => 'Hello',
+ 'member2' => 1729,
+ 'member3' => 'Something else'
+ ],
+ 'anothermodule_anotherinstance' => (object) [
+ 'member1' => 'Hej',
+ 'member2' => 87539319,
+ 'member3' => 'nagot annat'
+ ]
+ ];
+ }
+
+ /**
+ * Test proxying.
+ *
+ * @dataProvider test_proxy_testcases()
+ * @param string $modulename Object module name.
+ * @param string $instance Object instance.
+ * @param string $member Object member to retrieve.
+ * @param mixed $expected Expected value of member.
+ */
+ public function test_proxy($modulename, $instance, $member, $expected) {
+ $proxy = new module_std_proxy(
+ $modulename,
+ $instance,
+ function($modulename, $instance) {
+ return $this->objects[$modulename . '_' . $instance];
+ }
+ );
+
+ $this->assertEquals($proxy->get($member), $expected);
+
+ // Test changing the value.
+ $proxy->set($member, 'something even more else');
+ $this->assertEquals($proxy->get($member), 'something even more else');
+ }
+
+ /**
+ * Test setting values with a base class.
+ *
+ * @dataProvider test_proxy_testcases()
+ * @param string $modulename Object module name.
+ * @param string $instance Object instance.
+ * @param string $member Object member to retrieve.
+ * @param mixed $storedvalue Value as would be stored externally.
+ */
+ public function test_base_values($modulename, $instance, $member, $storedvalue) {
+ $proxy = new module_std_proxy(
+ $modulename,
+ $instance,
+ function($module, $instance) {
+ return $this->objects[$module . '_' . $instance];
+ },
+ (object)['member1' => 'should clobber 1']
+ );
+
+ $expected = $member == 'member1' ? 'should clobber 1' : $storedvalue;
+ $this->assertEquals($proxy->get($member), $expected);
+ }
+
+ /**
+ * Test getting a non existant member.
+ *
+ * @dataProvider test_get_set_testcases()
+ * @param string $modulename Object module name.
+ * @param string $instance Object instance.
+ */
+ public function test_get_invalid_member($modulename, $instance) {
+ $proxy = new module_std_proxy(
+ $modulename,
+ $instance,
+ function($modulename, $instance) {
+ return $this->objects[$modulename . '_' . $instance];
+ }
+ );
+
+ $this->expectException('\core_calendar\local\event\exceptions\member_does_not_exist_exception');
+ $proxy->get('thisdoesnotexist');
+ }
+
+ /**
+ * Test setting a non existant member.
+ *
+ * @dataProvider test_get_set_testcases()
+ * @param string $modulename Object module name.
+ * @param string $instance Object instance.
+ */
+ public function test_set_invalid_member($modulename, $instance) {
+ $proxy = new module_std_proxy(
+ $modulename,
+ $instance,
+ function($modulename, $instance) {
+ return $this->objects[$modulename . '_' . $instance];
+ }
+ );
+
+ $this->expectException('\core_calendar\local\event\exceptions\member_does_not_exist_exception');
+ $proxy->set('thisdoesnotexist', 'should break');
+ }
+
+ /**
+ * Test get proxied instance.
+ *
+ * @dataProvider test_get_set_testcases()
+ * @param string $modulename Object module name.
+ * @param string $instance Object instance.
+ */
+ public function test_get_proxied_instance($modulename, $instance) {
+ $proxy = new module_std_proxy(
+ $modulename,
+ $instance,
+ function($modulename, $instance) {
+ return $this->objects[$modulename . '_' . $instance];
+ }
+ );
+
+ $this->assertEquals($proxy->get_proxied_instance(), $this->objects[$modulename . '_' . $instance]);
+ }
+
+ /**
+ * Test cases for proxying test.
+ */
+ public function test_proxy_testcases() {
+ return [
+ 'Object 1 member 1' => [
+ 'somemodule',
+ 'someinstance',
+ 'member1',
+ 'Hello'
+ ],
+ 'Object 1 member 2' => [
+ 'somemodule',
+ 'someinstance',
+ 'member2',
+ 1729
+ ],
+ 'Object 1 member 3' => [
+ 'somemodule',
+ 'someinstance',
+ 'member3',
+ 'Something else'
+ ],
+ 'Object 2 member 1' => [
+ 'anothermodule',
+ 'anotherinstance',
+ 'member1',
+ 'Hej'
+ ],
+ 'Object 2 member 2' => [
+ 'anothermodule',
+ 'anotherinstance',
+ 'member2',
+ 87539319
+ ],
+ 'Object 3 member 3' => [
+ 'anothermodule',
+ 'anotherinstance',
+ 'member3',
+ 'nagot annat'
+ ]
+ ];
+ }
+
+ /**
+ * Test cases for getting and setting tests.
+ */
+ public function test_get_set_testcases() {
+ return [
+ 'Object 1' => ['somemodule', 'someinstance'],
+ 'Object 2' => ['anothermodule', 'anotherinstance']
+ ];
+ }
+}
diff --git a/calendar/tests/raw_event_retrieval_strategy_test.php b/calendar/tests/raw_event_retrieval_strategy_test.php
new file mode 100644
index 0000000000000..cbf8d706d40ba
--- /dev/null
+++ b/calendar/tests/raw_event_retrieval_strategy_test.php
@@ -0,0 +1,280 @@
+.
+
+/**
+ * Raw event retrieval strategy tests.
+ *
+ * @package core_calendar
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once($CFG->dirroot . '/calendar/tests/helpers.php');
+
+use core_calendar\local\event\strategies\raw_event_retrieval_strategy;
+
+/**
+ * Raw event retrieval strategy testcase.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_raw_event_retrieval_strategy_testcase extends advanced_testcase {
+ /**
+ * Test retrieval strategy when module is disabled.
+ */
+ public function test_get_raw_events_with_disabled_module() {
+ global $DB;
+
+ $this->resetAfterTest();
+ $retrievalstrategy = new raw_event_retrieval_strategy();
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $student = $generator->create_user();
+ $generator->enrol_user($student->id, $course->id, 'student');
+ $this->setUser($student);
+ $events = [
+ [
+ 'name' => 'Start of assignment',
+ 'description' => '',
+ 'format' => 1,
+ 'courseid' => $course->id,
+ 'groupid' => 0,
+ 'userid' => 2,
+ 'modulename' => 'assign',
+ 'instance' => 1,
+ 'eventtype' => 'due',
+ 'timestart' => time(),
+ 'timeduration' => 86400,
+ 'visible' => 1
+ ], [
+ 'name' => 'Start of lesson',
+ 'description' => '',
+ 'format' => 1,
+ 'courseid' => $course->id,
+ 'groupid' => 0,
+ 'userid' => 2,
+ 'modulename' => 'lesson',
+ 'instance' => 1,
+ 'eventtype' => 'end',
+ 'timestart' => time(),
+ 'timeduration' => 86400,
+ 'visible' => 1
+ ]
+ ];
+
+ foreach ($events as $event) {
+ calendar_event::create($event, false);
+ }
+
+ // Get all events.
+ $events = $retrievalstrategy->get_raw_events(null, [0], null);
+ $this->assertCount(2, $events);
+
+ // Disable the lesson module.
+ $modulerecord = $DB->get_record('modules', ['name' => 'lesson']);
+ $modulerecord->visible = 0;
+ $DB->update_record('modules', $modulerecord);
+
+ // Check that we only return the assign event.
+ $events = $retrievalstrategy->get_raw_events(null, [0], null);
+ $this->assertCount(1, $events);
+ $event = reset($events);
+ $this->assertEquals('assign', $event->modulename);
+ }
+
+ /**
+ * Test retrieval strategy when there are overrides.
+ */
+ public function test_get_raw_event_strategy_with_overrides() {
+ $this->resetAfterTest();
+
+ $retrievalstrategy = new raw_event_retrieval_strategy();
+ $generator = $this->getDataGenerator();
+ $course = $generator->create_course();
+ $plugingenerator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
+
+ $instance = $plugingenerator->create_instance(['course' => $course->id]);
+
+ // Create users.
+ $useroverridestudent = $generator->create_user();
+ $group1student = $generator->create_user();
+ $group2student = $generator->create_user();
+ $group12student = $generator->create_user();
+ $nogroupstudent = $generator->create_user();
+
+ // Enrol users.
+ $generator->enrol_user($useroverridestudent->id, $course->id, 'student');
+ $generator->enrol_user($group1student->id, $course->id, 'student');
+ $generator->enrol_user($group2student->id, $course->id, 'student');
+ $generator->enrol_user($group12student->id, $course->id, 'student');
+
+ $generator->enrol_user($nogroupstudent->id, $course->id, 'student');
+
+ // Create groups.
+ $group1 = $generator->create_group(['courseid' => $course->id, 'name' => 'Group 1']);
+ $group2 = $generator->create_group(['courseid' => $course->id, 'name' => 'Group 2']);
+
+ // Add members to groups.
+ $generator->create_group_member(['groupid' => $group1->id, 'userid' => $group1student->id]);
+ $generator->create_group_member(['groupid' => $group2->id, 'userid' => $group2student->id]);
+ $generator->create_group_member(['groupid' => $group1->id, 'userid' => $group12student->id]);
+ $generator->create_group_member(['groupid' => $group2->id, 'userid' => $group12student->id]);
+
+ $now = time();
+
+ // Events with the same module name, instance and event type.
+ $events = [
+ [
+ 'name' => 'Assignment 1 due date',
+ 'description' => '',
+ 'format' => 0,
+ 'courseid' => $course->id,
+ 'groupid' => 0,
+ 'userid' => 2,
+ 'modulename' => 'assign',
+ 'instance' => $instance->id,
+ 'eventtype' => 'due',
+ 'timestart' => $now,
+ 'timeduration' => 0,
+ 'visible' => 1
+ ], [
+ 'name' => 'Assignment 1 due date - User override',
+ 'description' => '',
+ 'format' => 1,
+ 'courseid' => 0,
+ 'groupid' => 0,
+ 'userid' => $useroverridestudent->id,
+ 'modulename' => 'assign',
+ 'instance' => $instance->id,
+ 'eventtype' => 'due',
+ 'timestart' => $now + 86400,
+ 'timeduration' => 0,
+ 'visible' => 1,
+ 'priority' => CALENDAR_EVENT_USER_OVERRIDE_PRIORITY
+ ], [
+ 'name' => 'Assignment 1 due date - Group A override',
+ 'description' => '',
+ 'format' => 1,
+ 'courseid' => $course->id,
+ 'groupid' => $group1->id,
+ 'userid' => 2,
+ 'modulename' => 'assign',
+ 'instance' => $instance->id,
+ 'eventtype' => 'due',
+ 'timestart' => $now + (2 * 86400),
+ 'timeduration' => 0,
+ 'visible' => 1,
+ 'priority' => 1,
+ ], [
+ 'name' => 'Assignment 1 due date - Group B override',
+ 'description' => '',
+ 'format' => 1,
+ 'courseid' => $course->id,
+ 'groupid' => $group2->id,
+ 'userid' => 2,
+ 'modulename' => 'assign',
+ 'instance' => $instance->id,
+ 'eventtype' => 'due',
+ 'timestart' => $now + (3 * 86400),
+ 'timeduration' => 0,
+ 'visible' => 1,
+ 'priority' => 2,
+ ],
+ ];
+
+ foreach ($events as $event) {
+ calendar_event::create($event, false);
+ }
+
+ $timestart = $now - 100;
+ $timeend = $now + (3 * 86400);
+ $groups = [$group1->id, $group2->id];
+
+ // Get user override events.
+ $this->setUser($useroverridestudent);
+ $events = $retrievalstrategy->get_raw_events([$useroverridestudent->id], $groups, [$course->id]);
+ $this->assertCount(1, $events);
+ $event = reset($events);
+ $this->assertEquals('Assignment 1 due date - User override', $event->name);
+
+ // Get events for user that does not belong to any group and has no user override events.
+ $this->setUser($nogroupstudent);
+ $events = $retrievalstrategy->get_raw_events([$nogroupstudent->id], $groups, [$course->id]);
+ $this->assertCount(1, $events);
+ $event = reset($events);
+ $this->assertEquals('Assignment 1 due date', $event->name);
+
+ // Get events for user that belongs to groups A and B and has no user override events.
+ $this->setUser($group12student);
+ $events = $retrievalstrategy->get_raw_events([$group12student->id], $groups, [$course->id]);
+ $this->assertCount(1, $events);
+ $event = reset($events);
+ $this->assertEquals('Assignment 1 due date - Group B override', $event->name);
+
+ // Get events for user that belongs to group A and has no user override events.
+ $this->setUser($group1student);
+ $events = $retrievalstrategy->get_raw_events([$group1student->id], $groups, [$course->id]);
+ $this->assertCount(1, $events);
+ $event = reset($events);
+ $this->assertEquals('Assignment 1 due date - Group A override', $event->name);
+
+ // Add repeating events.
+ $repeatingevents = [
+ [
+ 'name' => 'Repeating site event',
+ 'description' => '',
+ 'format' => 1,
+ 'courseid' => SITEID,
+ 'groupid' => 0,
+ 'userid' => 2,
+ 'repeatid' => 1,
+ 'modulename' => '0',
+ 'instance' => 0,
+ 'eventtype' => 'site',
+ 'timestart' => $now + 86400,
+ 'timeduration' => 0,
+ 'visible' => 1,
+ ],
+ [
+ 'name' => 'Repeating site event',
+ 'description' => '',
+ 'format' => 1,
+ 'courseid' => SITEID,
+ 'groupid' => 0,
+ 'userid' => 2,
+ 'repeatid' => 1,
+ 'modulename' => '0',
+ 'instance' => 0,
+ 'eventtype' => 'site',
+ 'timestart' => $now + (2 * 86400),
+ 'timeduration' => 0,
+ 'visible' => 1,
+ ],
+ ];
+
+ foreach ($repeatingevents as $event) {
+ calendar_event::create($event, false);
+ }
+
+ // Make sure repeating events are not filtered out.
+ $events = $retrievalstrategy->get_raw_events();
+ $this->assertCount(3, $events);
+ }
+}
diff --git a/calendar/tests/repeat_event_collection_test.php b/calendar/tests/repeat_event_collection_test.php
new file mode 100644
index 0000000000000..f59fdd9cb0035
--- /dev/null
+++ b/calendar/tests/repeat_event_collection_test.php
@@ -0,0 +1,180 @@
+.
+
+/**
+ * Repeat event collection tests.
+ *
+ * @package core_calendar
+ * @copyright 2017 Ryan Wyllie
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+require_once($CFG->dirroot . '/calendar/lib.php');
+
+use core_calendar\local\event\entities\event;
+use core_calendar\local\event\entities\repeat_event_collection;
+use core_calendar\local\event\proxies\std_proxy;
+use core_calendar\local\event\value_objects\event_description;
+use core_calendar\local\event\value_objects\event_times;
+use core_calendar\local\event\factories\event_factory_interface;
+
+/**
+ * Repeat event collection tests.
+ *
+ * @copyright 2017 Ryan Wyllie
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_repeat_event_collection_testcase extends advanced_testcase {
+ /**
+ * Test that creating a repeat collection for a parent that doesn't
+ * exist throws an exception.
+ */
+ public function test_no_parent_collection() {
+ $this->resetAfterTest(true);
+ $parentid = 123122131;
+ $factory = new core_calendar_repeat_event_collection_event_test_factory();
+ $this->expectException('\core_calendar\local\event\exceptions\no_repeat_parent_exception');
+ $collection = new repeat_event_collection($parentid, null, $factory);
+ }
+
+ /**
+ * Test that an empty collection is valid.
+ */
+ public function test_empty_collection() {
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+
+ $event = $this->create_event([
+ // This causes the code to set the repeat id on this record
+ // but not create any repeat event records.
+ 'repeat' => 1,
+ 'repeats' => 0
+ ]);
+ $parentid = $event->id;
+ $factory = new core_calendar_repeat_event_collection_event_test_factory();
+
+ // Event collection with no repeats.
+ $collection = new repeat_event_collection($parentid, null, $factory);
+
+ $this->assertEquals($parentid, $collection->get_id());
+ $this->assertEquals(0, $collection->get_num());
+ $this->assertNull($collection->getIterator()->next());
+ }
+
+ /**
+ * Test that a collection with values behaves correctly.
+ */
+ public function test_values_collection() {
+ $this->resetAfterTest(true);
+ $this->setAdminUser();
+
+ $factory = new core_calendar_repeat_event_collection_event_test_factory();
+ $event = $this->create_event([
+ // This causes the code to set the repeat id on this record
+ // but not create any repeat event records.
+ 'repeat' => 1,
+ 'repeats' => 0
+ ]);
+ $parentid = $event->id;
+ $repeats = [];
+
+ for ($i = 1; $i < 4; $i++) {
+ $record = $this->create_event([
+ 'name' => sprintf('repeat %d', $i),
+ 'repeatid' => $parentid
+ ]);
+
+ // Index by name so that we don't have to rely on sorting
+ // when doing the comparison later.
+ $repeats[$record->name] = $record;
+ }
+
+ // Event collection with no repeats.
+ $collection = new repeat_event_collection($parentid, null, $factory);
+
+ $this->assertEquals($parentid, $collection->get_id());
+ $this->assertEquals(count($repeats), $collection->get_num());
+
+ foreach ($collection as $index => $event) {
+ $name = $event->get_name();
+ $this->assertEquals($repeats[$name]->name, $name);
+ }
+ }
+
+ /**
+ * Helper function to create calendar events using the old code.
+ *
+ * @param array $properties A list of calendar event properties to set
+ * @return calendar_event
+ */
+ protected function create_event($properties = []) {
+ $record = new \stdClass();
+ $record->name = 'event name';
+ $record->eventtype = 'global';
+ $record->repeat = 0;
+ $record->repeats = 0;
+ $record->timestart = time();
+ $record->timeduration = 0;
+ $record->timesort = 0;
+ $record->type = 1;
+ $record->courseid = 0;
+
+ foreach ($properties as $name => $value) {
+ $record->$name = $value;
+ }
+
+ $event = new calendar_event($record);
+ return $event->create($record, false);
+ }
+}
+
+/**
+ * Test event factory.
+ *
+ * @copyright 2017 Ryan Wyllie
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_repeat_event_collection_event_test_factory implements event_factory_interface {
+
+ public function create_instance(\stdClass $dbrow) {
+ $identity = function($id) {
+ return $id;
+ };
+ return new event(
+ $dbrow->id,
+ $dbrow->name,
+ new event_description($dbrow->description, $dbrow->format),
+ new std_proxy($dbrow->courseid, $identity),
+ new std_proxy($dbrow->groupid, $identity),
+ new std_proxy($dbrow->userid, $identity),
+ new repeat_event_collection($dbrow->id, null, $this),
+ new std_proxy($dbrow->instance, $identity),
+ $dbrow->type,
+ new event_times(
+ (new \DateTimeImmutable())->setTimestamp($dbrow->timestart),
+ (new \DateTimeImmutable())->setTimestamp($dbrow->timestart + $dbrow->timeduration),
+ (new \DateTimeImmutable())->setTimestamp($dbrow->timesort ? $dbrow->timesort : $dbrow->timestart),
+ (new \DateTimeImmutable())->setTimestamp($dbrow->timemodified)
+ ),
+ !empty($dbrow->visible),
+ new std_proxy($dbrow->subscriptionid, $identity)
+ );
+ }
+}
diff --git a/calendar/tests/std_proxy_test.php b/calendar/tests/std_proxy_test.php
new file mode 100644
index 0000000000000..cc912b3b7cfb5
--- /dev/null
+++ b/calendar/tests/std_proxy_test.php
@@ -0,0 +1,188 @@
+.
+
+/**
+ * std_proxy tests.
+ *
+ * @package core_calendar
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+use core_calendar\local\event\proxies\std_proxy;
+
+/**
+ * std_proxy testcase.
+ *
+ * @copyright 2017 Cameron Ball
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_std_proxy_testcase extends advanced_testcase {
+ /**
+ * @var \stdClass[] $objects Array of objects to proxy.
+ */
+ public $objects;
+
+ public function setUp() {
+ $this->objects = [
+ 1 => (object) [
+ 'member1' => 'Hello',
+ 'member2' => 1729,
+ 'member3' => 'Something else'
+ ],
+ 5 => (object) [
+ 'member1' => 'Hej',
+ 'member2' => 87539319,
+ 'member3' => 'nagot annat'
+ ]
+ ];
+ }
+
+ /**
+ * Test proxying.
+ *
+ * @dataProvider test_proxy_testcases()
+ * @param int $id Object ID.
+ * @param string $member Object member to retrieve.
+ * @param mixed $expected Expected value of member.
+ */
+ public function test_proxy($id, $member, $expected) {
+ $proxy = new std_proxy($id, function($id) {
+ return $this->objects[$id];
+ });
+
+ $this->assertEquals($proxy->get($member), $expected);
+
+ // Test changing the value.
+ $proxy->set($member, 'something even more else');
+ $this->assertEquals($proxy->get($member), 'something even more else');
+ }
+
+ /**
+ * Test setting values with a base class.
+ *
+ * @dataProvider test_proxy_testcases()
+ * @param int $id Object ID.
+ * @param string $member Object member to retrieve.
+ * @param mixed $storedvalue Value as would be stored externally.
+ */
+ public function test_base_values($id, $member, $storedvalue) {
+ $proxy = new std_proxy(
+ $id,
+ function($id) {
+ return $this->objects[$id];
+ },
+ (object)['member1' => 'should clobber 1']
+ );
+
+ $expected = $member == 'member1' ? 'should clobber 1' : $storedvalue;
+ $this->assertEquals($proxy->get($member), $expected);
+ }
+
+ /**
+ * Test getting a non existant member.
+ *
+ * @dataProvider test_get_set_testcases()
+ * @param int $id ID of the object being proxied.
+ */
+ public function test_get_invalid_member($id) {
+ $proxy = new std_proxy($id, function($id) {
+ return $this->objects[$id];
+ });
+
+ $this->expectException('\core_calendar\local\event\exceptions\member_does_not_exist_exception');
+ $proxy->get('thisdoesnotexist');
+ }
+
+ /**
+ * Test setting a non existant member.
+ *
+ * @dataProvider test_get_set_testcases()
+ * @param int $id ID of the object being proxied.
+ */
+ public function test_set_invalid_member($id) {
+ $proxy = new std_proxy($id, function($id) {
+ return $this->objects[$id];
+ });
+
+ $this->expectException('\core_calendar\local\event\exceptions\member_does_not_exist_exception');
+ $proxy->set('thisdoesnotexist', 'should break');
+ }
+
+ /**
+ * Test get proxied instance.
+ *
+ * @dataProvider test_get_set_testcases()
+ * @param int $id Object ID.
+ */
+ public function test_get_proxied_instance($id) {
+ $proxy = new std_proxy($id, function($id) {
+ return $this->objects[$id];
+ });
+
+ $this->assertEquals($proxy->get_proxied_instance(), $this->objects[$id]);
+ }
+
+ /**
+ * Test cases for proxying test.
+ */
+ public function test_proxy_testcases() {
+ return [
+ 'Object 1 member 1' => [
+ 1,
+ 'member1',
+ 'Hello'
+ ],
+ 'Object 1 member 2' => [
+ 1,
+ 'member2',
+ 1729
+ ],
+ 'Object 1 member 3' => [
+ 1,
+ 'member3',
+ 'Something else'
+ ],
+ 'Object 2 member 1' => [
+ 5,
+ 'member1',
+ 'Hej'
+ ],
+ 'Object 2 member 2' => [
+ 5,
+ 'member2',
+ 87539319
+ ],
+ 'Object 3 member 3' => [
+ 5,
+ 'member3',
+ 'nagot annat'
+ ]
+ ];
+ }
+
+ /**
+ * Test cases for getting and setting tests.
+ */
+ public function test_get_set_testcases() {
+ return [
+ 'Object 1' => [1],
+ 'Object 2' => [5]
+ ];
+ }
+}
diff --git a/calendar/upgrade.txt b/calendar/upgrade.txt
index 4a37e2c205bfd..e99279e8d1397 100644
--- a/calendar/upgrade.txt
+++ b/calendar/upgrade.txt
@@ -1,8 +1,16 @@
This files describes API changes in /calendar/* ,
information provided here is intended especially for developers.
+=== 3.3 ===
+* calendar_event_hook() has been removed. Developers should be using the Moodle events system to achieve this behaviour,
+ rather than using a hacky calendar specific implementation.
+* calendar_wday_name() is deprecated and no longer used in core.
+* calendar_get_block_upcoming() is deprecated, please use block_calendar_upcoming::get_upcoming_content() instead.
+* calendar_print_month_selector() is deprecated and no longer used in core.
+* calendar_cron() is deprecated and should not be used. Please use the core\task\calendar_cron_task instead.
+
=== 3.2 ===
-* calendar_preferences_button() is now depreciated. Calendar preferences have been moved to the user preferences page.
+* calendar_preferences_button() is now deprecated. Calendar preferences have been moved to the user preferences page.
=== 2.9 ===
default values changes in code:
diff --git a/cohort/tests/behat/access_visible_cohorts.feature b/cohort/tests/behat/access_visible_cohorts.feature
index e9131933857a3..946bd04b84935 100644
--- a/cohort/tests/behat/access_visible_cohorts.feature
+++ b/cohort/tests/behat/access_visible_cohorts.feature
@@ -46,7 +46,7 @@ Feature: Access visible and hidden cohorts
Scenario: Teacher can see visible cohorts defined in the above contexts
When I log in as "teacher"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Enrolment methods" node in "Course administration > Users"
And I select "Cohort sync" from the "Add method" singleselect
Then the "Cohort" select box should contain "Cohort in category 1"
@@ -58,10 +58,10 @@ Feature: Access visible and hidden cohorts
And the "Cohort" select box should contain "System empty cohort"
And I set the field "Cohort" to "System cohort"
And I press "Add method"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Enrolled users" node in "Course administration > Users"
And I should see "student@example.com"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Groups" node in "Course administration > Users"
And I press "Auto-create groups"
And the "Select members from cohort" select box should contain "Cohort in category 1"
@@ -74,8 +74,7 @@ Feature: Access visible and hidden cohorts
Scenario: System manager can see all cohorts defined in the above contexts
When I log in as "user1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Enrolment methods" node in "Course administration > Users"
And I select "Cohort sync" from the "Add method" singleselect
Then the "Cohort" select box should contain "Cohort in category 1"
@@ -101,8 +100,7 @@ Feature: Access visible and hidden cohorts
Scenario: Category manager can see all cohorts defined in his category and visible cohorts defined above
When I log in as "user2"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Enrolment methods" node in "Course administration > Users"
And I select "Cohort sync" from the "Add method" singleselect
Then the "Cohort" select box should contain "Cohort in category 1"
diff --git a/cohort/tests/behat/upload_cohort_users.feature b/cohort/tests/behat/upload_cohort_users.feature
index 68adda85f835a..1b1edb4086a62 100644
--- a/cohort/tests/behat/upload_cohort_users.feature
+++ b/cohort/tests/behat/upload_cohort_users.feature
@@ -15,12 +15,10 @@ Feature: Upload users to a cohort
| Course 1 | C1 | 0 |
| Course 2 | C2 | 0 |
And I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I add "Cohort sync" enrolment method with:
| Cohort | Cohort 1 |
- And I am on site homepage
- And I follow "Course 2"
+ And I am on "Course 2" course homepage
And I add "Cohort sync" enrolment method with:
| Cohort | Cohort 2 |
When I navigate to "Upload users" node in "Site administration > Users > Accounts"
@@ -36,14 +34,12 @@ Feature: Upload users to a cohort
And I click on "Assign" "link" in the "Cohort 2" "table_row"
And the "Current users" select box should contain "Mary Smith (marysmith@example.com)"
And the "Current users" select box should contain "Alice Smith (alicesmith@example.com)"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Enrolled users" in current page administration
And I should see "Tom Jones"
And I should see "Bob Jones"
And I should not see "Mary Smith"
- And I am on site homepage
- And I follow "Course 2"
+ And I am on "Course 2" course homepage
And I navigate to "Users > Enrolled users" in current page administration
And I should see "Mary Smith"
And I should see "Alice Smith"
diff --git a/completion/classes/api.php b/completion/classes/api.php
new file mode 100644
index 0000000000000..418d849886612
--- /dev/null
+++ b/completion/classes/api.php
@@ -0,0 +1,116 @@
+.
+
+/**
+ * Contains class containing completion API.
+ *
+ * @package core_completion
+ * @copyright 2017 Mark Nelson
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_completion;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Class containing completion API.
+ *
+ * @package core_completion
+ * @copyright 2017 Mark Nelson
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class api {
+
+ /**
+ * @var string The completion expected on event.
+ */
+ const COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED = 'expectcompletionon';
+
+ /**
+ * Creates, updates or deletes an event for the expected completion date.
+ *
+ * @param int $cmid The course module id
+ * @param string $modulename The name of the module (eg. assign, quiz)
+ * @param int $instanceid The instance idLOL
+ * @param int|null $completionexpectedtime The time completion is expected, null if not set
+ * @return bool
+ */
+ public static function update_completion_date_event($cmid, $modulename, $instanceid, $completionexpectedtime) {
+ global $CFG, $DB;
+
+ // Required for calendar constant CALENDAR_EVENT_TYPE_ACTION.
+ require_once($CFG->dirroot . '/calendar/lib.php');
+
+ $instance = $DB->get_record($modulename, array('id' => $instanceid), '*', MUST_EXIST);
+ $course = $DB->get_record('course', array('id' => $instance->course), '*', MUST_EXIST);
+
+ $completion = new \completion_info($course);
+
+ // Can not create/update an event if completion is disabled.
+ if (!$completion->is_enabled() && $completionexpectedtime !== null) {
+ return true;
+ }
+
+ // Create the \stdClass we will be using for our language strings.
+ $lang = new \stdClass();
+ $lang->modulename = get_string('pluginname', $modulename);
+ $lang->instancename = $instance->name;
+
+ // Create the calendar event.
+ $event = new \stdClass();
+ $event->type = CALENDAR_EVENT_TYPE_ACTION;
+ $event->eventtype = self::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED;
+ if ($event->id = $DB->get_field('event', 'id', array('modulename' => $modulename,
+ 'instance' => $instance->id, 'eventtype' => $event->eventtype))) {
+ if ($completionexpectedtime !== null) {
+ // Calendar event exists so update it.
+ $event->name = get_string('completionexpectedfor', 'completion', $lang);
+ $event->description = format_module_intro($modulename, $instance, $cmid);
+ $event->timestart = $completionexpectedtime;
+ $event->timesort = $completionexpectedtime;
+ $event->visible = instance_is_visible($modulename, $instance);
+ $event->timeduration = 0;
+
+ $calendarevent = \calendar_event::load($event->id);
+ $calendarevent->update($event);
+ } else {
+ // Calendar event is no longer needed.
+ $calendarevent = \calendar_event::load($event->id);
+ $calendarevent->delete();
+ }
+ } else {
+ // Event doesn't exist so create one.
+ if ($completionexpectedtime !== null) {
+ $event->name = get_string('completionexpectedfor', 'completion', $lang);
+ $event->description = format_module_intro($modulename, $instance, $cmid);
+ $event->courseid = $instance->course;
+ $event->groupid = 0;
+ $event->userid = 0;
+ $event->modulename = $modulename;
+ $event->instance = $instance->id;
+ $event->timestart = $completionexpectedtime;
+ $event->timesort = $completionexpectedtime;
+ $event->visible = instance_is_visible($modulename, $instance);
+ $event->timeduration = 0;
+
+ \calendar_event::create($event);
+ }
+ }
+
+ return true;
+ }
+}
diff --git a/completion/classes/progress.php b/completion/classes/progress.php
new file mode 100644
index 0000000000000..803f2ef044e50
--- /dev/null
+++ b/completion/classes/progress.php
@@ -0,0 +1,84 @@
+.
+
+/**
+ * Contains class used to return completion progress information.
+ *
+ * @package core_completion
+ * @copyright 2017 Mark Nelson
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_completion;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->libdir . '/completionlib.php');
+
+/**
+ * Class used to return completion progress information.
+ *
+ * @package core_completion
+ * @copyright 2017 Mark Nelson
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class progress {
+
+ /**
+ * Returns the course percentage completed by a certain user, returns null if no completion data is available.
+ *
+ * @param \stdClass $course Moodle course object
+ * @param int $userid The id of the user, 0 for the current user
+ * @return null|float The percentage, or null if completion is not supported in the course,
+ * or there are no activities that support completion.
+ */
+ public static function get_course_progress_percentage($course, $userid = 0) {
+ global $USER;
+
+ // Make sure we continue with a valid userid.
+ if (empty($userid)) {
+ $userid = $USER->id;
+ }
+
+ $completion = new \completion_info($course);
+
+ // First, let's make sure completion is enabled.
+ if (!$completion->is_enabled()) {
+ return null;
+ }
+
+ // Before we check how many modules have been completed see if the course has.
+ if ($completion->is_course_complete($userid)) {
+ return 100;
+ }
+
+ // Get the number of modules that support completion.
+ $modules = $completion->get_activities();
+ $count = count($modules);
+ if (!$count) {
+ return null;
+ }
+
+ // Get the number of modules that have been completed.
+ $completed = 0;
+ foreach ($modules as $module) {
+ $data = $completion->get_data($module, false, $userid);
+ $completed += $data->completionstate == COMPLETION_INCOMPLETE ? 0 : 1;
+ }
+
+ return ($completed / $count) * 100;
+ }
+}
diff --git a/completion/tests/api_test.php b/completion/tests/api_test.php
new file mode 100644
index 0000000000000..6762484208691
--- /dev/null
+++ b/completion/tests/api_test.php
@@ -0,0 +1,218 @@
+.
+
+/**
+ * Test completion API.
+ *
+ * @package core_completion
+ * @category test
+ * @copyright 2017 Mark Nelson
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Test completion API.
+ *
+ * @package core_completion
+ * @category test
+ * @copyright 2017 Mark Nelson
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_completion_api_testcase extends advanced_testcase {
+
+ /**
+ * Test setup.
+ */
+ public function setUp() {
+ $this->resetAfterTest();
+ }
+
+ public function test_update_completion_date_event() {
+ global $CFG, $DB;
+
+ $this->setAdminUser();
+
+ // Create a course.
+ $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
+
+ // Create an assign activity.
+ $time = time();
+ $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id));
+
+ // Create the completion event.
+ $CFG->enablecompletion = true;
+ \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign->id, $time);
+
+ // Check that there is now an event in the database.
+ $events = $DB->get_records('event');
+ $this->assertCount(1, $events);
+
+ // Get the event.
+ $event = reset($events);
+
+ // Confirm the event is correct.
+ $this->assertEquals('assign', $event->modulename);
+ $this->assertEquals($assign->id, $event->instance);
+ $this->assertEquals(CALENDAR_EVENT_TYPE_ACTION, $event->type);
+ $this->assertEquals(\core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED, $event->eventtype);
+ $this->assertEquals($time, $event->timestart);
+ $this->assertEquals($time, $event->timesort);
+ }
+
+ public function test_update_completion_date_event_update() {
+ global $CFG, $DB;
+
+ $this->setAdminUser();
+
+ // Create a course.
+ $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
+
+ // Create an assign activity.
+ $time = time();
+ $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id));
+
+ // Create the event.
+ $CFG->enablecompletion = true;
+ \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign->id, $time);
+
+ // Call it again, but this time with a different time.
+ \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign->id, $time + DAYSECS);
+
+ // Check that there is still only one event in the database.
+ $events = $DB->get_records('event');
+ $this->assertCount(1, $events);
+
+ // Get the event.
+ $event = reset($events);
+
+ // Confirm that the event has been updated.
+ $this->assertEquals('assign', $event->modulename);
+ $this->assertEquals($assign->id, $event->instance);
+ $this->assertEquals(CALENDAR_EVENT_TYPE_ACTION, $event->type);
+ $this->assertEquals(\core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED, $event->eventtype);
+ $this->assertEquals($time + DAYSECS, $event->timestart);
+ $this->assertEquals($time + DAYSECS, $event->timesort);
+ }
+
+ public function test_update_completion_date_event_delete() {
+ global $CFG, $DB;
+
+ $this->setAdminUser();
+
+ // Create a course.
+ $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
+
+ // Create an assign activity.
+ $time = time();
+ $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id));
+
+ // Create the event.
+ $CFG->enablecompletion = true;
+ \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign->id, $time);
+
+ // Call it again, but the time specified as null.
+ \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign->id, null);
+
+ // Check that there is no event in the database.
+ $this->assertEquals(0, $DB->count_records('event'));
+ }
+
+ public function test_update_completion_date_event_completion_disabled() {
+ global $CFG, $DB;
+
+ $this->setAdminUser();
+
+ // Create a course.
+ $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
+
+ // Create an assign activity.
+ $time = time();
+ $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id));
+
+ // Try and create the completion event with completion disabled.
+ $CFG->enablecompletion = false;
+ \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign->id, $time);
+
+ // Check that there is no event in the database.
+ $this->assertEquals(0, $DB->count_records('event'));
+ }
+
+ public function test_update_completion_date_event_update_completion_disabled() {
+ global $CFG, $DB;
+
+ $this->setAdminUser();
+
+ // Create a course.
+ $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
+
+ // Create an assign activity.
+ $time = time();
+ $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id));
+
+ // Create the completion event.
+ $CFG->enablecompletion = true;
+ \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign->id, $time);
+
+ // Disable completion.
+ $CFG->enablecompletion = false;
+
+ // Try and update the completion date.
+ \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign->id, $time + DAYSECS);
+
+ // Check that there is an event in the database.
+ $events = $DB->get_records('event');
+ $this->assertCount(1, $events);
+
+ // Get the event.
+ $event = reset($events);
+
+ // Confirm the event has not changed.
+ $this->assertEquals('assign', $event->modulename);
+ $this->assertEquals($assign->id, $event->instance);
+ $this->assertEquals(CALENDAR_EVENT_TYPE_ACTION, $event->type);
+ $this->assertEquals(\core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED, $event->eventtype);
+ $this->assertEquals($time, $event->timestart);
+ $this->assertEquals($time, $event->timesort);
+ }
+
+ public function test_update_completion_date_event_delete_completion_disabled() {
+ global $CFG, $DB;
+
+ $this->setAdminUser();
+
+ // Create a course.
+ $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
+
+ // Create an assign activity.
+ $time = time();
+ $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id));
+
+ // Create the completion event.
+ $CFG->enablecompletion = true;
+ \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign->id, $time);
+
+ // Disable completion.
+ $CFG->enablecompletion = false;
+
+ // Should still be able to delete completion events even when completion is disabled.
+ \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign->id, null);
+
+ // Check that there is now no event in the database.
+ $this->assertEquals(0, $DB->count_records('event'));
+ }
+}
diff --git a/completion/tests/behat/enable_manual_complete_mark.feature b/completion/tests/behat/enable_manual_complete_mark.feature
index 848b3155566c9..6ba1be434059e 100644
--- a/completion/tests/behat/enable_manual_complete_mark.feature
+++ b/completion/tests/behat/enable_manual_complete_mark.feature
@@ -18,26 +18,23 @@ Feature: Allow students to manually mark an activity as complete
| teacher1 | C1 | editingteacher |
| student1 | C1 | student |
And I log in as "teacher1"
- And I am on site homepage
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I navigate to "Edit settings" in current page administration
And I set the following fields to these values:
| Enable completion tracking | Yes |
And I press "Save and display"
And I add a "Forum" to section "1" and I fill the form with:
- | Forum name | Test forum name |
- | Description | Test forum description |
+ | Forum name | Test forum name |
+ | Description | Test forum description |
+ | Completion tracking | Students can manually mark the activity as completed |
And "Student First" user has not completed "Test forum name" activity
And I log out
And I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
When I click on "Not completed: Test forum name. Select to mark as complete." "icon"
Then the "Test forum name" "forum" activity with "manual" completion should be marked as complete
And I log out
And I log in as "teacher1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Reports > Activity completion" in current page administration
And "Student First" user has completed "Test forum name" activity
diff --git a/completion/tests/behat/restrict_activity_by_date.feature b/completion/tests/behat/restrict_activity_by_date.feature
index 3f94122bc0f99..551243d8e5d2a 100644
--- a/completion/tests/behat/restrict_activity_by_date.feature
+++ b/completion/tests/behat/restrict_activity_by_date.feature
@@ -17,9 +17,7 @@ Feature: Restrict activity availability through date conditions
| teacher1 | C1 | editingteacher |
| student1 | C1 | student |
And I log in as "teacher1"
- And I am on site homepage
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
# Adding the page like this because id_available*_enabled needs to be clicked to trigger the action.
And I add a "Assignment" to section "1"
And I expand all fieldsets
@@ -39,8 +37,7 @@ Feature: Restrict activity availability through date conditions
And I press "Save and return to course"
And I log out
When I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
Then I should see "Available from 31 December 2037"
And "Test assignment 1" activity should be dimmed
And "Test assignment 1" "link" should not exist
@@ -64,6 +61,5 @@ Feature: Restrict activity availability through date conditions
And I press "Save and return to course"
And I log out
When I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
Then I should not see "Test assignment 2"
diff --git a/completion/tests/behat/restrict_activity_by_grade.feature b/completion/tests/behat/restrict_activity_by_grade.feature
index 6c970e87da2a0..3d6a6cdd11d3e 100644
--- a/completion/tests/behat/restrict_activity_by_grade.feature
+++ b/completion/tests/behat/restrict_activity_by_grade.feature
@@ -18,9 +18,7 @@ Feature: Restrict activity availability through grade conditions
| teacher1 | C1 | editingteacher |
| student1 | C1 | student |
And I log in as "teacher1"
- #And I am on site homepage
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Assignment" to section "1" and I fill the form with:
| Assignment name | Grade assignment |
| Description | Grade this assignment to revoke restriction on restricted assignment |
@@ -41,8 +39,7 @@ Feature: Restrict activity availability through grade conditions
And I press "Save and return to course"
And I log out
When I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
Then I should see "Not available unless: You achieve a required score in Grade assignment"
And "Test page name" activity should be dimmed
And "Test page name" "link" should not exist
@@ -54,8 +51,7 @@ Feature: Restrict activity availability through grade conditions
And I should see "Submitted for grading"
And I log out
And I log in as "teacher1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Grade assignment"
And I navigate to "View all submissions" in current page administration
And I click on "Grade" "link" in the "Student First" "table_row"
@@ -66,7 +62,6 @@ Feature: Restrict activity availability through grade conditions
And I follow "Edit settings"
And I log out
And I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And "Test page name" activity should be visible
And I should not see "Not available unless: You achieve a required score in Grade assignment"
diff --git a/completion/tests/behat/restrict_section_availability.feature b/completion/tests/behat/restrict_section_availability.feature
index f00c39f496046..63d8422abeab5 100644
--- a/completion/tests/behat/restrict_section_availability.feature
+++ b/completion/tests/behat/restrict_section_availability.feature
@@ -20,9 +20,7 @@ Feature: Restrict sections availability through completion or grade conditions
@javascript
Scenario: Show section greyed-out to student when completion condition is not satisfied
Given I log in as "teacher1"
- And I am on site homepage
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I navigate to "Edit settings" in current page administration
And I set the following fields to these values:
| Enable completion tracking | Yes |
@@ -44,8 +42,7 @@ Feature: Restrict sections availability through completion or grade conditions
And I press "Save changes"
And I log out
And I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
Then I should see "Not available unless: The activity Test label is marked complete"
And I should not see "Test page name"
And I click on "Not completed: Test label. Select to mark as complete." "icon"
@@ -55,9 +52,7 @@ Feature: Restrict sections availability through completion or grade conditions
@javascript
Scenario: Show section greyed-out to student when grade condition is not satisfied
Given I log in as "teacher1"
- And I am on site homepage
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Assignment" to section "1" and I fill the form with:
| Assignment name | Grade assignment |
| Description | Grade this assignment to revoke restriction on restricted assignment |
@@ -78,8 +73,7 @@ Feature: Restrict sections availability through completion or grade conditions
And I press "Save changes"
And I log out
When I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
Then I should see "Not available unless: You achieve a required score in Grade assignment"
And "Test page name" activity should be hidden
And I follow "Grade assignment"
@@ -90,8 +84,7 @@ Feature: Restrict sections availability through completion or grade conditions
And I should see "Submitted for grading"
And I log out
And I log in as "teacher1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Grade assignment"
And I navigate to "View all submissions" in current page administration
And I click on "Grade" "link" in the "Student First" "table_row"
@@ -102,7 +95,6 @@ Feature: Restrict sections availability through completion or grade conditions
And I follow "Edit settings"
And I log out
And I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And "Test page name" activity should be visible
And I should not see "Not available unless: You achieve a required score in Grade assignment"
diff --git a/completion/tests/behat/teacher_manual_completion.feature b/completion/tests/behat/teacher_manual_completion.feature
index ca0c35d90f03e..13810f3754603 100644
--- a/completion/tests/behat/teacher_manual_completion.feature
+++ b/completion/tests/behat/teacher_manual_completion.feature
@@ -17,8 +17,7 @@ Feature: Allow teachers to manually mark users as complete when configured
| student1 | CC1 | student |
| teacher1 | CC1 | editingteacher |
And I log in as "admin"
- And I am on site homepage
- And I follow "Completion course"
+ And I am on "Completion course" course homepage
And completion tracking is "Enabled" in current course
And I follow "Course completion"
And I set the field "Teacher" to "1"
@@ -27,13 +26,11 @@ Feature: Allow teachers to manually mark users as complete when configured
And I add the "Course completion status" block
And I log out
And I log in as "student1"
- And I am on site homepage
- And I follow "Completion course"
+ And I am on "Completion course" course homepage
And I should see "Status: Not yet started"
And I log out
When I log in as "teacher1"
- And I am on site homepage
- And I follow "Completion course"
+ And I am on "Completion course" course homepage
And I follow "View course report"
And I should see "Student First"
And I follow "Click to mark user complete"
@@ -44,6 +41,5 @@ Feature: Allow teachers to manually mark users as complete when configured
And I am on site homepage
And I log out
Then I log in as "student1"
- And I am on site homepage
- And I follow "Completion course"
+ And I am on "Completion course" course homepage
And I should see "Status: Complete"
diff --git a/completion/tests/progress_test.php b/completion/tests/progress_test.php
new file mode 100644
index 0000000000000..b2e5b97e56f57
--- /dev/null
+++ b/completion/tests/progress_test.php
@@ -0,0 +1,154 @@
+.
+
+/**
+ * Test completion progress API.
+ *
+ * @package core_completion
+ * @category test
+ * @copyright 2017 Mark Nelson
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Test completion progress API.
+ *
+ * @package core_completion
+ * @category test
+ * @copyright 2017 Mark Nelson
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_completion_progress_testcase extends advanced_testcase {
+
+ /**
+ * Test setup.
+ */
+ public function setUp() {
+ global $CFG;
+
+ $CFG->enablecompletion = true;
+ $this->resetAfterTest();
+ }
+
+ /**
+ * Tests that the course progress percentage is returned correctly when we have only activity completion.
+ */
+ public function test_course_progress_percentage_with_just_activities() {
+ global $DB;
+
+ // Add a course that supports completion.
+ $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
+
+ // Enrol a user in the course.
+ $user = $this->getDataGenerator()->create_user();
+ $studentrole = $DB->get_record('role', array('shortname' => 'student'));
+ $this->getDataGenerator()->enrol_user($user->id, $course->id, $studentrole->id);
+
+ // Add four activities that use completion.
+ $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id),
+ array('completion' => 1));
+ $data = $this->getDataGenerator()->create_module('data', array('course' => $course->id),
+ array('completion' => 1));
+ $this->getDataGenerator()->create_module('forum', array('course' => $course->id),
+ array('completion' => 1));
+ $this->getDataGenerator()->create_module('forum', array('course' => $course->id),
+ array('completion' => 1));
+
+ // Add an activity that does *not* use completion.
+ $this->getDataGenerator()->create_module('assign', array('course' => $course->id));
+
+ // Mark two of them as completed for a user.
+ $cmassign = get_coursemodule_from_id('assign', $assign->cmid);
+ $cmdata = get_coursemodule_from_id('data', $data->cmid);
+ $completion = new completion_info($course);
+ $completion->update_state($cmassign, COMPLETION_COMPLETE, $user->id);
+ $completion->update_state($cmdata, COMPLETION_COMPLETE, $user->id);
+
+ // Check we have received valid data.
+ // Note - only 4 out of the 5 activities support completion, and the user has completed 2 of those.
+ $this->assertEquals('50', \core_completion\progress::get_course_progress_percentage($course, $user->id));
+ }
+
+ /**
+ * Tests that the course progress percentage is returned correctly when we have a course and activity completion.
+ */
+ public function test_course_progress_percentage_with_activities_and_course() {
+ global $DB;
+
+ // Add a course that supports completion.
+ $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
+
+ // Enrol a user in the course.
+ $user = $this->getDataGenerator()->create_user();
+ $studentrole = $DB->get_record('role', array('shortname' => 'student'));
+ $this->getDataGenerator()->enrol_user($user->id, $course->id, $studentrole->id);
+
+ // Add four activities that use completion.
+ $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id),
+ array('completion' => 1));
+ $data = $this->getDataGenerator()->create_module('data', array('course' => $course->id),
+ array('completion' => 1));
+ $this->getDataGenerator()->create_module('forum', array('course' => $course->id),
+ array('completion' => 1));
+ $this->getDataGenerator()->create_module('forum', array('course' => $course->id),
+ array('completion' => 1));
+
+ // Add an activity that does *not* use completion.
+ $this->getDataGenerator()->create_module('assign', array('course' => $course->id));
+
+ // Mark two of them as completed for a user.
+ $cmassign = get_coursemodule_from_id('assign', $assign->cmid);
+ $cmdata = get_coursemodule_from_id('data', $data->cmid);
+ $completion = new completion_info($course);
+ $completion->update_state($cmassign, COMPLETION_COMPLETE, $user->id);
+ $completion->update_state($cmdata, COMPLETION_COMPLETE, $user->id);
+
+ // Now, mark the course as completed.
+ $ccompletion = new completion_completion(array('course' => $course->id, 'userid' => $user->id));
+ $ccompletion->mark_complete();
+
+ // Check we have received valid data.
+ // The course completion takes priority, so should return 100.
+ $this->assertEquals('100', \core_completion\progress::get_course_progress_percentage($course, $user->id));
+ }
+
+ /**
+ * Tests that the course progress returns null when the course does not support it.
+ */
+ public function test_course_progress_course_not_using_completion() {
+ // Create a course that does not use completion.
+ $course = $this->getDataGenerator()->create_course();
+
+ // Check that the result was null.
+ $this->assertNull(\core_completion\progress::get_course_progress_percentage($course));
+ }
+
+ /**
+ * Tests that the course progress returns null when there are no activities that support it.
+ */
+ public function test_course_progress_no_activities_using_completion() {
+ // Create a course that does support completion.
+ $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
+
+ // Add an activity that does *not* support completion.
+ $this->getDataGenerator()->create_module('assign', array('course' => $course->id));
+
+ // Check that the result was null.
+ $this->assertNull(\core_completion\progress::get_course_progress_percentage($course));
+ }
+}
diff --git a/course/classes/external/course_summary_exporter.php b/course/classes/external/course_summary_exporter.php
index afc96f3441166..531ed8c5cfcd3 100644
--- a/course/classes/external/course_summary_exporter.php
+++ b/course/classes/external/course_summary_exporter.php
@@ -42,6 +42,7 @@ protected static function define_related() {
protected function get_other_values(renderer_base $output) {
return array(
+ 'fullnamedisplay' => get_course_display_name_for_list($this->data),
'viewurl' => (new moodle_url('/course/view.php', array('id' => $this->data->id)))->out(false)
);
}
@@ -59,12 +60,24 @@ public static function define_properties() {
),
'idnumber' => array(
'type' => PARAM_RAW,
+ ),
+ 'summary' => array(
+ 'type' => PARAM_RAW,
+ ),
+ 'startdate' => array(
+ 'type' => PARAM_INT,
+ ),
+ 'enddate' => array(
+ 'type' => PARAM_INT,
)
);
}
public static function define_other_properties() {
return array(
+ 'fullnamedisplay' => array(
+ 'type' => PARAM_TEXT,
+ ),
'viewurl' => array(
'type' => PARAM_URL,
)
diff --git a/course/externallib.php b/course/externallib.php
index 73370acc2db33..802cfd2fee5f4 100644
--- a/course/externallib.php
+++ b/course/externallib.php
@@ -2654,6 +2654,8 @@ public static function get_course_module_by_instance_returns() {
/**
* Returns description of method parameters
*
+ * @deprecated since 3.3
+ *
* @return external_function_parameters
* @since Moodle 3.2
*/
@@ -2668,6 +2670,8 @@ public static function get_activities_overview_parameters() {
/**
* Return activities overview for the given courses.
*
+ * @deprecated since 3.3
+ *
* @param array $courseids a list of course ids
* @return array of warnings and the activities overview
* @since Moodle 3.2
@@ -2725,6 +2729,8 @@ public static function get_activities_overview($courseids) {
/**
* Returns description of method result value
*
+ * @deprecated since 3.3
+ *
* @return external_description
* @since Moodle 3.2
*/
@@ -2751,6 +2757,15 @@ public static function get_activities_overview_returns() {
);
}
+ /**
+ * Marking the method as deprecated.
+ *
+ * @return bool
+ */
+ public static function get_activities_overview_is_deprecated() {
+ return true;
+ }
+
/**
* Returns description of method parameters
*
diff --git a/course/format/social/tests/behat/social_adjust_discussion_count.feature b/course/format/social/tests/behat/social_adjust_discussion_count.feature
index 4c83c5a320cb1..f7216c7f32b54 100644
--- a/course/format/social/tests/behat/social_adjust_discussion_count.feature
+++ b/course/format/social/tests/behat/social_adjust_discussion_count.feature
@@ -15,14 +15,14 @@ Feature: Change number of discussions displayed
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I press "Add a new discussion topic"
And I set the following fields to these values:
| Subject | Forum Post 10 |
| Message | This is forum post ten |
And I press "Post to forum"
And I wait to be redirected
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I wait "1" seconds
And I press "Add a new discussion topic"
And I set the following fields to these values:
@@ -30,7 +30,7 @@ Feature: Change number of discussions displayed
| Message | This is forum post nine |
And I press "Post to forum"
And I wait to be redirected
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I wait "1" seconds
And I press "Add a new discussion topic"
And I set the following fields to these values:
@@ -38,7 +38,7 @@ Feature: Change number of discussions displayed
| Message | This is forum post eight |
And I press "Post to forum"
And I wait to be redirected
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I wait "1" seconds
And I press "Add a new discussion topic"
And I set the following fields to these values:
@@ -46,7 +46,7 @@ Feature: Change number of discussions displayed
| Message | This is forum post seven |
And I press "Post to forum"
And I wait to be redirected
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I wait "1" seconds
And I press "Add a new discussion topic"
And I set the following fields to these values:
@@ -54,7 +54,7 @@ Feature: Change number of discussions displayed
| Message | This is forum post six |
And I press "Post to forum"
And I wait to be redirected
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I wait "1" seconds
And I press "Add a new discussion topic"
And I set the following fields to these values:
@@ -62,7 +62,7 @@ Feature: Change number of discussions displayed
| Message | This is forum post five |
And I press "Post to forum"
And I wait to be redirected
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I wait "1" seconds
And I press "Add a new discussion topic"
And I set the following fields to these values:
@@ -70,7 +70,7 @@ Feature: Change number of discussions displayed
| Message | This is forum post four |
And I press "Post to forum"
And I wait to be redirected
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I wait "1" seconds
And I press "Add a new discussion topic"
And I set the following fields to these values:
@@ -78,7 +78,7 @@ Feature: Change number of discussions displayed
| Message | This is forum post three |
And I press "Post to forum"
And I wait to be redirected
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I wait "1" seconds
And I press "Add a new discussion topic"
And I set the following fields to these values:
@@ -86,7 +86,7 @@ Feature: Change number of discussions displayed
| Message | This is forum post two |
And I press "Post to forum"
And I wait to be redirected
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I wait "1" seconds
And I press "Add a new discussion topic"
And I set the following fields to these values:
@@ -94,7 +94,7 @@ Feature: Change number of discussions displayed
| Message | This is forum post one |
And I press "Post to forum"
And I wait to be redirected
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
Scenario: When number of discussions is decreased fewer discussions appear
Given I navigate to "Edit settings" in current page administration
diff --git a/course/format/topics/tests/behat/edit_delete_sections.feature b/course/format/topics/tests/behat/edit_delete_sections.feature
index 1c836478c7b03..ee86fb452d1a2 100644
--- a/course/format/topics/tests/behat/edit_delete_sections.feature
+++ b/course/format/topics/tests/behat/edit_delete_sections.feature
@@ -21,8 +21,7 @@ Feature: Sections can be edited and deleted in topics format
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
Scenario: View the default name of the general section in topics format
When I click on "Edit section" "link" in the "li#section-0" "css_element"
@@ -62,7 +61,7 @@ Feature: Sections can be edited and deleted in topics format
Then I should not see "Topic 1" in the "region-main" "region"
And "New name for topic" "field" should not exist
And I should see "Midterm evaluation" in the "li#section-1" "css_element"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I should not see "Topic 1" in the "region-main" "region"
And I should see "Midterm evaluation" in the "li#section-1" "css_element"
diff --git a/course/format/weeks/tests/behat/edit_delete_sections.feature b/course/format/weeks/tests/behat/edit_delete_sections.feature
index 6269da09f5ae8..74d25ce4f2007 100644
--- a/course/format/weeks/tests/behat/edit_delete_sections.feature
+++ b/course/format/weeks/tests/behat/edit_delete_sections.feature
@@ -21,8 +21,7 @@ Feature: Sections can be edited and deleted in weeks format
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
Scenario: View the default name of the general section in weeks format
When I click on "Edit section" "link" in the "li#section-0" "css_element"
@@ -67,7 +66,7 @@ Feature: Sections can be edited and deleted in weeks format
Then I should not see "1 May - 7 May" in the "region-main" "region"
And "New name for week" "field" should not exist
And I should see "Midterm evaluation" in the "li#section-1" "css_element"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I should not see "1 May - 7 May" in the "region-main" "region"
And I should see "Midterm evaluation" in the "li#section-1" "css_element"
diff --git a/course/moodleform_mod.php b/course/moodleform_mod.php
index 1886a28785f1b..46ed50affdbc4 100644
--- a/course/moodleform_mod.php
+++ b/course/moodleform_mod.php
@@ -636,7 +636,6 @@ function standard_coursemodule_elements(){
}
if ($completion->is_enabled()) {
$mform->addElement('header', 'activitycompletionheader', get_string('activitycompletion', 'completion'));
-
// Unlock button for if people have completed it (will
// be removed in definition_after_data if they haven't)
$mform->addElement('submit', 'unlockcompletion', get_string('unlockcompletion', 'completion'));
@@ -647,7 +646,13 @@ function standard_coursemodule_elements(){
$trackingdefault = COMPLETION_TRACKING_NONE;
// If system and activity default is on, set it.
if ($CFG->completiondefault && $this->_features->defaultcompletion) {
- $trackingdefault = COMPLETION_TRACKING_MANUAL;
+ $hasrules = plugin_supports('mod', $this->_modname, FEATURE_COMPLETION_HAS_RULES, true);
+ $tracksviews = plugin_supports('mod', $this->_modname, FEATURE_COMPLETION_TRACKS_VIEWS, true);
+ if ($hasrules || $tracksviews) {
+ $trackingdefault = COMPLETION_TRACKING_AUTOMATIC;
+ } else {
+ $trackingdefault = COMPLETION_TRACKING_MANUAL;
+ }
}
$mform->addElement('select', 'completion', get_string('completion', 'completion'),
@@ -662,6 +667,10 @@ function standard_coursemodule_elements(){
$mform->addElement('checkbox', 'completionview', get_string('completionview', 'completion'),
get_string('completionview_desc', 'completion'));
$mform->disabledIf('completionview', 'completion', 'ne', COMPLETION_TRACKING_AUTOMATIC);
+ // Check by default if automatic completion tracking is set.
+ if ($trackingdefault == COMPLETION_TRACKING_AUTOMATIC) {
+ $mform->setDefault('completionview', 1);
+ }
$gotcompletionoptions = true;
}
diff --git a/course/tests/behat/activities_edit_completion.feature b/course/tests/behat/activities_edit_completion.feature
index c4f44b7b95948..ebca3b4f1f3a0 100644
--- a/course/tests/behat/activities_edit_completion.feature
+++ b/course/tests/behat/activities_edit_completion.feature
@@ -9,16 +9,14 @@ Feature: Edit completion settings of an activity
| fullname | shortname | enablecompletion |
| Course 1 | C1 | 1 |
And I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Page" to section "1" and I fill the form with:
| Name | TestPage |
| Description | x |
| Page content | x |
| Completion tracking | 2 |
| Require view | 1 |
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
Scenario: Completion is not locked when the activity has not yet been viewed
Given I click on "Edit settings" "link" in the "TestPage" activity
diff --git a/course/tests/behat/activities_edit_name.feature b/course/tests/behat/activities_edit_name.feature
index 2d53b7cc8fc3b..29e8911821c8a 100644
--- a/course/tests/behat/activities_edit_name.feature
+++ b/course/tests/behat/activities_edit_name.feature
@@ -16,8 +16,7 @@ Feature: Edit activity name in-place
| user | course | role |
| teacher1 | C1 | editingteacher |
When I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Forum" to section "1" and I fill the form with:
| Forum name | Test forum name |
| Description | Test forum description |
@@ -28,7 +27,7 @@ Feature: Edit activity name in-place
Then I should not see "Test forum name" in the ".course-content" "css_element"
And "New name for activity Test forum name" "field" should not exist
And I should see "Good news"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I should see "Good news"
And I should not see "Test forum name"
# Cancel renaming
@@ -38,7 +37,7 @@ Feature: Edit activity name in-place
And "New name for activity Good news" "field" should not exist
And I should see "Good news"
And I should not see "Terrible news"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I should see "Good news"
And I should not see "Terrible news"
And I log out
diff --git a/course/tests/behat/activities_edit_with_block_dock.feature b/course/tests/behat/activities_edit_with_block_dock.feature
index 735288ec59caf..4ed3330593b14 100644
--- a/course/tests/behat/activities_edit_with_block_dock.feature
+++ b/course/tests/behat/activities_edit_with_block_dock.feature
@@ -16,8 +16,7 @@ Feature: Open the edit menu when a block is docked
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Glossary" to section "1" and I fill the form with:
| Name | Test glossary name |
| Description | Test glossary description |
diff --git a/course/tests/behat/activities_group_icons.feature b/course/tests/behat/activities_group_icons.feature
index 4429b2a104071..a863ff0c9e34f 100644
--- a/course/tests/behat/activities_group_icons.feature
+++ b/course/tests/behat/activities_group_icons.feature
@@ -16,8 +16,7 @@ Feature: Toggle activities groups mode from the course page
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Forum" to section "1" and I fill the form with:
| Forum name | Test forum name |
| Description | Test forum description |
diff --git a/course/tests/behat/activities_indentation.feature b/course/tests/behat/activities_indentation.feature
index ded5b0ec55134..8ef74131f60e9 100644
--- a/course/tests/behat/activities_indentation.feature
+++ b/course/tests/behat/activities_indentation.feature
@@ -18,8 +18,7 @@ Feature: Indent items on the course page
| teacher1 | C1 | editingteacher |
| student1 | C1 | student |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Glossary" to section "1" and I fill the form with:
| Name | Test glossary name |
| Description | Test glossary description |
diff --git a/course/tests/behat/activities_visibility_icons.feature b/course/tests/behat/activities_visibility_icons.feature
index 6df1c37a828d6..4a45cec23aae7 100644
--- a/course/tests/behat/activities_visibility_icons.feature
+++ b/course/tests/behat/activities_visibility_icons.feature
@@ -18,8 +18,7 @@ Feature: Toggle activities visibility from the course page
| teacher1 | C1 | editingteacher |
| student1 | C1 | student |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Forum" to section "1" and I fill the form with:
| Forum name | Test forum name |
| Description | Test forum description |
@@ -59,7 +58,7 @@ Feature: Toggle activities visibility from the course page
And I log out
# Student should not see this activity.
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I should not see "Test forum name"
And I log out
@@ -77,8 +76,7 @@ Feature: Toggle activities visibility from the course page
| teacher1 | C1 | editingteacher |
| student1 | C1 | student |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add the "Recent activity" block
And I add a "Forum" to section "2" and I fill the form with:
| Forum name | Test forum name |
@@ -113,7 +111,7 @@ Feature: Toggle activities visibility from the course page
And I log out
# Student will not see the module on the course page but can access it from other reports and blocks:
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And "Test forum name" activity should be hidden
And I click on "Test forum name" "link" in the "Recent activity" "block"
And I should see "Test forum name"
@@ -132,8 +130,7 @@ Feature: Toggle activities visibility from the course page
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Forum" to section "2" and I fill the form with:
| Forum name | Test forum name |
| Description | Test forum description |
@@ -171,8 +168,7 @@ Feature: Toggle activities visibility from the course page
| allowstealth | 1 |
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add the "Recent activity" block
And I add a "Assignment" to section "2" and I fill the form with:
| Assignment name | Test assignment name |
@@ -205,7 +201,7 @@ Feature: Toggle activities visibility from the course page
And I log out
# Student will not see the module on the course page but can access it from other reports and blocks:
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And "Test assignment name" activity should be hidden
And I click on "Test assignment name" "link" in the "Recent activity" "block"
And I should see "Test assignment name"
diff --git a/course/tests/behat/add_activities.feature b/course/tests/behat/add_activities.feature
index b318d8046d04b..547162d4ae63f 100644
--- a/course/tests/behat/add_activities.feature
+++ b/course/tests/behat/add_activities.feature
@@ -17,9 +17,7 @@ Feature: Add activities to courses
| student1 | C1 | student |
| student2 | C1 | student |
And I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
@javascript
Scenario: Add an activity to a course
@@ -48,8 +46,7 @@ Feature: Add activities to courses
Scenario: Set activity description to required then add an activity supplying only the name
Given I set the following administration settings values:
| requiremodintro | Yes |
- When I am on site homepage
- And I follow "Course 1"
+ When I am on "Course 1" course homepage
And I add a "Database" to section "3" and I fill the form with:
| Name | Test name |
Then I should see "Required"
diff --git a/course/tests/behat/course_controls.feature b/course/tests/behat/course_controls.feature
index fda72f91b5a7f..f28f75e9e0e26 100644
--- a/course/tests/behat/course_controls.feature
+++ b/course/tests/behat/course_controls.feature
@@ -27,7 +27,7 @@ Feature: Course activity controls works as expected
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
When I follow
And I turn editing mode on
And I add the "Recent activity" block
@@ -99,7 +99,7 @@ Feature: Course activity controls works as expected
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
When I follow
And I turn editing mode on
And I add the "Recent activity" block
diff --git a/course/tests/behat/course_creation.feature b/course/tests/behat/course_creation.feature
index 8b6c46c58bc32..140fd3fcc18e6 100644
--- a/course/tests/behat/course_creation.feature
+++ b/course/tests/behat/course_creation.feature
@@ -18,8 +18,7 @@ Feature: Managers can create courses
And I enrol "Student 1" user as "Student"
And I log out
When I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add the "Latest announcements" block
Then "Latest announcements" "block" should exist
And I follow "Announcements"
@@ -28,7 +27,7 @@ Feature: Managers can create courses
And "Subscription mode > Forced subscription" "text" should exist in current page administration
And I log out
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Announcements"
And "Add a new topic" "button" should not exist
And "Forced subscription" "text" should exist in current page administration
diff --git a/course/tests/behat/coursetags.feature b/course/tests/behat/coursetags.feature
index fe1d331bc0ba8..62ccbeda6b23b 100644
--- a/course/tests/behat/coursetags.feature
+++ b/course/tests/behat/coursetags.feature
@@ -24,7 +24,7 @@ Feature: Tagging courses
| teacher1 | c2 | editingteacher |
| teacher2 | c2 | teacher |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Edit settings" in current page administration
And I set the following fields to these values:
| Tags | Mathematics |
@@ -33,15 +33,14 @@ Feature: Tagging courses
Scenario: Set course tags using the course edit form
When I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Edit settings" node in "Course administration"
And I expand all fieldsets
Then I should see "Mathematics" in the ".form-autocomplete-selection" "css_element"
And I set the following fields to these values:
| Tags | Algebra |
And I press "Save and display"
- And I am on homepage
- And I follow "Course 2"
+ And I am on "Course 2" course homepage
And I navigate to "Edit settings" node in "Course administration"
And I set the following fields to these values:
| Tags | Mathematics, Geometry |
@@ -71,14 +70,13 @@ Feature: Tagging courses
| moodle/course:tag | Allow |
And I log out
When I log in as "teacher2"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Course tags" in current page administration
Then I should see "Mathematics" in the ".form-autocomplete-selection" "css_element"
And I set the following fields to these values:
| Tags | Algebra |
And I press "Save changes"
- And I am on homepage
- And I follow "Course 2"
+ And I am on "Course 2" course homepage
And I navigate to "Course tags" in current page administration
And I set the following fields to these values:
| Tags | Mathematics, Geometry |
diff --git a/course/tests/behat/edit_settings.feature b/course/tests/behat/edit_settings.feature
index 1ef2c67cb6468..e2ffa84e3cfe1 100644
--- a/course/tests/behat/edit_settings.feature
+++ b/course/tests/behat/edit_settings.feature
@@ -16,7 +16,7 @@ Feature: Edit course settings
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
When I navigate to "Edit settings" in current page administration
And I set the following fields to these values:
| Course full name | Edited course fullname |
@@ -32,7 +32,7 @@ Feature: Edit course settings
And the field "Course full name" matches value "Edited course fullname"
And the field "Course short name" matches value "Edited course shortname"
And the field "Course summary" matches value "Edited course summary"
- And I am on homepage
+ And I am on site homepage
And I should see "Edited course fullname"
Scenario: Edit course settings and return to the management interface
diff --git a/course/tests/behat/force_group_mode.feature b/course/tests/behat/force_group_mode.feature
index 284a59dd1716d..1230ae95a6de7 100644
--- a/course/tests/behat/force_group_mode.feature
+++ b/course/tests/behat/force_group_mode.feature
@@ -15,8 +15,7 @@ Feature: Force group mode in a course
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Chat" to section "1" and I fill the form with:
| Name of this chat room | Chat room |
| Description | Chat description |
diff --git a/course/tests/behat/move_activities.feature b/course/tests/behat/move_activities.feature
index ba900d446bf42..b06c7f6a73ba0 100644
--- a/course/tests/behat/move_activities.feature
+++ b/course/tests/behat/move_activities.feature
@@ -15,8 +15,7 @@ Feature: Activities can be moved between sections
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add the "Recent activity" block
And I follow "Delete Recent activity block"
And I press "Yes"
diff --git a/course/tests/behat/move_sections.feature b/course/tests/behat/move_sections.feature
index d1efdde9dd1d3..0e9e097346cb4 100644
--- a/course/tests/behat/move_sections.feature
+++ b/course/tests/behat/move_sections.feature
@@ -15,8 +15,7 @@ Feature: Sections can be moved
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
Scenario: Move up and down a section with Javascript disabled in a single page course
Given I add a "Forum" to section "1" and I fill the form with:
diff --git a/course/tests/behat/paged_course_navigation.feature b/course/tests/behat/paged_course_navigation.feature
index 8be6ae11c5794..0f929bdcf7a3f 100644
--- a/course/tests/behat/paged_course_navigation.feature
+++ b/course/tests/behat/paged_course_navigation.feature
@@ -10,8 +10,7 @@ Feature: Course paged mode
| fullname | shortname | category | format | coursedisplay | numsections |
| Course 1 | C1 | 0 | | 1 | 3 |
And I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
Then I click on "link" in the "section"
And I follow "C1"
And I click on "link" in the "section"
@@ -44,8 +43,7 @@ Feature: Course paged mode
| fullname | shortname | category | format | coursedisplay | numsections |
| Course 1 | C1 | 0 | | 1 | 3 |
And I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
Then I click on "link" in the "section"
And I follow "C1"
And I click on "link" in the "section"
diff --git a/course/tests/behat/rename_roles.feature b/course/tests/behat/rename_roles.feature
index 253aebdb49c1b..c16ead45273f4 100644
--- a/course/tests/behat/rename_roles.feature
+++ b/course/tests/behat/rename_roles.feature
@@ -20,7 +20,7 @@ Feature: Rename roles within a course
| teacher2 | C1 | teacher |
| student1 | C1 | student |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
When I navigate to "Edit settings" in current page administration
And I set the following fields to these values:
| Your word for 'Non-editing teacher' | Tutor |
@@ -33,7 +33,7 @@ Feature: Rename roles within a course
And the "roleid" select box should contain "Tutor"
And the "roleid" select box should contain "Learner"
And the "roleid" select box should not contain "Student"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Edit settings" in current page administration
And I set the following fields to these values:
| Your word for 'Non-editing teacher' | |
diff --git a/course/tests/behat/restrict_available_activities.feature b/course/tests/behat/restrict_available_activities.feature
index dc240de804827..b31933fdf820c 100644
--- a/course/tests/behat/restrict_available_activities.feature
+++ b/course/tests/behat/restrict_available_activities.feature
@@ -18,8 +18,7 @@ Feature: Restrict activities availability
@javascript
Scenario: Activities can be added with the default permissions
Given I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
When I add a "Glossary" to section "1" and I fill the form with:
| Name | Test glossary name |
| Description | Test glossary description |
@@ -33,14 +32,12 @@ Feature: Restrict activities availability
Given I log in as "admin"
And I set the following system permissions of "Teacher" role:
| mod/chat:addinstance | Prohibit |
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Permissions" in current page administration
And I override the system permissions of "Teacher" role with:
| mod/glossary:addinstance | Prohibit |
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
- When I turn editing mode on
+ When I am on "Course 1" course homepage with editing mode on
Then the "Add an activity to section 'Topic 1'" select box should not contain "Chat"
Then the "Add an activity to section 'Topic 1'" select box should not contain "Glossary"
diff --git a/course/tests/behat/role_renaming.feature b/course/tests/behat/role_renaming.feature
index 3101265035787..d4b7f3d081708 100644
--- a/course/tests/behat/role_renaming.feature
+++ b/course/tests/behat/role_renaming.feature
@@ -19,7 +19,7 @@ Feature: Rename roles in a course
Scenario: Teacher can rename roles
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Edit settings" in current page administration
And I should see "Role renaming"
When I set the following fields to these values:
@@ -37,7 +37,7 @@ Feature: Rename roles in a course
| moodle/course:renameroles | Inherit |
And I follow "Log out"
When I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Edit settings" in current page administration
Then I should not see "Role renaming"
And I should not see "Your word for 'Teacher'"
diff --git a/course/tests/behat/section_highlighting.feature b/course/tests/behat/section_highlighting.feature
index af8c941d2a84f..07b54235bf56e 100644
--- a/course/tests/behat/section_highlighting.feature
+++ b/course/tests/behat/section_highlighting.feature
@@ -18,15 +18,13 @@ Feature: Topic's course sections highlighting
| teacher1 | C1 | editingteacher |
| student1 | C1 | student |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
When I turn section "1" highlighting on
Then section "1" should be highlighted
And I turn section "2" highlighting on
And section "2" should be highlighted
And section "1" should not be highlighted
- And I am on homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And section "2" should be highlighted
And section "1" should not be highlighted
And I turn section "2" highlighting off
@@ -34,12 +32,11 @@ Feature: Topic's course sections highlighting
And section "2" should not be highlighted
And I reload the page
And section "2" should not be highlighted
- And I am on homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And section "2" should not be highlighted
And I log out
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And section "1" should not be highlighted
And section "2" should not be highlighted
diff --git a/course/tests/behat/section_visibility.feature b/course/tests/behat/section_visibility.feature
index b9f781a0d7853..f11dc6dc6ccd9 100644
--- a/course/tests/behat/section_visibility.feature
+++ b/course/tests/behat/section_visibility.feature
@@ -18,8 +18,7 @@ Feature: Show/hide course sections
| teacher1 | C1 | editingteacher |
| student1 | C1 | student |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Forum" to section "1" and I fill the form with:
| Forum name | Test hidden forum 11 name |
| Description | Test hidden forum 11 description |
@@ -44,7 +43,8 @@ Feature: Show/hide course sections
| Forum name | Test hidden forum 32 name |
| Description | Test hidden forum 32 description |
| Availability | Show on course page |
- And I follow "Course 1"
+ | Visible | Show |
+ And I am on "Course 1" course homepage
When I hide section "1"
Then section "1" should be hidden
And section "2" should be visible
@@ -65,7 +65,7 @@ Feature: Show/hide course sections
And all activities in section "1" should be hidden
And I log out
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And section "1" should be hidden
And all activities in section "1" should be hidden
And section "2" should be visible
diff --git a/course/tests/behat/view_subfolders_inline.feature b/course/tests/behat/view_subfolders_inline.feature
index 14194c068b328..d447b2bb31466 100644
--- a/course/tests/behat/view_subfolders_inline.feature
+++ b/course/tests/behat/view_subfolders_inline.feature
@@ -15,8 +15,7 @@ Feature: View subfolders in a course in-line
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Folder" to section "3" and I fill the form with:
| Name | Test folder |
| Display folder contents | On a separate page |
@@ -30,7 +29,7 @@ Feature: View subfolders in a course in-line
@javascript
Scenario: Add a folder with two subfolders - view on separate page
- Given I follow "Course 1"
+ Given I am on "Course 1" course homepage
And I should not see "Test subfolder 1"
And I follow "Test folder"
And I should see "Test subfolder 1"
@@ -39,7 +38,7 @@ Feature: View subfolders in a course in-line
And I set the field "New folder name" to "Test subfolder 2"
And I click on "button.fp-dlg-butcreate" "css_element" in the "div.fp-mkdir-dlg" "css_element"
And I press "Save changes"
- When I follow "Course 1"
+ When I am on "Course 1" course homepage
Then I should not see "Test subfolder 2"
And I follow "Test folder"
And I should see "Test subfolder 2"
diff --git a/course/tests/courselib_test.php b/course/tests/courselib_test.php
index c726278b3967b..52edef8b1f990 100644
--- a/course/tests/courselib_test.php
+++ b/course/tests/courselib_test.php
@@ -97,6 +97,7 @@ private function assign_create_set_values(&$moduleinfo) {
$moduleinfo->sendlatenotifications = true;
$moduleinfo->duedate = time() + (7 * 24 * 3600);
$moduleinfo->cutoffdate = time() + (7 * 24 * 3600);
+ $moduleinfo->gradingduedate = time() + (7 * 24 * 3600);
$moduleinfo->allowsubmissionsfromdate = time();
$moduleinfo->teamsubmission = true;
$moduleinfo->requireallteammemberssubmit = true;
diff --git a/course/tests/externallib_test.php b/course/tests/externallib_test.php
index 9616ca2bf15df..83f56997cf44b 100644
--- a/course/tests/externallib_test.php
+++ b/course/tests/externallib_test.php
@@ -1823,6 +1823,7 @@ public function test_get_activities_overview() {
$courses = array($course1->id , $course2->id);
$result = core_course_external::get_activities_overview($courses);
+ $this->assertDebuggingCalledCount(8);
$result = external_api::clean_returnvalue(core_course_external::get_activities_overview_returns(), $result);
// There should be one entry for course1, and no others.
diff --git a/enrol/externallib.php b/enrol/externallib.php
index 711cc69ceb8ad..588fbf96f69b4 100644
--- a/enrol/externallib.php
+++ b/enrol/externallib.php
@@ -326,6 +326,11 @@ public static function get_users_courses($userid) {
$course->fullname = external_format_string($course->fullname, $context->id);
$course->shortname = external_format_string($course->shortname, $context->id);
+ $progress = null;
+ if ($course->enablecompletion) {
+ $progress = \core_completion\progress::get_course_progress_percentage($course);
+ }
+
$result[] = array(
'id' => $course->id,
'shortname' => $course->shortname,
@@ -339,7 +344,8 @@ public static function get_users_courses($userid) {
'showgrades' => $course->showgrades,
'lang' => $course->lang,
'enablecompletion' => $course->enablecompletion,
- 'category' => $course->category
+ 'category' => $course->category,
+ 'progress' => $progress,
);
}
@@ -369,6 +375,7 @@ public static function get_users_courses_returns() {
'enablecompletion' => new external_value(PARAM_BOOL, 'true if completion is enabled, otherwise false',
VALUE_OPTIONAL),
'category' => new external_value(PARAM_INT, 'course category id', VALUE_OPTIONAL),
+ 'progress' => new external_value(PARAM_FLOAT, 'Progress percentage', VALUE_OPTIONAL),
)
)
);
diff --git a/enrol/guest/tests/behat/guest_access.feature b/enrol/guest/tests/behat/guest_access.feature
index 621482a358ae7..1b05008bb5071 100644
--- a/enrol/guest/tests/behat/guest_access.feature
+++ b/enrol/guest/tests/behat/guest_access.feature
@@ -16,8 +16,7 @@ Feature: Guest users can auto-enrol themself in courses where guest access is al
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Forum" to section "1" and I fill the form with:
| Forum name | Test forum name |
| Description | Test forum description |
@@ -30,8 +29,7 @@ Feature: Guest users can auto-enrol themself in courses where guest access is al
And I press "Save changes"
And I log out
And I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
When I follow "Test forum name"
Then I should not see "Subscribe to this forum"
@@ -44,8 +42,7 @@ Feature: Guest users can auto-enrol themself in courses where guest access is al
And I press "Save changes"
And I log out
And I log in as "student1"
- And I am on site homepage
- When I follow "Course 1"
+ When I am on "Course 1" course homepage
Then I should see "Guest access"
And I set the following fields to these values:
| Password | moodle_rules |
diff --git a/enrol/lti/tests/behat/basic_settings.feature b/enrol/lti/tests/behat/basic_settings.feature
index eeb24b129d461..c2031792280d9 100644
--- a/enrol/lti/tests/behat/basic_settings.feature
+++ b/enrol/lti/tests/behat/basic_settings.feature
@@ -30,7 +30,7 @@ Feature: Check that settings are adhered to when creating an enrolment plugin
Scenario: As an admin set site-wide settings for the enrolment plugin and ensure they are used
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Enrolment methods" node in "Course administration > Users"
And I select "Publish as LTI tool" from the "Add method" singleselect
When I expand all fieldsets
diff --git a/enrol/lti/tests/behat/index_page.feature b/enrol/lti/tests/behat/index_page.feature
index 46b553fd09ade..0f7d81c44d6d2 100644
--- a/enrol/lti/tests/behat/index_page.feature
+++ b/enrol/lti/tests/behat/index_page.feature
@@ -21,8 +21,7 @@ Feature: Check that the page listing the shared external tools is functioning as
Scenario: I want to edit an external tool
Given I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Assignment" to section "1" and I fill the form with:
| Assignment name | Test assignment name |
| Description | Submit your online text |
diff --git a/enrol/meta/tests/behat/enrol_meta.feature b/enrol/meta/tests/behat/enrol_meta.feature
index e28b005e25a64..f8ba17310445c 100644
--- a/enrol/meta/tests/behat/enrol_meta.feature
+++ b/enrol/meta/tests/behat/enrol_meta.feature
@@ -34,7 +34,7 @@ Feature: Enrolments are synchronised with meta courses
And I am on course index
Scenario: Add meta enrolment instance without groups
- When I follow "Course 3"
+ When I am on "Course 3" course homepage
And I add "Course meta link" enrolment method with:
| Link course | C1C1 |
And I navigate to "Enrolled users" node in "Course administration > Users"
@@ -43,11 +43,11 @@ Feature: Enrolments are synchronised with meta courses
And I should not see "Groupcourse" in the "table.userenrolment" "css_element"
Scenario: Add meta enrolment instance with groups
- When I follow "Course 3"
+ When I am on "Course 3" course homepage
And I add "Course meta link" enrolment method with:
| Link course | C1C1 |
| Add to group | Groupcourse 1 |
- And I follow "Course 3"
+ And I am on "Course 3" course homepage
And I add "Course meta link" enrolment method with:
| Link course | C2C2 |
| Add to group | Groupcourse 2 |
@@ -62,7 +62,7 @@ Feature: Enrolments are synchronised with meta courses
And I should not see "Groupcourse 2" in the "Student 4" "table_row"
Scenario: Add meta enrolment instance with auto-created groups
- When I follow "Course 3"
+ When I am on "Course 3" course homepage
And I add "Course meta link" enrolment method with:
| Link course | C1C1 |
| Add to group | Create new group |
@@ -75,11 +75,11 @@ Feature: Enrolments are synchronised with meta courses
And the "Groups" select box should contain "Course 1 course (4)"
Scenario: Backup and restore of meta enrolment instance
- When I follow "Course 3"
+ When I am on "Course 3" course homepage
And I add "Course meta link" enrolment method with:
| Link course | C1C1 |
| Add to group | Groupcourse 1 |
- And I follow "Course 3"
+ And I am on "Course 3" course homepage
And I add "Course meta link" enrolment method with:
| Link course | C2C2 |
When I backup "Course 3" course using this options:
diff --git a/enrol/self/tests/behat/key_holder.feature b/enrol/self/tests/behat/key_holder.feature
index 31f4a8214ebab..c9cd9d46a49bf 100644
--- a/enrol/self/tests/behat/key_holder.feature
+++ b/enrol/self/tests/behat/key_holder.feature
@@ -34,15 +34,13 @@ Feature: Users can be defined as key holders in courses where self enrolment is
@javascript
Scenario: The key holder name is displayed on site home page
Given I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
When I add "Self enrolment" enrolment method with:
| Custom instance name | Test student enrolment |
| Enrolment key | moodle_rules |
And I log out
And I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I should see "You should have received this enrolment key from:"
And I should see "Manager 1"
And I set the following fields to these values:
diff --git a/enrol/self/tests/behat/self_enrolment.feature b/enrol/self/tests/behat/self_enrolment.feature
index a0c53dd7dde51..b38fb108ae440 100644
--- a/enrol/self/tests/behat/self_enrolment.feature
+++ b/enrol/self/tests/behat/self_enrolment.feature
@@ -21,11 +21,11 @@ Feature: Users can auto-enrol themself in courses where self enrolment is allowe
@javascript
Scenario: Self-enrolment enabled as guest
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I add "Self enrolment" enrolment method with:
| Custom instance name | Test student enrolment |
And I log out
- When I follow "Course 1"
+ When I am on "Course 1" course homepage
And I press "Log in as a guest"
Then I should see "Guests cannot access this course. Please log in."
And I press "Continue"
@@ -33,27 +33,25 @@ Feature: Users can auto-enrol themself in courses where self enrolment is allowe
Scenario: Self-enrolment enabled
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
When I add "Self enrolment" enrolment method with:
| Custom instance name | Test student enrolment |
And I log out
And I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I press "Enrol me"
Then I should see "Topic 1"
And I should not see "Enrolment options"
Scenario: Self-enrolment enabled requiring an enrolment key
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
When I add "Self enrolment" enrolment method with:
| Custom instance name | Test student enrolment |
| Enrolment key | moodle_rules |
And I log out
And I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I set the following fields to these values:
| Enrolment key | moodle_rules |
And I press "Enrol me"
@@ -63,18 +61,17 @@ Feature: Users can auto-enrol themself in courses where self enrolment is allowe
Scenario: Self-enrolment disabled
Given I log in as "student1"
- And I am on site homepage
- When I follow "Course 1"
+ When I am on "Course 1" course homepage
Then I should see "You can not enrol yourself in this course"
Scenario: Self-enrolment enabled requiring a group enrolment key
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
When I add "Self enrolment" enrolment method with:
| Custom instance name | Test student enrolment |
| Enrolment key | moodle_rules |
| Use group enrolment keys | Yes |
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Groups" in current page administration
And I press "Create group"
And I set the following fields to these values:
@@ -83,8 +80,7 @@ Feature: Users can auto-enrol themself in courses where self enrolment is allowe
And I press "Save changes"
And I log out
And I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I set the following fields to these values:
| Enrolment key | Test-groupenrolkey1 |
And I press "Enrol me"
diff --git a/enrol/tests/behat/add_to_group.feature b/enrol/tests/behat/add_to_group.feature
index a57e441cff9a6..79f4b4c39c7c3 100644
--- a/enrol/tests/behat/add_to_group.feature
+++ b/enrol/tests/behat/add_to_group.feature
@@ -24,7 +24,7 @@ Feature: Users can be added to multiple groups at once
Scenario: Adding a user to one group
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Enrolled users" node in "Course administration > Users"
And I click on "Add user into group" "link" in the "student1" "table_row"
When I set the field "Add user into group" to "Group 1"
@@ -33,7 +33,7 @@ Feature: Users can be added to multiple groups at once
Scenario: Adding a user to multiple group
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Enrolled users" node in "Course administration > Users"
And I click on "Add user into group" "link" in the "student1" "table_row"
When I set the field "Add user into group" to "Group 1, Group 2, Group 3"
diff --git a/enrol/tests/behat/enrol_user.feature b/enrol/tests/behat/enrol_user.feature
index 94a80c5519643..aa88075b324e5 100644
--- a/enrol/tests/behat/enrol_user.feature
+++ b/enrol/tests/behat/enrol_user.feature
@@ -13,7 +13,7 @@ Feature: User can be enrolled into a course
| Course 001 | C001 |
And I log in as "admin"
And I am on course index
- And I follow "Course 001"
+ And I am on "Course 001" course homepage
Scenario: User can be enrolled without javascript
When I enrol "Studie One" user as "Student"
diff --git a/enrol/tests/behat/filter_enrolled_users.feature b/enrol/tests/behat/filter_enrolled_users.feature
index d284305671068..8edf4584e34ef 100644
--- a/enrol/tests/behat/filter_enrolled_users.feature
+++ b/enrol/tests/behat/filter_enrolled_users.feature
@@ -39,7 +39,7 @@ Feature: Enrolled users can be filtered by group
Scenario Outline:
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Enrolled users" node in "Course administration > Users"
When I set the field "Group" to ""
diff --git a/enrol/tests/behat/manage_enrolments_from_participants.feature b/enrol/tests/behat/manage_enrolments_from_participants.feature
index d50bde399d887..e2e77451afd13 100644
--- a/enrol/tests/behat/manage_enrolments_from_participants.feature
+++ b/enrol/tests/behat/manage_enrolments_from_participants.feature
@@ -19,7 +19,7 @@ Feature: Manage enrollments from participants page
| student2 | C1 | student |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to course participants
Scenario: Check the participants link when "All partipants" selected
diff --git a/enrol/tests/enrollib_test.php b/enrol/tests/enrollib_test.php
index b3dcfc1df17f0..b9c5d7f3118c2 100644
--- a/enrol/tests/enrollib_test.php
+++ b/enrol/tests/enrollib_test.php
@@ -476,4 +476,49 @@ public function test_enrollment_update_timemodified() {
$this->assertGreaterThan($userenrolorig, $userenrolpost);
}
+
+ /**
+ * Test to confirm that enrol_get_my_courses only return the courses that
+ * the logged in user is enrolled in.
+ */
+ public function test_enrol_get_my_courses_only_enrolled_courses() {
+ $user = $this->getDataGenerator()->create_user();
+ $course1 = $this->getDataGenerator()->create_course();
+ $course2 = $this->getDataGenerator()->create_course();
+ $course3 = $this->getDataGenerator()->create_course();
+ $course4 = $this->getDataGenerator()->create_course();
+
+ $this->getDataGenerator()->enrol_user($user->id, $course1->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course2->id);
+ $this->getDataGenerator()->enrol_user($user->id, $course3->id);
+ $this->resetAfterTest(true);
+ $this->setUser($user);
+
+ // By default this function should return all of the courses the user
+ // is enrolled in.
+ $courses = enrol_get_my_courses();
+
+ $this->assertCount(3, $courses);
+ $this->assertEquals($course1->id, $courses[$course1->id]->id);
+ $this->assertEquals($course2->id, $courses[$course2->id]->id);
+ $this->assertEquals($course3->id, $courses[$course3->id]->id);
+
+ // If a set of course ids are provided then the result set will only contain
+ // these courses.
+ $courseids = [$course1->id, $course2->id];
+ $courses = enrol_get_my_courses(['id'], 'visible DESC,sortorder ASC', 0, $courseids);
+
+ $this->assertCount(2, $courses);
+ $this->assertEquals($course1->id, $courses[$course1->id]->id);
+ $this->assertEquals($course2->id, $courses[$course2->id]->id);
+
+ // If the course ids list contains any ids for courses the user isn't enrolled in
+ // then they will be ignored (in this case $course4).
+ $courseids = [$course1->id, $course2->id, $course4->id];
+ $courses = enrol_get_my_courses(['id'], 'visible DESC,sortorder ASC', 0, $courseids);
+
+ $this->assertCount(2, $courses);
+ $this->assertEquals($course1->id, $courses[$course1->id]->id);
+ $this->assertEquals($course2->id, $courses[$course2->id]->id);
+ }
}
diff --git a/files/tests/behat/add_custom_file_type.feature b/files/tests/behat/add_custom_file_type.feature
index 0ed9a61ced732..59f1773cfb3b9 100644
--- a/files/tests/behat/add_custom_file_type.feature
+++ b/files/tests/behat/add_custom_file_type.feature
@@ -28,13 +28,12 @@ Feature: Add a new custom file type
And I should see "application/x-moodle-rules"
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
When I add a "File" to section "1" and I fill the form with:
| Name | Test file |
| Select files | files/tests/fixtures/custom_filetype.mdlr |
| Show type | 1 |
| Display resource description | 1 |
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
Then I should see "Test file"
And I should see "Moodle rules" in the "span.resourcelinkdetails" "css_element"
diff --git a/files/tests/behat/course_files.feature b/files/tests/behat/course_files.feature
index af9f65ab038c4..c44e15436faa4 100644
--- a/files/tests/behat/course_files.feature
+++ b/files/tests/behat/course_files.feature
@@ -13,8 +13,7 @@ Feature: Course files
| legacyfilesinnewcourses | 1 |
| legacyfilesaddallowed | 1 |
When I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
Then "Legacy course files" "link" should exist in current page administration
And I navigate to "Legacy course files" node in "Course administration"
And I press "Edit legacy course files"
@@ -30,8 +29,7 @@ Feature: Course files
| legacyfilesinnewcourses | 1 |
| legacyfilesaddallowed | 0 |
When I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
Then "Legacy course files" "link" should exist in current page administration
And I navigate to "Legacy course files" node in "Course administration"
And I press "Edit legacy course files"
diff --git a/grade/export/txt/tests/behat/export.feature b/grade/export/txt/tests/behat/export.feature
index ea92bf6ae29d5..1965c9acdf510 100644
--- a/grade/export/txt/tests/behat/export.feature
+++ b/grade/export/txt/tests/behat/export.feature
@@ -21,7 +21,7 @@ Feature: I need to export grades as text
| assign | C1 | a1 | Test assignment name | Submit your online text | 1 |
| assign | C1 | a2 | Test assignment name 2 | Submit your online text | 1 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment name"
diff --git a/grade/export/xml/tests/behat/export.feature b/grade/export/xml/tests/behat/export.feature
index 9e6450a01817e..d1ca5aacdee8b 100644
--- a/grade/export/xml/tests/behat/export.feature
+++ b/grade/export/xml/tests/behat/export.feature
@@ -20,7 +20,7 @@ Feature: I need to export grades as xml
| activity | course | idnumber | name | intro |
| assign | C1 | a1 | Test assignment name | Submit something! |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment name"
diff --git a/grade/grading/form/guide/tests/behat/edit_guide.feature b/grade/grading/form/guide/tests/behat/edit_guide.feature
index 37a256317d48b..db90d9499b2c4 100644
--- a/grade/grading/form/guide/tests/behat/edit_guide.feature
+++ b/grade/grading/form/guide/tests/behat/edit_guide.feature
@@ -17,8 +17,7 @@ Feature: Marking guides can be created and edited
| teacher1 | C1 | editingteacher |
| student1 | C1 | student |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Assignment" to section "1" and I fill the form with:
| Assignment name | Test assignment 1 name |
| Description | Test assignment description |
@@ -93,7 +92,7 @@ Feature: Marking guides can be created and edited
And I log out
# Viewing it as a student.
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test assignment 1 name"
And I should see "80" in the ".feedback" "css_element"
And I should see "Marking guide test description" in the ".feedback" "css_element"
diff --git a/grade/grading/form/rubric/tests/behat/edit_rubric.feature b/grade/grading/form/rubric/tests/behat/edit_rubric.feature
index 6500d05d1698e..4fbde356c76c2 100644
--- a/grade/grading/form/rubric/tests/behat/edit_rubric.feature
+++ b/grade/grading/form/rubric/tests/behat/edit_rubric.feature
@@ -18,8 +18,7 @@ Feature: Rubrics can be created and edited
| teacher1 | C1 | editingteacher |
| student1 | C1 | student |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Assignment" to section "1" and I fill the form with:
| Assignment name | Test assignment 1 name |
| Description | Test assignment description |
@@ -72,7 +71,7 @@ Feature: Rubrics can be created and edited
And I log out
# Viewing it as a student.
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test assignment 1 name"
And I should see "35" in the ".feedback" "css_element"
And I should see "Rubric test description" in the ".feedback" "css_element"
@@ -82,7 +81,7 @@ Feature: Rubrics can be created and edited
And the level with "5" points is selected for the rubric criterion "Criterion 3"
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
# Editing a rubric definition without regrading students.
And I go to "Test assignment 1 name" advanced grading definition page
And "Save as draft" "button" should not exist
@@ -95,14 +94,14 @@ Feature: Rubrics can be created and edited
And I log out
# Check that the student still sees the grade.
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test assignment 1 name"
And I should see "35" in the ".feedback" "css_element"
And the level with "20" points is selected for the rubric criterion "Criterion 1"
And I log out
# Editing a rubric with significant changes.
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I go to "Test assignment 1 name" advanced grading definition page
And I click on "Move down" "button" in the "Criterion 2" "table_row"
And I replace "1" rubric level with "60" in "Criterion 1" criterion
@@ -112,14 +111,14 @@ Feature: Rubrics can be created and edited
And I log out
# Check that the student doesn't see the grade.
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test assignment 1 name"
And I should see "35" in the ".feedback" "css_element"
And the level with "20" points is not selected for the rubric criterion "Criterion 1"
And I log out
# Regrade student.
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test assignment 1 name"
And I go to "Student 1" "Test assignment 1 name" activity advanced grading page
And I should see "The rubric definition was changed after this student had been graded. The student can not see this rubric until you check the rubric and update the grade."
@@ -127,14 +126,14 @@ Feature: Rubrics can be created and edited
And I log out
# Check that the student sees the grade again.
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test assignment 1 name"
And I should see "31.82" in the ".feedback" "css_element"
And the level with "20" points is not selected for the rubric criterion "Criterion 1"
# Hide all rubric info for students
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I go to "Test assignment 1 name" advanced grading definition page
And I set the field "Allow users to preview rubric (otherwise it will only be displayed after grading)" to ""
And I set the field "Display rubric description during evaluation" to ""
@@ -147,7 +146,7 @@ Feature: Rubrics can be created and edited
And I log out
# Students should not see anything.
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test assignment 1 name"
And I should not see "Criterion 1" in the ".submissionstatustable" "css_element"
And I should not see "Criterion 2" in the ".submissionstatustable" "css_element"
diff --git a/grade/grading/form/rubric/tests/behat/grade_calculation.feature b/grade/grading/form/rubric/tests/behat/grade_calculation.feature
index 3e647147b311b..687f1a49c7e2b 100644
--- a/grade/grading/form/rubric/tests/behat/grade_calculation.feature
+++ b/grade/grading/form/rubric/tests/behat/grade_calculation.feature
@@ -23,8 +23,7 @@ Feature: Converting rubric score to grades
| activity | name | intro | course | idnumber | grade | advancedgradingmethod_submissions |
| assign | Test assignment 1 | Test | C1 | assign1 | | rubric |
When I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I go to "Test assignment 1" advanced grading definition page
And I set the following fields to these values:
| Name | Assignment 1 rubric |
diff --git a/grade/grading/form/rubric/tests/behat/negative_points.feature b/grade/grading/form/rubric/tests/behat/negative_points.feature
index 83ee60b9f8e7c..33d0e1e0deb91 100644
--- a/grade/grading/form/rubric/tests/behat/negative_points.feature
+++ b/grade/grading/form/rubric/tests/behat/negative_points.feature
@@ -27,8 +27,7 @@ Feature: Rubrics can have levels with negative scores
| activity | name | intro | course | idnumber | grade | advancedgradingmethod_submissions |
| assign | Test assignment 1 | Test | C1 | assign1 | 100 | rubric |
When I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I go to "Test assignment 1" advanced grading definition page
And I set the following fields to these values:
| Name | Assignment 1 rubric |
diff --git a/grade/grading/form/rubric/tests/behat/publish_rubric_templates.feature b/grade/grading/form/rubric/tests/behat/publish_rubric_templates.feature
index e755151d403e5..c1a5cbdf1e191 100644
--- a/grade/grading/form/rubric/tests/behat/publish_rubric_templates.feature
+++ b/grade/grading/form/rubric/tests/behat/publish_rubric_templates.feature
@@ -23,8 +23,7 @@ Feature: Publish rubrics as templates
| user | role | contextlevel | reference |
| manager1 | manager | System | |
And I log in as "manager1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I go to "Test assignment 1 name" advanced grading definition page
And I set the following fields to these values:
| Name | Assignment 1 rubric |
@@ -36,7 +35,7 @@ Feature: Publish rubrics as templates
When I publish "Test assignment 1 name" grading form definition as a public template
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I set "Test assignment 2 name" activity to use "Assignment 1 rubric" grading form
Then I should see "Advanced grading: Test assignment 2 name (Submissions)"
And I should see "Criterion 1"
diff --git a/grade/grading/form/rubric/tests/behat/reuse_own_rubrics.feature b/grade/grading/form/rubric/tests/behat/reuse_own_rubrics.feature
index 5effb3d0e32cd..f649d1129d6cf 100644
--- a/grade/grading/form/rubric/tests/behat/reuse_own_rubrics.feature
+++ b/grade/grading/form/rubric/tests/behat/reuse_own_rubrics.feature
@@ -15,8 +15,7 @@ Feature: Reuse my rubrics in other activities
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Assignment" to section "1" and I fill the form with:
| Assignment name | Test assignment 1 name |
| Description | Test assignment 1 description |
@@ -30,7 +29,7 @@ Feature: Reuse my rubrics in other activities
| Criterion 2 | Level 21 | 21 | Level 22 | 22 | Level 3 | 23 |
| Criterion 3 | Level 31 | 31 | Level 32 | 32 | | |
And I press "Save rubric and make it ready"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
When I add a "Assignment" to section "1" and I fill the form with:
| Assignment name | Test assignment 2 name |
| Description | Test assignment 2 description |
@@ -40,7 +39,7 @@ Feature: Reuse my rubrics in other activities
And I should see "Criterion 1"
And I should see "Criterion 2"
And I should see "Criterion 3"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I go to "Test assignment 1 name" advanced grading definition page
And I should see "Criterion 1"
And I should see "Criterion 2"
diff --git a/grade/report/grader/tests/behat/ajax_grader.feature b/grade/report/grader/tests/behat/ajax_grader.feature
index dddab82eb2285..b7cbe9e6fb842 100644
--- a/grade/report/grader/tests/behat/ajax_grader.feature
+++ b/grade/report/grader/tests/behat/ajax_grader.feature
@@ -53,7 +53,7 @@ Feature: Using the AJAX grading feature of Grader report to update grades and fe
| grade_overridecat | 1 |
| grade_report_showquickfeedback | 0 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I click on student "Student 2" for grade item "Item VU"
Then I should see a grade field for "Student 2" and grade item "Item VU"
@@ -105,7 +105,7 @@ Feature: Using the AJAX grading feature of Grader report to update grades and fe
| grade_overridecat | 1 |
| grade_report_showquickfeedback | 1 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I click on student "Student 2" for grade item "Item VU"
Then I should see a grade field for "Student 2" and grade item "Item VU"
@@ -142,7 +142,7 @@ Feature: Using the AJAX grading feature of Grader report to update grades and fe
| grade_overridecat | 0 |
| grade_report_showquickfeedback | 1 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I click on student "Student 2" for grade item "Item VU"
Then I should see a grade field for "Student 2" and grade item "Item VU"
@@ -162,7 +162,7 @@ Feature: Using the AJAX grading feature of Grader report to update grades and fe
| grade_overridecat | 1 |
| grade_report_showquickfeedback | 1 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
Then I should not see a grade field for "Student 2" and grade item "Item VL"
@@ -193,7 +193,7 @@ Feature: Using the AJAX grading feature of Grader report to update grades and fe
| grade_overridecat | 0 |
| grade_report_showquickfeedback | 1 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
And I change window size to "large"
diff --git a/grade/report/grader/tests/behat/switch_views.feature b/grade/report/grader/tests/behat/switch_views.feature
index 54bed2bbf64ce..7cd066a0a9856 100644
--- a/grade/report/grader/tests/behat/switch_views.feature
+++ b/grade/report/grader/tests/behat/switch_views.feature
@@ -18,8 +18,7 @@ Feature: We can change what we are viewing on the grader report
| teacher1 | C1 | editingteacher |
| student1 | C1 | student |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Assignment" to section "1" and I fill the form with:
| Assignment name | Test assignment name 1 |
| Description | Submit your online text |
@@ -30,14 +29,14 @@ Feature: We can change what we are viewing on the grader report
| assignsubmission_onlinetext_enabled | 1 |
And I log out
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test assignment name 1"
When I press "Add submission"
And I set the following fields to these values:
| Online text | This is a submission for assignment 1 |
And I press "Save changes"
Then I should see "Submitted for grading"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test assignment name 2"
When I press "Add submission"
And I set the following fields to these values:
@@ -46,7 +45,7 @@ Feature: We can change what we are viewing on the grader report
Then I should see "Submitted for grading"
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment name 1"
@@ -56,11 +55,10 @@ Feature: We can change what we are viewing on the grader report
@javascript
Scenario: View and minimise the grader report containing hidden activities
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I open "Test assignment name 2" actions menu
And I click on "Hide" "link" in the "Test assignment name 2" activity
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I should see "Test assignment name 1"
And I should see "Test assignment name 2"
@@ -85,8 +83,7 @@ Feature: We can change what we are viewing on the grader report
@javascript
Scenario: View and minimise the grader report containing hidden activities without the 'moodle/grade:viewhidden' capability
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I open "Test assignment name 2" actions menu
And I click on "Hide" "link" in the "Test assignment name 2" activity
And I log out
@@ -99,7 +96,7 @@ Feature: We can change what we are viewing on the grader report
| user | course | role |
| student2 | C1 | student |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I should see "Test assignment name 1"
And I should see "Test assignment name 2"
diff --git a/grade/report/history/tests/behat/basic_functionality.feature b/grade/report/history/tests/behat/basic_functionality.feature
index 3704c3ad4202e..119bd083f92de 100644
--- a/grade/report/history/tests/behat/basic_functionality.feature
+++ b/grade/report/history/tests/behat/basic_functionality.feature
@@ -22,8 +22,7 @@ Feature: A teacher checks the grade history report in a course
| student1 | C1 | student |
| student2 | C1 | student |
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Assignment" to section "1" and I fill the form with:
| Assignment name | The greatest assignment ever |
| Description | Write a behat test for Moodle - it's amazing! |
@@ -39,7 +38,7 @@ Feature: A teacher checks the grade history report in a course
And I press "Save changes"
And I log out
And I log in as "teacher2"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
And I give the grade "70.00" to the user "Student 1" for the grade item "The greatest assignment ever"
diff --git a/grade/report/singleview/tests/behat/bulk_insert_grades.feature b/grade/report/singleview/tests/behat/bulk_insert_grades.feature
index fe94e1fcf2f8d..c99aefe1a2ab6 100644
--- a/grade/report/singleview/tests/behat/bulk_insert_grades.feature
+++ b/grade/report/singleview/tests/behat/bulk_insert_grades.feature
@@ -31,7 +31,7 @@ Feature: We can bulk insert grades for students in a course
Scenario: I can bulk insert grades and check their override flags for grade view.
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test assignment one"
And I navigate to "View all submissions" in current page administration
And I click on "Grade" "link" in the "Student 1" "table_row"
@@ -39,7 +39,7 @@ Feature: We can bulk insert grades for students in a course
| Grade out of 100 | 50 |
And I press "Save changes"
And I press "Ok"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I follow "Single view for Test assignment one"
Then the field "Grade for james (Student) 1" matches value "50.00"
@@ -72,7 +72,7 @@ Feature: We can bulk insert grades for students in a course
Scenario: I can bulk insert grades and check their override flags for user view.
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test assignment two"
And I navigate to "View all submissions" in current page administration
And I click on "Grade" "link" in the "Student 1" "table_row"
@@ -80,7 +80,7 @@ Feature: We can bulk insert grades for students in a course
| Grade out of 100 | 50 |
And I press "Save changes"
And I press "Ok"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
# And I click on "input[title='Dock Navigation block']" "css_element"
# And I click on "input[title='Dock Administration block']" "css_element"
diff --git a/grade/report/singleview/tests/behat/singleview.feature b/grade/report/singleview/tests/behat/singleview.feature
index cd1774fd9a2c1..bfd7d7fc2db26 100644
--- a/grade/report/singleview/tests/behat/singleview.feature
+++ b/grade/report/singleview/tests/behat/singleview.feature
@@ -51,7 +51,7 @@ Feature: We can use Single view
| moodle/grade:edit | Allow | teacher | Course | C1 |
| gradereport/singleview:view | Allow | teacher | Course | C1 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
Given I navigate to "View > Grader report" in the course gradebook
@javascript
@@ -96,7 +96,7 @@ Feature: We can use Single view
| james (Student) 1 | Very good |
And I log out
And I log in as "teacher2"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
Given I navigate to "View > Single view" in the course gradebook
And I click on "Student 4" "option"
And the "Exclude for Test assignment one" "checkbox" should be disabled
diff --git a/grade/report/user/tests/behat/user_view.feature b/grade/report/user/tests/behat/user_view.feature
index e54ac6f187ea8..eb9bef2d33405 100644
--- a/grade/report/user/tests/behat/user_view.feature
+++ b/grade/report/user/tests/behat/user_view.feature
@@ -31,7 +31,7 @@ Feature: View the user report as the student will see it
| assign | C1 | a5 | Test assignment five | Submit something! | 100 |
| assign | C1 | a6 | Test assignment six | Submit something! | 100 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Gradebook setup" in the course gradebook
And I hide the grade item "Test assignment six"
And I hide the grade item "Sub category 2"
@@ -82,7 +82,7 @@ Feature: View the user report as the student will see it
| Test assignment six |
And I log out
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "User report" in the course gradebook
Then the following should exist in the "user-grade" table:
| Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total |
@@ -120,7 +120,7 @@ Feature: View the user report as the student will see it
| Test assignment six |
And I log out
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "User report" in the course gradebook
Then the following should exist in the "user-grade" table:
| Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total |
@@ -158,7 +158,7 @@ Feature: View the user report as the student will see it
| Test assignment six |
And I log out
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "User report" in the course gradebook
Then the following should exist in the "user-grade" table:
| Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total |
@@ -182,7 +182,7 @@ Feature: View the user report as the student will see it
| moodle/grade:viewhidden | Allow |
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Course grade settings" in the course gradebook
And I set the field with xpath "//select[@name='report_user_showtotalsifcontainhidden']" to "Show totals excluding hidden items"
And I press "Save changes"
@@ -202,7 +202,7 @@ Feature: View the user report as the student will see it
| Course total | - | 383.00 | 0–600 | 63.83 % | - |
And I log out
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "User report" in the course gradebook
Then the following should exist in the "user-grade" table:
| Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total |
diff --git a/grade/report/user/tests/behat/view_usereport.feature b/grade/report/user/tests/behat/view_usereport.feature
index 3fc9563afe551..3aaf02aefbcfc 100644
--- a/grade/report/user/tests/behat/view_usereport.feature
+++ b/grade/report/user/tests/behat/view_usereport.feature
@@ -10,8 +10,7 @@ Feature: We can use the user report
Scenario: Verify we can view a user grade report with no users enrolled.
Given I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > User report" in the course gradebook
And I select "All users (0)" from the "Select all or one user" singleselect
Then I should see "No students enrolled in this course yet"
diff --git a/grade/tests/behat/grade_UI_settings.feature b/grade/tests/behat/grade_UI_settings.feature
index 5661e329b05da..b354dae3e4f1d 100644
--- a/grade/tests/behat/grade_UI_settings.feature
+++ b/grade/tests/behat/grade_UI_settings.feature
@@ -18,8 +18,7 @@ Feature: Site settings can be used to hide parts of the gradebook UI
| activity | course | idnumber | name | intro |
| assign | C1 | assign1 | Assignment1 | Assignment 1 intro |
And I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
@@ -30,8 +29,7 @@ Feature: Site settings can be used to hide parts of the gradebook UI
Then I navigate to "General settings" node in "Site administration > Grades"
And I set the field "Show minimum grade" to "0"
And I press "Save changes"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I click on "Edit assign Assignment1" "link"
And I should not see "Minimum grade"
@@ -42,8 +40,7 @@ Feature: Site settings can be used to hide parts of the gradebook UI
When I navigate to "Grader report" node in "Site administration > Grades > Report settings"
And I set the field "Show calculations" to "0"
And I press "Save changes"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
Then "Edit calculation for Course total" "link" should not exist
@@ -53,7 +50,6 @@ Feature: Site settings can be used to hide parts of the gradebook UI
Then I navigate to "Grade category settings" node in "Site administration > Grades"
And I set the field "Allow category grades to be manually overridden" to "0"
And I press "Save changes"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And "tr .course input[type='text']" "css_element" should not exist
diff --git a/grade/tests/behat/grade_aggregation.feature b/grade/tests/behat/grade_aggregation.feature
index df80dd3d24fae..68a9104123439 100644
--- a/grade/tests/behat/grade_aggregation.feature
+++ b/grade/tests/behat/grade_aggregation.feature
@@ -41,7 +41,7 @@ Feature: We can use calculated grade totals
| grade_aggregations_visible | Mean of grades,Weighted mean of grades,Simple weighted mean of grades,Mean of grades (with extra credits),Median of grades,Lowest grade,Highest grade,Mode of grades,Natural |
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
And I change window size to "large"
@@ -256,7 +256,7 @@ Feature: We can use calculated grade totals
And "Test outcome item one" row "Grade" column of "user-grade" table should contain "Excellent (100.00 %)"
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Gradebook setup" in the course gradebook
And I set the following settings for grade item "Test outcome item one":
| Extra credit | 1 |
@@ -268,7 +268,7 @@ Feature: We can use calculated grade totals
And "Test outcome item one" row "Grade" column of "user-grade" table should contain "Excellent (100.00 %)"
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Gradebook setup" in the course gradebook
And I set the following settings for grade item "Course 1":
| Aggregation | Natural |
@@ -370,8 +370,7 @@ Feature: We can use calculated grade totals
Scenario: Natural aggregation with drop lowest
When I log out
And I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
And I set the following settings for grade item "Sub category 1":
diff --git a/grade/tests/behat/grade_aggregation_changes.feature b/grade/tests/behat/grade_aggregation_changes.feature
index 89db8d5680ef5..68835bb361ee4 100644
--- a/grade/tests/behat/grade_aggregation_changes.feature
+++ b/grade/tests/behat/grade_aggregation_changes.feature
@@ -33,8 +33,7 @@ Feature: Changing the aggregation of an item affects its weight and extra credit
And I log in as "admin"
And I set the following administration settings values:
| grade_aggregations_visible | Mean of grades,Weighted mean of grades,Simple weighted mean of grades,Mean of grades (with extra credits),Median of grades,Lowest grade,Highest grade,Mode of grades,Natural |
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
And I follow "Edit Cat mean"
diff --git a/grade/tests/behat/grade_average.feature b/grade/tests/behat/grade_average.feature
index f60cfa1582149..abbfe4fb3cec4 100644
--- a/grade/tests/behat/grade_average.feature
+++ b/grade/tests/behat/grade_average.feature
@@ -21,8 +21,7 @@ Feature: Average grades are displayed in the gradebook
| student2 | C1 | student |
| student3 | C1 | student |
And I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
# Enable averages
And I navigate to "Setup > Course grade settings" in the course gradebook
And I set the following fields to these values:
@@ -58,8 +57,7 @@ Feature: Average grades are displayed in the gradebook
# Check the user grade table
And I log in as "student1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "User report" in the course gradebook
Then I should see "50.00" in the ".level2.column-grade" "css_element"
Then I should see "50.00" in the ".level2.column-average" "css_element"
diff --git a/grade/tests/behat/grade_calculated_grade_items.feature b/grade/tests/behat/grade_calculated_grade_items.feature
index 57046899f7b84..e3cca8d185fb3 100644
--- a/grade/tests/behat/grade_calculated_grade_items.feature
+++ b/grade/tests/behat/grade_calculated_grade_items.feature
@@ -19,8 +19,7 @@ Feature: Calculated grade items can be used in the gradebook
| student1 | C1 | student |
| student2 | C1 | student |
And I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Gradebook setup" in the course gradebook
@javascript
diff --git a/grade/tests/behat/grade_calculated_grade_items_20150627.feature b/grade/tests/behat/grade_calculated_grade_items_20150627.feature
index e1eb3fbf9699c..88558150a3092 100644
--- a/grade/tests/behat/grade_calculated_grade_items_20150627.feature
+++ b/grade/tests/behat/grade_calculated_grade_items_20150627.feature
@@ -20,8 +20,7 @@ Feature: Gradebook calculations for calculated grade items before the fix 201506
| student1 | C1 | student |
| student2 | C1 | student |
And I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Gradebook setup" in the course gradebook
@javascript
diff --git a/grade/tests/behat/grade_calculated_weights.feature b/grade/tests/behat/grade_calculated_weights.feature
index 47a30400de87e..88b20c35f9661 100644
--- a/grade/tests/behat/grade_calculated_weights.feature
+++ b/grade/tests/behat/grade_calculated_weights.feature
@@ -29,7 +29,7 @@ Feature: We can understand the gradebook user report
| grade_aggregations_visible | Mean of grades,Weighted mean of grades,Simple weighted mean of grades,Mean of grades (with extra credits),Median of grades,Lowest grade,Highest grade,Mode of grades,Natural |
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
And I give the grade "60.00" to the user "Student 1" for the grade item "Test assignment one"
diff --git a/grade/tests/behat/grade_category_validation.feature b/grade/tests/behat/grade_category_validation.feature
index 74cff6208a596..ad270465406f1 100644
--- a/grade/tests/behat/grade_category_validation.feature
+++ b/grade/tests/behat/grade_category_validation.feature
@@ -32,8 +32,7 @@ Feature: Editing a grade item
| grade_aggregations_visible | Mean of grades,Weighted mean of grades,Simple weighted mean of grades,Mean of grades (with extra credits),Median of grades,Lowest grade,Highest grade,Mode of grades,Natural |
And I log out
And I log in as "teacher1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Gradebook setup" in the course gradebook
And I press "Add category"
And I set the following fields to these values:
diff --git a/grade/tests/behat/grade_contribution_with_extra_credit.feature b/grade/tests/behat/grade_contribution_with_extra_credit.feature
index 05311952deca4..cb53856f38c4d 100644
--- a/grade/tests/behat/grade_contribution_with_extra_credit.feature
+++ b/grade/tests/behat/grade_contribution_with_extra_credit.feature
@@ -19,8 +19,7 @@ Feature: Extra credit contributions are normalised when going out of bounds
And I log in as "admin"
And I set the following administration settings values:
| grade_aggregations_visible | Simple weighted mean of grades,Mean of grades (with extra credits),Natural |
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Gradebook setup" in the course gradebook
And I press "Add grade item"
And I set the following fields to these values:
@@ -45,7 +44,7 @@ Feature: Extra credit contributions are normalised when going out of bounds
And I press "Save changes"
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
And I give the grade "80.00" to the user "Student 1" for the grade item "Manual item 1"
diff --git a/grade/tests/behat/grade_grade_minmax_change.feature b/grade/tests/behat/grade_grade_minmax_change.feature
index 16d6abd043099..1ed3712b04f9a 100644
--- a/grade/tests/behat/grade_grade_minmax_change.feature
+++ b/grade/tests/behat/grade_grade_minmax_change.feature
@@ -20,8 +20,7 @@ Feature: We can change the maximum and minimum number of points for manual items
| student1 | C1 | student |
| student2 | C1 | student |
And I log in as "teacher1"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Gradebook setup" in the course gradebook
And I press "Add grade item"
And I set the following fields to these values:
@@ -35,7 +34,7 @@ Feature: We can change the maximum and minimum number of points for manual items
And I press "Save changes"
Scenario: Change maximum number of points on a graded item.
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
And I give the grade "10.00" to the user "Student 1" for the grade item "Manual item 1"
diff --git a/grade/tests/behat/grade_hidden_items.feature b/grade/tests/behat/grade_hidden_items.feature
index fd7aa450f2d8d..ca3b5180eb5c6 100644
--- a/grade/tests/behat/grade_hidden_items.feature
+++ b/grade/tests/behat/grade_hidden_items.feature
@@ -34,7 +34,7 @@ Feature: Student and teacher's view of aggregated grade items is consistent when
And I press "Save changes"
When I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
And I give the grade "50.00" to the user "Student 1" for the grade item "Test assignment one"
@@ -43,7 +43,7 @@ Feature: Student and teacher's view of aggregated grade items is consistent when
And I set the following settings for grade item "Test assignment four":
| Hidden | 1 |
And I press "Save changes"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > User report" in the course gradebook
And I select "Myself" from the "View report as" singleselect
And I select "Student 1" from the "Select all or one user" singleselect
@@ -55,7 +55,7 @@ Feature: Student and teacher's view of aggregated grade items is consistent when
| Course total | - | 100.00 | 0–200 | 50.00 % | - |
When I log out
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "User report" in the course gradebook
Then the following should exist in the "user-grade" table:
| Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total |
diff --git a/grade/tests/behat/grade_item_validation.feature b/grade/tests/behat/grade_item_validation.feature
index ef381aad6aec5..4f3d6cb3663f9 100644
--- a/grade/tests/behat/grade_item_validation.feature
+++ b/grade/tests/behat/grade_item_validation.feature
@@ -28,8 +28,7 @@ Feature: Grade item validation
| Name | Letter scale |
| Scale | Disappointing, Good, Very good, Excellent |
And I press "Save changes"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Gradebook setup" in the course gradebook
And I press "Add grade item"
And I set the following fields to these values:
diff --git a/grade/tests/behat/grade_letter_boundary.feature b/grade/tests/behat/grade_letter_boundary.feature
index 33466731920ee..d9d951c3ff866 100644
--- a/grade/tests/behat/grade_letter_boundary.feature
+++ b/grade/tests/behat/grade_letter_boundary.feature
@@ -21,7 +21,7 @@ Feature: We can customise the letter boundary of a course.
| activity | course | idnumber | name | intro | grade |
| assign | C1 | a1 | Test assignment one | Submit something! | 100 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Course grade settings" in the course gradebook
And I set the following fields to these values:
| Grade display type | Letter |
diff --git a/grade/tests/behat/grade_letter_boundary_20160518.feature b/grade/tests/behat/grade_letter_boundary_20160518.feature
index 8ec6dafd5714f..0f5dbc18dcdf7 100644
--- a/grade/tests/behat/grade_letter_boundary_20160518.feature
+++ b/grade/tests/behat/grade_letter_boundary_20160518.feature
@@ -22,7 +22,7 @@ Feature: We can customise the letter boundary of a course in gradebook version 2
| activity | course | idnumber | name | intro | grade |
| assign | C1 | a1 | Test assignment one | Submit something! | 100 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Course grade settings" in the course gradebook
And I set the following fields to these values:
| Grade display type | Letter |
diff --git a/grade/tests/behat/grade_mingrade.feature b/grade/tests/behat/grade_mingrade.feature
index 0011f2086e43b..b385b3d27ae30 100644
--- a/grade/tests/behat/grade_mingrade.feature
+++ b/grade/tests/behat/grade_mingrade.feature
@@ -25,8 +25,7 @@ Feature: We can use a minimum grade different than zero
And I log in as "admin"
And I set the following administration settings values:
| grade_aggregations_visible | Mean of grades,Weighted mean of grades,Simple weighted mean of grades,Mean of grades (with extra credits),Median of grades,Lowest grade,Highest grade,Mode of grades,Natural |
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Gradebook setup" in the course gradebook
And I press "Add grade item"
And I set the following fields to these values:
@@ -84,7 +83,7 @@ Feature: We can use a minimum grade different than zero
| Exclude empty grades | 0 |
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
When I give the grade "-25.00" to the user "Student 1" for the grade item "Manual item 1"
diff --git a/grade/tests/behat/grade_natural_exclude_empty.feature b/grade/tests/behat/grade_natural_exclude_empty.feature
index 37f411d4e56de..b23be1f4533c2 100644
--- a/grade/tests/behat/grade_natural_exclude_empty.feature
+++ b/grade/tests/behat/grade_natural_exclude_empty.feature
@@ -24,7 +24,7 @@ Feature: Weights in natural aggregation are adjusted if the items are excluded f
| assign | C1 | a4 | Test assignment four (extra) | x | 20 |
| assign | C1 | a5 | Test assignment five (extra) | x | 10 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Gradebook setup" in the course gradebook
And I set the following settings for grade item "Test assignment four (extra)":
| Extra credit | 1 |
diff --git a/grade/tests/behat/grade_natural_exclude_empty_20150619.feature b/grade/tests/behat/grade_natural_exclude_empty_20150619.feature
index 54dfc00d25dba..39578ff9a3842 100644
--- a/grade/tests/behat/grade_natural_exclude_empty_20150619.feature
+++ b/grade/tests/behat/grade_natural_exclude_empty_20150619.feature
@@ -25,7 +25,7 @@ Feature: Gradebook calculations for extra credit items before the fix 20150619
| assign | C1 | a4 | Test assignment four (extra) | x | 20 |
| assign | C1 | a5 | Test assignment five (extra) | x | 10 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Gradebook setup" in the course gradebook
And I set the following settings for grade item "Test assignment four (extra)":
| Extra credit | 1 |
diff --git a/grade/tests/behat/grade_natural_normalisation.feature b/grade/tests/behat/grade_natural_normalisation.feature
index 82dbd8d05b716..4706e101d1e96 100644
--- a/grade/tests/behat/grade_natural_normalisation.feature
+++ b/grade/tests/behat/grade_natural_normalisation.feature
@@ -31,7 +31,7 @@ Feature: We can use natural aggregation and weights will be normalised to a tota
| assign | C1 | a6 | Test assignment six | Submit something! | Sub category 1 | 10 |
| assign | C1 | a7 | Test assignment seven | Submit nothing! | Sub category 1 | 15 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Gradebook setup" in the course gradebook
@javascript
diff --git a/grade/tests/behat/grade_natural_normalisation_20150619.feature b/grade/tests/behat/grade_natural_normalisation_20150619.feature
index b302102589a7a..887a5c0000e88 100644
--- a/grade/tests/behat/grade_natural_normalisation_20150619.feature
+++ b/grade/tests/behat/grade_natural_normalisation_20150619.feature
@@ -32,7 +32,7 @@ Feature: Gradebook calculations for natural weights normalisation before the fix
| assign | C1 | a6 | Test assignment six | Submit something! | Sub category 1 | 10 |
| assign | C1 | a7 | Test assignment seven | Submit nothing! | Sub category 1 | 15 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Gradebook setup" in the course gradebook
@javascript
diff --git a/grade/tests/behat/grade_override_letter.feature b/grade/tests/behat/grade_override_letter.feature
index be0ff3dd9079f..da25498442b56 100644
--- a/grade/tests/behat/grade_override_letter.feature
+++ b/grade/tests/behat/grade_override_letter.feature
@@ -15,7 +15,7 @@ Feature: Grade letters can be overridden
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Letters > Edit" in the course gradebook
Scenario Outline: Grade letters can be completely overridden
diff --git a/grade/tests/behat/grade_point_maximum.feature b/grade/tests/behat/grade_point_maximum.feature
index 347b9860c3a8a..5e1723746297f 100644
--- a/grade/tests/behat/grade_point_maximum.feature
+++ b/grade/tests/behat/grade_point_maximum.feature
@@ -19,8 +19,7 @@ Feature: We can change the grading type and maximum grade point values
| Grade point maximum | 900 |
| Grade point default | 800 |
And I press "Save changes"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
@javascript
Scenario: Validate that switching the type of grading used correctly disables input form elements
@@ -97,8 +96,7 @@ Feature: We can change the grading type and maximum grade point values
And I set the following fields to these values:
| Grade point maximum | 100 |
And I press "Save changes"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test Assignment 1"
And I navigate to "Edit settings" in current page administration
And I press "Save and display"
diff --git a/grade/tests/behat/grade_scales.feature b/grade/tests/behat/grade_scales.feature
index 400e96fb43d8a..d673eabf7cbf2 100644
--- a/grade/tests/behat/grade_scales.feature
+++ b/grade/tests/behat/grade_scales.feature
@@ -42,7 +42,7 @@ Feature: View gradebook when scales are used
| activity | course | idnumber | name | intro | gradecategory |
| assign | C1 | a1 | Test assignment one | Submit something! | Sub category 1 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test assignment one"
And I navigate to "Edit settings" in current page administration
And I expand all fieldsets
@@ -70,7 +70,7 @@ Feature: View gradebook when scales are used
And I set the field "Grade" to "F"
And I press "Save changes"
And I press "Ok"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Course grade settings" in the course gradebook
And I set the field "Show weightings" to "Show"
And I set the field "Show contribution to course total" to "Show"
diff --git a/grade/tests/behat/grade_scales_aggregation.feature b/grade/tests/behat/grade_scales_aggregation.feature
index dc2092b9d7892..8a26b40519a9e 100644
--- a/grade/tests/behat/grade_scales_aggregation.feature
+++ b/grade/tests/behat/grade_scales_aggregation.feature
@@ -38,7 +38,7 @@ Feature: Control the aggregation of the scales
Scenario Outline: Scales can be excluded from aggregation
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
When I give the grade "10" to the user "Student 1" for the grade item "Grade me"
@@ -59,7 +59,7 @@ Feature: Control the aggregation of the scales
| grade_includescalesinaggregation | 1 |
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > User report" in the course gradebook
And I select "Student 1" from the "Select all or one user" singleselect
And the following should exist in the "user-grade" table:
@@ -83,7 +83,7 @@ Feature: Control the aggregation of the scales
@javascript
Scenario: Weights of scales cannot be edited when they are not aggregated
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
When I set the following settings for grade item "Course 1":
@@ -98,7 +98,7 @@ Feature: Control the aggregation of the scales
And I should not see "Weight"
And the following config values are set as admin:
| grade_includescalesinaggregation | 1 |
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Gradebook setup" in the course gradebook
And I set the field "Override weight of Grade me" to "1"
And the field "Override weight of Grade me" matches value "95.238"
diff --git a/grade/tests/behat/grade_single_item_scales.feature b/grade/tests/behat/grade_single_item_scales.feature
index 2f4a7cc158a1d..1b319e328d0e9 100644
--- a/grade/tests/behat/grade_single_item_scales.feature
+++ b/grade/tests/behat/grade_single_item_scales.feature
@@ -36,7 +36,7 @@ Feature: View gradebook when single item scales are used
| activity | course | idnumber | name | intro | gradecategory |
| assign | C1 | a1 | Test assignment one | Submit something! | Sub category 1 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test assignment one"
And I navigate to "Edit settings" in current page administration
And I expand all fieldsets
@@ -48,7 +48,7 @@ Feature: View gradebook when single item scales are used
And I set the field "Grade" to "A"
And I press "Save changes"
And I press "Ok"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Setup > Course grade settings" in the course gradebook
And I set the field "Show weightings" to "Show"
And I set the field "Show contribution to course total" to "Show"
diff --git a/grade/tests/behat/grade_to_pass.feature b/grade/tests/behat/grade_to_pass.feature
index b108e06b107ef..a59f0fc396f86 100644
--- a/grade/tests/behat/grade_to_pass.feature
+++ b/grade/tests/behat/grade_to_pass.feature
@@ -19,7 +19,7 @@ Feature: We can set the grade to pass value
| name | scale |
| Test Scale 1 | Disappointing, Good, Very good, Excellent |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
@javascript
Scenario: Validate that switching the type of grading used correctly disables grade to pass
@@ -58,7 +58,7 @@ Feature: We can set the grade to pass value
And I turn editing mode on
And I click on "Edit assign Test Assignment 1" "link"
Then the field "Grade to pass" matches value "25"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test Assignment 1"
And I follow "Edit settings"
And I expand all fieldsets
@@ -83,7 +83,7 @@ Feature: We can set the grade to pass value
Then the field "Grade to pass" matches value "3"
And I set the field "Grade to pass" to "4"
And I press "Save changes"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test Assignment 1"
And I follow "Edit settings"
And the field "Grade to pass" matches value "4"
@@ -119,7 +119,7 @@ Feature: We can set the grade to pass value
And the field "Grade to pass" matches value "10"
And I set the field "Grade to pass" to "15"
And I press "Save changes"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test Workshop 1"
And I follow "Edit settings"
And the field "Submission grade to pass" matches value "45"
@@ -149,7 +149,7 @@ Feature: We can set the grade to pass value
Then the field "Grade to pass" matches value "9.5"
And I set the field "Grade to pass" to "8"
And I press "Save changes"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test Quiz 1"
And I follow "Edit settings"
And the field "Grade to pass" matches value "8.00"
@@ -167,7 +167,7 @@ Feature: We can set the grade to pass value
Then the field "Grade to pass" matches value "90"
And I set the field "Grade to pass" to "80"
And I press "Save changes"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test Lesson 1"
And I follow "Edit settings"
And the field "Grade to pass" matches value "80"
@@ -186,7 +186,7 @@ Feature: We can set the grade to pass value
Then the field "Grade to pass" matches value "90"
And I set the field "Grade to pass" to "80"
And I press "Save changes"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I click on "Edit settings" "link" in the "Test Database 1" activity
And the field "Grade to pass" matches value "80"
@@ -214,7 +214,7 @@ Feature: We can set the grade to pass value
Then the field "Grade to pass" matches value "90"
And I set the field "Grade to pass" to "80"
And I press "Save changes"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test Forum 1"
And I follow "Edit settings"
And the field "Grade to pass" matches value "80"
@@ -233,7 +233,7 @@ Feature: We can set the grade to pass value
Then the field "Grade to pass" matches value "90"
And I set the field "Grade to pass" to "80"
And I press "Save changes"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test Glossary 1"
And I follow "Edit settings"
And the field "Grade to pass" matches value "80"
diff --git a/grade/tests/behat/grade_view.feature b/grade/tests/behat/grade_view.feature
index f2c85c47bcda6..1700dc0efedd3 100644
--- a/grade/tests/behat/grade_view.feature
+++ b/grade/tests/behat/grade_view.feature
@@ -22,8 +22,7 @@ Feature: We can enter in grades and view reports from the gradebook
| grade_aggregations_visible | Mean of grades,Weighted mean of grades,Simple weighted mean of grades,Mean of grades (with extra credits),Median of grades,Lowest grade,Highest grade,Mode of grades,Natural |
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
- And I turn editing mode on
+ And I am on "Course 1" course homepage with editing mode on
And I add a "Assignment" to section "1" and I fill the form with:
| Assignment name | Test assignment name 1 |
| Description | Submit your online text |
@@ -34,14 +33,14 @@ Feature: We can enter in grades and view reports from the gradebook
| assignsubmission_onlinetext_enabled | 1 |
And I log out
And I log in as "student1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test assignment name 1"
When I press "Add submission"
And I set the following fields to these values:
| Online text | This is a submission for assignment 1 |
And I press "Save changes"
Then I should see "Submitted for grading"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I follow "Test assignment name 2"
When I press "Add submission"
And I set the following fields to these values:
@@ -50,7 +49,7 @@ Feature: We can enter in grades and view reports from the gradebook
Then I should see "Submitted for grading"
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "View > Grader report" in the course gradebook
And I turn editing mode on
And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment name 1"
diff --git a/group/tests/behat/auto_creation.feature b/group/tests/behat/auto_creation.feature
index e41b32fc9d8a3..8610678a60aaa 100644
--- a/group/tests/behat/auto_creation.feature
+++ b/group/tests/behat/auto_creation.feature
@@ -37,7 +37,7 @@ Feature: Automatic creation of groups
| student10 | C1 | student | 0 |
| suspendedstudent11 | C1 | student | 1 |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Groups" in current page administration
When I press "Auto-create groups"
And I expand all fieldsets
@@ -163,7 +163,7 @@ Feature: Automatic creation of groups
| moodle/course:viewsuspendedusers | Prevent |
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Groups" in current page administration
When I press "Auto-create groups"
Then I should not see "Include only active enrolments"
diff --git a/group/tests/behat/create_groups.feature b/group/tests/behat/create_groups.feature
index b2cdd223dffda..4642d4d5f36ed 100644
--- a/group/tests/behat/create_groups.feature
+++ b/group/tests/behat/create_groups.feature
@@ -24,7 +24,7 @@ Feature: Organize students into groups
| student2 | C1 | student |
| student3 | C1 | student |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Groups" in current page administration
And I press "Create group"
And I set the following fields to these values:
@@ -71,7 +71,7 @@ Feature: Organize students into groups
| moodle/course:changeidnumber | Prevent |
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Groups" in current page administration
When I press "Create group"
Then the "idnumber" "field" should be readonly
@@ -93,8 +93,7 @@ Feature: Organize students into groups
| Course 1 | C1 | 0 | 1 |
| Course 2 | C2 | 0 | 1 |
And I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Groups" in current page administration
When I press "Create group"
And I set the following fields to these values:
@@ -116,8 +115,7 @@ Feature: Organize students into groups
| Enrolment key | Abcdef-2 |
And I press "Save changes"
And the "groups" select box should contain "Group B (0)"
- And I am on site homepage
- And I follow "Course 2"
+ And I am on "Course 2" course homepage
And I navigate to "Users > Groups" in current page administration
And I press "Create group"
And I set the following fields to these values:
diff --git a/group/tests/behat/delete_groups.feature b/group/tests/behat/delete_groups.feature
index b77d0007c0bae..9c89d407d5e00 100644
--- a/group/tests/behat/delete_groups.feature
+++ b/group/tests/behat/delete_groups.feature
@@ -15,7 +15,7 @@ Feature: Automatic deletion of groups and groupings
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Groups" in current page administration
And I press "Create group"
And I set the following fields to these values:
@@ -64,7 +64,7 @@ Feature: Automatic deletion of groups and groupings
| moodle/course:changeidnumber | Prevent |
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Groups" in current page administration
When I set the field "groups" to "Group (with ID) (0)"
Then the "Delete selected group" "button" should be disabled
diff --git a/group/tests/behat/groups_import.feature b/group/tests/behat/groups_import.feature
index eaea7d4c4396e..0bec1e371bee9 100644
--- a/group/tests/behat/groups_import.feature
+++ b/group/tests/behat/groups_import.feature
@@ -18,7 +18,7 @@ Feature: Importing of groups and groupings
@javascript
Scenario: Import groups and groupings as teacher
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Groups" in current page administration
And I press "Import groups"
When I upload "group/tests/fixtures/groups_import.csv" file to "Import" filemanager
@@ -42,7 +42,7 @@ Feature: Importing of groups and groupings
@javascript
Scenario: Import groups with idnumber when the user has proper permissions for the idnumber field
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Groups" in current page administration
And I press "Import groups"
When I upload "group/tests/fixtures/groups_import.csv" file to "Import" filemanager
@@ -78,14 +78,13 @@ Feature: Importing of groups and groupings
@javascript
Scenario: Import groups with idnumber when the user does not have proper permissions for the idnumber field
Given I log in as "admin"
- And I am on site homepage
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Permissions" in current page administration
And I override the system permissions of "Teacher" role with:
| moodle/course:changeidnumber | Prevent |
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Groups" in current page administration
And I press "Import groups"
When I upload "group/tests/fixtures/groups_import.csv" file to "Import" filemanager
diff --git a/group/tests/behat/id_uniqueness.feature b/group/tests/behat/id_uniqueness.feature
index 14c18c461901b..779b1da8eaf76 100644
--- a/group/tests/behat/id_uniqueness.feature
+++ b/group/tests/behat/id_uniqueness.feature
@@ -15,7 +15,7 @@ Feature: Uniqueness of Group ID number
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Groups" in current page administration
Scenario: Group ID number uniqueness
diff --git a/group/tests/behat/overview.feature b/group/tests/behat/overview.feature
index 422c0738174b7..c2ef16edf02f2 100644
--- a/group/tests/behat/overview.feature
+++ b/group/tests/behat/overview.feature
@@ -57,7 +57,7 @@ Feature: Group overview
Scenario: Filter the overview in various different ways
Given I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Groups" node in "Course administration > Users"
And I follow "Overview"
diff --git a/group/tests/behat/update_groups.feature b/group/tests/behat/update_groups.feature
index 6da490d0c7fa6..9d6c53066b27f 100644
--- a/group/tests/behat/update_groups.feature
+++ b/group/tests/behat/update_groups.feature
@@ -15,7 +15,7 @@ Feature: Automatic updating of groups and groupings
| user | course | role |
| teacher1 | C1 | editingteacher |
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Groups" in current page administration
And I press "Create group"
And I set the following fields to these values:
@@ -71,7 +71,7 @@ Feature: Automatic updating of groups and groupings
| moodle/course:changeidnumber | Prevent |
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Groups" in current page administration
And I set the field "groups" to "Group (with ID)"
When I press "Edit group settings"
@@ -108,7 +108,7 @@ Feature: Automatic updating of groups and groupings
| teacher1 | C2 | editingteacher |
And I log out
And I log in as "teacher1"
- And I follow "Course 1"
+ And I am on "Course 1" course homepage
And I navigate to "Users > Groups" in current page administration
And I set the field "groups" to "Group (with ID)"
And I press "Edit group settings"
@@ -133,8 +133,7 @@ Feature: Automatic updating of groups and groupings
| Enrolment key | Abcdef-2 |
And I press "Save changes"
And I should not see "This enrolment key is already used for another group."
- And I am on homepage
- And I follow "Course 2"
+ And I am on "Course 2" course homepage
And I navigate to "Users > Groups" in current page administration
And I press "Create group"
And I set the following fields to these values:
diff --git a/lang/en/calendar.php b/lang/en/calendar.php
index a24c0f32cb6c3..d36accc45ea48 100644
--- a/lang/en/calendar.php
+++ b/lang/en/calendar.php
@@ -26,6 +26,7 @@
$string['allday'] = 'All day';
$string['addevent'] = 'Add events';
$string['annually'] = 'Annually';
+$string['activityevent'] = 'Activity event';
$string['calendar'] = 'Calendar';
$string['calendarheading'] = '{$a} Calendar';
$string['calendarpreferences'] = 'Calendar preferences';
diff --git a/lang/en/completion.php b/lang/en/completion.php
index c19e306bb8bc0..41bc6c2656efc 100644
--- a/lang/en/completion.php
+++ b/lang/en/completion.php
@@ -67,7 +67,8 @@
$string['completiondisabled'] = 'Disabled, not shown in activity settings';
$string['completionenabled'] = 'Enabled, control via completion and activity settings';
$string['completionexpected'] = 'Expect completed on';
-$string['completionexpected_help'] = 'This setting specifies the date when the activity is expected to be completed. The date is not shown to students and is only displayed in the activity completion report.';
+$string['completionexpected_help'] = 'This setting specifies the date when the activity is expected to be completed.';
+$string['completionexpectedfor'] = 'Expected completion for \'{$a->modulename}\' activity \'{$a->instancename}\'';
$string['completionicons'] = 'Completion tick boxes';
$string['completionicons_help'] = 'A tick next to an activity name may be used to indicate when the activity is complete.
@@ -114,7 +115,7 @@
$string['dependenciescompleted'] = 'Completion of other courses';
$string['editcoursecompletionsettings'] = 'Edit course completion settings';
$string['enablecompletion'] = 'Enable completion tracking';
-$string['enablecompletion_help'] = 'If enabled, activity completion conditions may be set in the activity settings and/or course completion conditions may be set.';
+$string['enablecompletion_help'] = 'If enabled, activity completion conditions may be set in the activity settings and/or course completion conditions may be set. It is recommended to have this enabled in order for the course progress dashboard to display meaningful data.';
$string['enrolmentduration'] = 'Enrolment duration';
$string['enrolmentdurationlength'] = 'User must remain enrolled for';
$string['err_noactivities'] = 'Completion information is not enabled for any activity, so none can be displayed. You can enable completion information by editing the settings for an activity.';
diff --git a/lib/amd/build/templates.min.js b/lib/amd/build/templates.min.js
index 87d6ada670121..c465c9abf725a 100644
--- a/lib/amd/build/templates.min.js
+++ b/lib/amd/build/templates.min.js
@@ -1 +1 @@
-define(["core/mustache","jquery","core/ajax","core/str","core/notification","core/url","core/config","core/localstorage","core/icon_system","core/event","core/yui","core/log","core/truncate","core/user_date"],function(a,b,c,d,e,f,g,h,i,j,k,l,m,n){var o=0,p={},q={},r={},s=function(){this.requiredStrings=[],this.requiredJS=[],this.requiredDates=[],this.currentThemeName=""};s.prototype.requiredStrings=null,s.prototype.requiredDates=[],s.prototype.requiredJS=null,s.prototype.currentThemeName="",s.prototype.getTemplate=function(a){var d=a.split("/"),e=d.shift(),f=d.shift(),g=this.currentThemeName+"/"+a;if(g in q)return q[g];var i=h.get("core_template/"+g);if(i)return p[g]=i,q[g]=b.Deferred().resolve(i).promise(),q[g];var j=c.call([{methodname:"core_output_load_template",args:{component:e,template:f,themename:this.currentThemeName}}],!0,!1);return q[g]=j[0].then(function(a){return p[g]=a,h.set("core_template/"+g,a),a}),q[g]},s.prototype.partialHelper=function(a){var b=this.currentThemeName+"/"+a;return b in p||e.exception(new Error("Failed to pre-fetch the template: "+a)),p[b]},s.prototype.renderIcon=function(a,c,d){var e=g.iconsystemmodule,f=b.Deferred();return require([e],function(a){var b=new a;b instanceof i?(r=b,b.init().then(f.resolve)):f.reject("Invalid icon system specified"+g.iconsystemmodule)}),f.then(function(a){return this.getTemplate(a.getTemplateName())}.bind(this)).then(function(b){return r.renderIcon(a,c,d,b)})},s.prototype.pixHelper=function(a,b,c){var d=b.split(","),e="",f="",g="";d.length>0&&(e=c(d.shift().trim())),d.length>0&&(f=c(d.shift().trim())),d.length>0&&(g=c(d.join(",").trim()));var h=r.getTemplateName(),i=this.currentThemeName+"/"+h,j=p[i];return r.renderIcon(e,f,g,j)},s.prototype.jsHelper=function(a,b,c){return this.requiredJS.push(c(b,a)),""},s.prototype.stringHelper=function(a,b,c){var d=b.split(","),e="",f="",g="";d.length>0&&(e=d.shift().trim()),d.length>0&&(f=d.shift().trim()),d.length>0&&(g=d.join(",").trim()),""!==g&&(g=c(g,a)),0===g.indexOf("{")&&0!==g.indexOf("{{")&&(g=JSON.parse(g));var h=this.requiredStrings.length;return this.requiredStrings.push({key:e,component:f,param:g}),"[[_s"+h+"]]"},s.prototype.quoteHelper=function(a,b,c){var d=c(b.trim(),a);return d=d.replace('"','\\"').replace(/([\{\}]{2,3})/g,"{{=<% %>=}}$1<%={{ }}=%>"),'"'+d+'"'},s.prototype.shortenTextHelper=function(a,b,c){var d=/(.*?),(.*)/,e=b.match(d),f=e[1].trim(),g=e[2].trim(),h=c(g,a);return m.truncate(h,{length:f,words:!0,ellipsis:"..."})},s.prototype.userDateHelper=function(a,b,c){var d=/(.*?),(.*)/,e=b.match(d),f=c(e[1].trim(),a),g=c(e[2].trim(),a),h=this.requiredDates.length;return this.requiredDates.push({timestamp:f,format:g}),"[[_t_"+h+"]]"},s.prototype.addHelpers=function(a,b){this.currentThemeName=b,this.requiredStrings=[],this.requiredJS=[],a.uniqid=o++,a.str=function(){return this.stringHelper.bind(this,a)}.bind(this),a.pix=function(){return this.pixHelper.bind(this,a)}.bind(this),a.js=function(){return this.jsHelper.bind(this,a)}.bind(this),a.quote=function(){return this.quoteHelper.bind(this,a)}.bind(this),a.shortentext=function(){return this.shortenTextHelper.bind(this,a)}.bind(this),a.userdate=function(){return this.userDateHelper.bind(this,a)}.bind(this),a.globals={config:g},a.currentTheme=b},s.prototype.getJS=function(){var a="";return this.requiredJS.length>0&&(a=this.requiredJS.join(";\n")),a},s.prototype.treatStringsInContent=function(a,b){var c,d,e,f,g,h,i=/\[\[_s\d+\]\]/;do{for(c="",d=a.search(i);d>-1;){c+=a.substring(0,d),a=a.substr(d),e="",f=4,g=a.substr(f,1);do e+=g,f++,g=a.substr(f,1);while("]"!=g);h=b[parseInt(e,10)],"undefined"==typeof h&&(l.debug("Could not find string for pattern [[_s"+e+"]]."),h=""),c+=h,a=a.substr(6+e.length),d=a.search(i)}a=c+a,d=a.search(i)}while(d>-1);return a},s.prototype.treatDatesInContent=function(a,b){return b.forEach(function(b,c){var d="\\[\\[_t_"+c+"\\]\\]",e=new RegExp(d,"g");a=a.replace(e,b)}),a},s.prototype.doRender=function(c,e,f){this.currentThemeName=f;var g=r.getTemplateName();return this.getTemplate(g).then(function(){this.addHelpers(e,f);var d=a.render(c,e,this.partialHelper.bind(this));return b.Deferred().resolve(d.trim(),this.getJS()).promise()}.bind(this)).then(function(a,c){return this.requiredStrings.length>0?d.get_strings(this.requiredStrings).then(function(d){return this.requiredDates=this.requiredDates.map(function(a){return{timestamp:this.treatStringsInContent(a.timestamp,d),format:this.treatStringsInContent(a.format,d)}}.bind(this)),a=this.treatStringsInContent(a,d),c=this.treatStringsInContent(c,d),b.Deferred().resolve(a,c).promise()}.bind(this)):b.Deferred().resolve(a,c).promise()}.bind(this)).then(function(a,c){return this.requiredDates.length>0?n.get(this.requiredDates).then(function(d){return a=this.treatDatesInContent(a,d),c=this.treatDatesInContent(c,d),b.Deferred().resolve(a,c).promise()}.bind(this)):b.Deferred().resolve(a,c).promise()}.bind(this))};var t=function(a){if(""!==a.trim()){var c=b("
+ 
+