?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Merge branch 'MDL-28329' of git://github.com/timhunt/moodle
[moodle.git] / calendar / lib.php
blob95f3e9a01fffb38597771a8d32c6b0f37b3d3533
1 <?php
2
3 /////////////////////////////////////////////////////////////////////////////
4 // //
5 // NOTICE OF COPYRIGHT //
6 // //
7 // Moodle - Calendar extension //
8 // //
9 // Copyright (C) 2003-2004 Greek School Network www.sch.gr //
10 // //
11 // Designed by: //
12 // Avgoustos Tsinakos (tsinakos@teikav.edu.gr) //
13 // Jon Papaioannou (pj@moodle.org) //
14 // //
15 // Programming and development: //
16 // Jon Papaioannou (pj@moodle.org) //
17 // //
18 // For bugs, suggestions, etc contact: //
19 // Jon Papaioannou (pj@moodle.org) //
20 // //
21 // The current module was developed at the University of Macedonia //
22 // (www.uom.gr) under the funding of the Greek School Network (www.sch.gr) //
23 // The aim of this project is to provide additional and improved //
24 // functionality to the Asynchronous Distance Education service that the //
25 // Greek School Network deploys. //
26 // //
27 // This program is free software; you can redistribute it and/or modify //
28 // it under the terms of the GNU General Public License as published by //
29 // the Free Software Foundation; either version 2 of the License, or //
30 // (at your option) any later version. //
31 // //
32 // This program is distributed in the hope that it will be useful, //
33 // but WITHOUT ANY WARRANTY; without even the implied warranty of //
34 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
35 // GNU General Public License for more details: //
36 // //
37 // http://www.gnu.org/copyleft/gpl.html //
38 // //
39 /////////////////////////////////////////////////////////////////////////////
40
41 // These are read by the administration component to provide default values
42 define('CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD', 21);
43 define('CALENDAR_DEFAULT_UPCOMING_MAXEVENTS', 10);
44 define('CALENDAR_DEFAULT_STARTING_WEEKDAY', 1);
45 // This is a packed bitfield: day X is "weekend" if $field & (1 << X) is true
46 // Default value = 65 = 64 + 1 = 2^6 + 2^0 = Saturday & Sunday
47 define('CALENDAR_DEFAULT_WEEKEND', 65);
48 define('CALENDAR_URL', $CFG->wwwroot.'/calendar/');
49 define('CALENDAR_TF_24', '%H:%M');
50 define('CALENDAR_TF_12', '%I:%M %p');
51
52 define('CALENDAR_EVENT_GLOBAL', 1);
53 define('CALENDAR_EVENT_COURSE', 2);
54 define('CALENDAR_EVENT_GROUP', 4);
55 define('CALENDAR_EVENT_USER', 8);
56
57 /**
58 * CALENDAR_STARTING_WEEKDAY has since been deprecated please call calendar_get_starting_weekday() instead
59 * @deprecated
60 */
61 define('CALENDAR_STARTING_WEEKDAY', CALENDAR_DEFAULT_STARTING_WEEKDAY);
62
63 /**
64 * Return the days of the week
65 *
66 * @return array
67 */
68 function calendar_get_days() {
69 return array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday');
70 }
71
72 /**
73 * Gets the first day of the week
74 *
75 * Used to be define('CALENDAR_STARTING_WEEKDAY', blah);
76 *
77 * @return int
78 */
79 function calendar_get_starting_weekday() {
80 global $CFG;
81
82 if (isset($CFG->calendar_startwday)) {
83 $firstday = $CFG->calendar_startwday;
84 } else {
85 $firstday = get_string('firstdayofweek', 'langconfig');
86 }
87
88 if(!is_numeric($firstday)) {
89 return CALENDAR_DEFAULT_STARTING_WEEKDAY;
90 } else {
91 return intval($firstday) % 7;
92 }
93 }
94
95 /**
96 * Generates the HTML for a miniature calendar
97 *
98 * @global core_renderer $OUTPUT
99 * @param array $courses
100 * @param array $groups
101 * @param array $users
102 * @param int $cal_month
103 * @param int $cal_year
104 * @return string
105 */
106 function calendar_get_mini($courses, $groups, $users, $cal_month = false, $cal_year = false) {
107 global $CFG, $USER, $OUTPUT;
108
109 $display = new stdClass;
110 $display->minwday = get_user_preferences('calendar_startwday', calendar_get_starting_weekday());
111 $display->maxwday = $display->minwday + 6;
112
113 $content = '';
114
115 if(!empty($cal_month) && !empty($cal_year)) {
116 $thisdate = usergetdate(time()); // Date and time the user sees at his location
117 if($cal_month == $thisdate['mon'] && $cal_year == $thisdate['year']) {
118 // Navigated to this month
119 $date = $thisdate;
120 $display->thismonth = true;
121 } else {
122 // Navigated to other month, let's do a nice trick and save us a lot of work...
123 if(!checkdate($cal_month, 1, $cal_year)) {
124 $date = array('mday' => 1, 'mon' => $thisdate['mon'], 'year' => $thisdate['year']);
125 $display->thismonth = true;
126 } else {
127 $date = array('mday' => 1, 'mon' => $cal_month, 'year' => $cal_year);
128 $display->thismonth = false;
129 }
130 }
131 } else {
132 $date = usergetdate(time()); // Date and time the user sees at his location
133 $display->thismonth = true;
134 }
135
136 // Fill in the variables we 're going to use, nice and tidy
137 list($d, $m, $y) = array($date['mday'], $date['mon'], $date['year']); // This is what we want to display
138 $display->maxdays = calendar_days_in_month($m, $y);
139
140 if (get_user_timezone_offset() < 99) {
141 // We 'll keep these values as GMT here, and offset them when the time comes to query the db
142 $display->tstart = gmmktime(0, 0, 0, $m, 1, $y); // This is GMT
143 $display->tend = gmmktime(23, 59, 59, $m, $display->maxdays, $y); // GMT
144 } else {
145 // no timezone info specified
146 $display->tstart = mktime(0, 0, 0, $m, 1, $y);
147 $display->tend = mktime(23, 59, 59, $m, $display->maxdays, $y);
148 }
149
150 $startwday = dayofweek(1, $m, $y);
151
152 // Align the starting weekday to fall in our display range
153 // This is simple, not foolproof.
154 if($startwday < $display->minwday) {
155 $startwday += 7;
156 }
157
158 // TODO: THIS IS TEMPORARY CODE!
159 // [pj] I was just reading through this and realized that I when writing this code I was probably
160 // asking for trouble, as all these time manipulations seem to be unnecessary and a simple
161 // make_timestamp would accomplish the same thing. So here goes a test:
162 //$test_start = make_timestamp($y, $m, 1);
163 //$test_end = make_timestamp($y, $m, $display->maxdays, 23, 59, 59);
164 //if($test_start != usertime($display->tstart) - dst_offset_on($display->tstart)) {
165 //notify('Failed assertion in calendar/lib.php line 126; display->tstart = '.$display->tstart.', dst_offset = '.dst_offset_on($display->tstart).', usertime = '.usertime($display->tstart).', make_t = '.$test_start);
166 //}
167 //if($test_end != usertime($display->tend) - dst_offset_on($display->tend)) {
168 //notify('Failed assertion in calendar/lib.php line 130; display->tend = '.$display->tend.', dst_offset = '.dst_offset_on($display->tend).', usertime = '.usertime($display->tend).', make_t = '.$test_end);
169 //}
170
171
172 // Get the events matching our criteria. Don't forget to offset the timestamps for the user's TZ!
173 $events = calendar_get_events(
174 usertime($display->tstart) - dst_offset_on($display->tstart),
175 usertime($display->tend) - dst_offset_on($display->tend),
176 $users, $groups, $courses);
177
178 // Set event course class for course events
179 if (!empty($events)) {
180 foreach ($events as $eventid => $event) {
181 if (!empty($event->modulename)) {
182 $cm = get_coursemodule_from_instance($event->modulename, $event->instance);
183 if (!groups_course_module_visible($cm)) {
184 unset($events[$eventid]);
185 }
186 }
187 }
188 }
189
190 // This is either a genius idea or an idiot idea: in order to not complicate things, we use this rule: if, after
191 // possibly removing SITEID from $courses, there is only one course left, then clicking on a day in the month
192 // will also set the $SESSION->cal_courses_shown variable to that one course. Otherwise, we 'd need to add extra
193 // arguments to this function.
194
195 $hrefparams = array();
196 if(!empty($courses)) {
197 $courses = array_diff($courses, array(SITEID));
198 if(count($courses) == 1) {
199 $hrefparams['course'] = reset($courses);
200 }
201 }
202
203 // We want to have easy access by day, since the display is on a per-day basis.
204 // Arguments passed by reference.
205 //calendar_events_by_day($events, $display->tstart, $eventsbyday, $durationbyday, $typesbyday);
206 calendar_events_by_day($events, $m, $y, $eventsbyday, $durationbyday, $typesbyday, $courses);
207
208 //Accessibility: added summary and <abbr> elements.
209 $days_title = calendar_get_days();
210
211 $summary = get_string('calendarheading', 'calendar', userdate(make_timestamp($y, $m), get_string('strftimemonthyear')));
212 $summary = get_string('tabledata', 'access', $summary);
213 $content .= '<table class="minicalendar calendartable" summary="'.$summary.'">'; // Begin table
214 $content .= '<tr class="weekdays">'; // Header row: day names
215
216 // Print out the names of the weekdays
217 $days = array('sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat');
218 for($i = $display->minwday; $i <= $display->maxwday; ++$i) {
219 // This uses the % operator to get the correct weekday no matter what shift we have
220 // applied to the $display->minwday : $display->maxwday range from the default 0 : 6
221 $content .= '<th scope="col"><abbr title="'. get_string($days_title[$i % 7], 'calendar') .'">'.
222 get_string($days[$i % 7], 'calendar') ."</abbr></th>\n";
223 }
224
225 $content .= '</tr><tr>'; // End of day names; prepare for day numbers
226
227 // For the table display. $week is the row; $dayweek is the column.
228 $dayweek = $startwday;
229
230 // Paddding (the first week may have blank days in the beginning)
231 for($i = $display->minwday; $i < $startwday; ++$i) {
232 $content .= '<td class="dayblank">&nbsp;</td>'."\n";
233 }
234
235 $weekend = CALENDAR_DEFAULT_WEEKEND;
236 if (isset($CFG->calendar_weekend)) {
237 $weekend = intval($CFG->calendar_weekend);
238 }
239
240 // Now display all the calendar
241 for($day = 1; $day <= $display->maxdays; ++$day, ++$dayweek) {
242 if($dayweek > $display->maxwday) {
243 // We need to change week (table row)
244 $content .= '</tr><tr>';
245 $dayweek = $display->minwday;
246 }
247
248 // Reset vars
249 $cell = '';
250 if ($weekend & (1 << ($dayweek % 7))) {
251 // Weekend. This is true no matter what the exact range is.
252 $class = 'weekend day';
253 } else {
254 // Normal working day.
255 $class = 'day';
256 }
257
258 // Special visual fx if an event is defined
259 if(isset($eventsbyday[$day])) {
260 $class .= ' hasevent';
261 $hrefparams['view'] = 'day';
262 $dayhref = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $hrefparams), $day, $m, $y);
263
264 $popupcontent = '';
265 foreach($eventsbyday[$day] as $eventid) {
266 if (!isset($events[$eventid])) {
267 continue;
268 }
269 $event = $events[$eventid];
270 $popupalt = '';
271 $component = 'moodle';
272 if(!empty($event->modulename)) {
273 $popupicon = 'icon';
274 $popupalt = $event->modulename;
275 $component = $event->modulename;
276 } else if ($event->courseid == SITEID) { // Site event
277 $popupicon = 'c/site';
278 } else if ($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) { // Course event
279 $popupicon = 'c/course';
280 } else if ($event->groupid) { // Group event
281 $popupicon = 'c/group';
282 } else if ($event->userid) { // User event
283 $popupicon = 'c/user';
284 }
285
286 $dayhref->set_anchor('event_'.$event->id);
287
288 $popupcontent .= html_writer::start_tag('div');
289 $popupcontent .= $OUTPUT->pix_icon($popupicon, $popupalt, $component);
290 $popupcontent .= html_writer::link($dayhref, format_string($event->name, true));
291 $popupcontent .= html_writer::end_tag('div');
292 }
293
294 //Accessibility: functionality moved to calendar_get_popup.
295 if($display->thismonth && $day == $d) {
296 $popup = calendar_get_popup(true, $events[$eventid]->timestart, $popupcontent);
297 } else {
298 $popup = calendar_get_popup(false, $events[$eventid]->timestart, $popupcontent);
299 }
300
301 // Class and cell content
302 if(isset($typesbyday[$day]['startglobal'])) {
303 $class .= ' calendar_event_global';
304 } else if(isset($typesbyday[$day]['startcourse'])) {
305 $class .= ' calendar_event_course';
306 } else if(isset($typesbyday[$day]['startgroup'])) {
307 $class .= ' calendar_event_group';
308 } else if(isset($typesbyday[$day]['startuser'])) {
309 $class .= ' calendar_event_user';
310 }
311 $cell = '<a href="'.(string)$dayhref.'" '.$popup.'>'.$day.'</a>';
312 } else {
313 $cell = $day;
314 }
315
316 $durationclass = false;
317 if (isset($typesbyday[$day]['durationglobal'])) {
318 $durationclass = ' duration_global';
319 } else if(isset($typesbyday[$day]['durationcourse'])) {
320 $durationclass = ' duration_course';
321 } else if(isset($typesbyday[$day]['durationgroup'])) {
322 $durationclass = ' duration_group';
323 } else if(isset($typesbyday[$day]['durationuser'])) {
324 $durationclass = ' duration_user';
325 }
326 if ($durationclass) {
327 $class .= ' duration '.$durationclass;
328 }
329
330 // If event has a class set then add it to the table day <td> tag
331 // Note: only one colour for minicalendar
332 if(isset($eventsbyday[$day])) {
333 foreach($eventsbyday[$day] as $eventid) {
334 if (!isset($events[$eventid])) {
335 continue;
336 }
337 $event = $events[$eventid];
338 if (!empty($event->class)) {
339 $class .= ' '.$event->class;
340 }
341 break;
342 }
343 }
344
345 // Special visual fx for today
346 //Accessibility: hidden text for today, and popup.
347 if($display->thismonth && $day == $d) {
348 $class .= ' today';
349 $today = get_string('today', 'calendar').' '.userdate(time(), get_string('strftimedayshort'));
350
351 if(! isset($eventsbyday[$day])) {
352 $class .= ' eventnone';
353 $popup = calendar_get_popup(true, false);
354 $cell = '<a href="#" '.$popup.'>'.$day.'</a>';
355 }
356 $cell = get_accesshide($today.' ').$cell;
357 }
358
359 // Just display it
360 if(!empty($class)) {
361 $class = ' class="'.$class.'"';
362 }
363 $content .= '<td'.$class.'>'.$cell."</td>\n";
364 }
365
366 // Paddding (the last week may have blank days at the end)
367 for($i = $dayweek; $i <= $display->maxwday; ++$i) {
368 $content .= '<td class="dayblank">&nbsp;</td>';
369 }
370 $content .= '</tr>'; // Last row ends
371
372 $content .= '</table>'; // Tabular display of days ends
373
374 return $content;
375 }
376
377 /**
378 * calendar_get_popup, called at multiple points in from calendar_get_mini.
379 * Copied and modified from calendar_get_mini.
380 * @global moodle_page $PAGE
381 * @param $is_today bool, false except when called on the current day.
382 * @param $event_timestart mixed, $events[$eventid]->timestart, OR false if there are no events.
383 * @param $popupcontent string.
384 * @return $popup string, contains onmousover and onmouseout events.
385 */
386 function calendar_get_popup($is_today, $event_timestart, $popupcontent='') {
387 global $PAGE;
388 static $popupcount;
389 if ($popupcount === null) {
390 $popupcount = 1;
391 }
392 $popupcaption = '';
393 if($is_today) {
394 $popupcaption = get_string('today', 'calendar').' ';
395 }
396 if (false === $event_timestart) {
397 $popupcaption .= userdate(time(), get_string('strftimedayshort'));
398 $popupcontent = get_string('eventnone', 'calendar');
399
400 } else {
401 $popupcaption .= get_string('eventsfor', 'calendar', userdate($event_timestart, get_string('strftimedayshort')));
402 }
403 $id = 'calendar_tooltip_'.$popupcount;
404 $PAGE->requires->yui_module('moodle-calendar-eventmanager', 'M.core_calendar.add_event', array(array('eventId'=>$id,'title'=>$popupcaption, 'content'=>$popupcontent)));
405
406 $popupcount++;
407 return 'id="'.$id.'"';
408 }
409
410 function calendar_get_upcoming($courses, $groups, $users, $daysinfuture, $maxevents, $fromtime=0) {
411 global $CFG, $COURSE, $DB;
412
413 $display = new stdClass;
414 $display->range = $daysinfuture; // How many days in the future we 'll look
415 $display->maxevents = $maxevents;
416
417 $output = array();
418
419 // Prepare "course caching", since it may save us a lot of queries
420 $coursecache = array();
421
422 $processed = 0;
423 $now = time(); // We 'll need this later
424 $usermidnighttoday = usergetmidnight($now);
425
426 if ($fromtime) {
427 $display->tstart = $fromtime;
428 } else {
429 $display->tstart = $usermidnighttoday;
430 }
431
432 // This works correctly with respect to the user's DST, but it is accurate
433 // only because $fromtime is always the exact midnight of some day!
434 $display->tend = usergetmidnight($display->tstart + DAYSECS * $display->range + 3 * HOURSECS) - 1;
435
436 // Get the events matching our criteria
437 $events = calendar_get_events($display->tstart, $display->tend, $users, $groups, $courses);
438
439 // This is either a genius idea or an idiot idea: in order to not complicate things, we use this rule: if, after
440 // possibly removing SITEID from $courses, there is only one course left, then clicking on a day in the month
441 // will also set the $SESSION->cal_courses_shown variable to that one course. Otherwise, we 'd need to add extra
442 // arguments to this function.
443
444 $hrefparams = array();
445 if(!empty($courses)) {
446 $courses = array_diff($courses, array(SITEID));
447 if(count($courses) == 1) {
448 $hrefparams['course'] = reset($courses);
449 }
450 }
451
452 if ($events !== false) {
453
454 $modinfo =& get_fast_modinfo($COURSE);
455
456 foreach($events as $event) {
457
458
459 if (!empty($event->modulename)) {
460 if ($event->courseid == $COURSE->id) {
461 if (isset($modinfo->instances[$event->modulename][$event->instance])) {
462 $cm = $modinfo->instances[$event->modulename][$event->instance];
463 if (!$cm->uservisible) {
464 continue;
465 }
466 }
467 } else {
468 if (!$cm = get_coursemodule_from_instance($event->modulename, $event->instance)) {
469 continue;
470 }
471 if (!coursemodule_visible_for_user($cm)) {
472 continue;
473 }
474 }
475 if ($event->modulename == 'assignment'){
476 // create calendar_event to test edit_event capability
477 // this new event will also prevent double creation of calendar_event object
478 $checkevent = new calendar_event($event);
479 // TODO: rewrite this hack somehow
480 if (!calendar_edit_event_allowed($checkevent)){ // cannot manage entries, eg. student
481 if (!$assignment = $DB->get_record('assignment', array('id'=>$event->instance))) {
482 // print_error("invalidid", 'assignment');
483 continue;
484 }
485 // assign assignment to assignment object to use hidden_is_hidden method
486 require_once($CFG->dirroot.'/mod/assignment/lib.php');
487
488 if (!file_exists($CFG->dirroot.'/mod/assignment/type/'.$assignment->assignmenttype.'/assignment.class.php')) {
489 continue;
490 }
491 require_once ($CFG->dirroot.'/mod/assignment/type/'.$assignment->assignmenttype.'/assignment.class.php');
492
493 $assignmentclass = 'assignment_'.$assignment->assignmenttype;
494 $assignmentinstance = new $assignmentclass($cm->id, $assignment, $cm);
495
496 if ($assignmentinstance->description_is_hidden()){//force not to show description before availability
497 $event->description = get_string('notavailableyet', 'assignment');
498 }
499 }
500 }
501 }
502
503 if ($processed >= $display->maxevents) {
504 break;
505 }
506
507 $event->time = calendar_format_event_time($event, $now, $hrefparams);
508 $output[] = $event;
509 ++$processed;
510 }
511 }
512 return $output;
513 }
514
515 function calendar_add_event_metadata($event) {
516 global $CFG, $OUTPUT;
517
518 //Support multilang in event->name
519 $event->name = format_string($event->name,true);
520
521 if(!empty($event->modulename)) { // Activity event
522 // The module name is set. I will assume that it has to be displayed, and
523 // also that it is an automatically-generated event. And of course that the
524 // fields for get_coursemodule_from_instance are set correctly.
525 $module = calendar_get_module_cached($coursecache, $event->modulename, $event->instance);
526
527 if ($module === false) {
528 return;
529 }
530
531 $modulename = get_string('modulename', $event->modulename);
532 if (get_string_manager()->string_exists($event->eventtype, $event->modulename)) {
533 // will be used as alt text if the event icon
534 $eventtype = get_string($event->eventtype, $event->modulename);
535 } else {
536 $eventtype = '';
537 }
538 $icon = $OUTPUT->pix_url('icon', $event->modulename) . '';
539
540 $context = get_context_instance(CONTEXT_COURSE, $module->course);
541 $fullname = format_string($coursecache[$module->course]->fullname, true, array('context' => $context));
542
543 $event->icon = '<img height="16" width="16" src="'.$icon.'" alt="'.$eventtype.'" title="'.$modulename.'" style="vertical-align: middle;" />';
544 $event->referer = '<a href="'.$CFG->wwwroot.'/mod/'.$event->modulename.'/view.php?id='.$module->id.'">'.$event->name.'</a>';
545 $event->courselink = '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$module->course.'">'.$fullname.'</a>';
546 $event->cmid = $module->id;
547
548
549 } else if($event->courseid == SITEID) { // Site event
550 $event->icon = '<img height="16" width="16" src="'.$OUTPUT->pix_url('c/site') . '" alt="'.get_string('globalevent', 'calendar').'" style="vertical-align: middle;" />';
551 $event->cssclass = 'calendar_event_global';
552 } else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) { // Course event
553 calendar_get_course_cached($coursecache, $event->courseid);
554
555 $context = get_context_instance(CONTEXT_COURSE, $event->courseid);
556 $fullname = format_string($coursecache[$event->courseid]->fullname, true, array('context' => $context));
557
558 $event->icon = '<img height="16" width="16" src="'.$OUTPUT->pix_url('c/course') . '" alt="'.get_string('courseevent', 'calendar').'" style="vertical-align: middle;" />';
559 $event->courselink = '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$event->courseid.'">'.$fullname.'</a>';
560 $event->cssclass = 'calendar_event_course';
561 } else if ($event->groupid) { // Group event
562 $event->icon = '<img height="16" width="16" src="'.$OUTPUT->pix_url('c/group') . '" alt="'.get_string('groupevent', 'calendar').'" style="vertical-align: middle;" />';
563 $event->cssclass = 'calendar_event_group';
564 } else if($event->userid) { // User event
565 $event->icon = '<img height="16" width="16" src="'.$OUTPUT->pix_url('c/user') . '" alt="'.get_string('userevent', 'calendar').'" style="vertical-align: middle;" />';
566 $event->cssclass = 'calendar_event_user';
567 }
568 return $event;
569 }
570
571 /**
572 * Prints a calendar event
573 *
574 * @deprecated 2.0
575 */
576 function calendar_print_event($event, $showactions=true) {
577 global $CFG, $USER, $OUTPUT, $PAGE;
578 debugging('calendar_print_event is deprecated please update your code', DEBUG_DEVELOPER);
579 $renderer = $PAGE->get_renderer('core_calendar');
580 if (!($event instanceof calendar_event)) {
581 $event = new calendar_event($event);
582 }
583 echo $renderer->event($event);
584 }
585
586 /**
587 * Get calendar events
588 * @param int $tstart Start time of time range for events
589 * @param int $tend End time of time range for events
590 * @param array/int/boolean $users array of users, user id or boolean for all/no user events
591 * @param array/int/boolean $groups array of groups, group id or boolean for all/no group events
592 * @param array/int/boolean $courses array of courses, course id or boolean for all/no course events
593 * @param boolean $withduration whether only events starting within time range selected
594 * or events in progress/already started selected as well
595 * @param boolean $ignorehidden whether to select only visible events or all events
596 * @return array of selected events or an empty array if there aren't any (or there was an error)
597 */
598 function calendar_get_events($tstart, $tend, $users, $groups, $courses, $withduration=true, $ignorehidden=true) {
599 global $DB;
600
601 $whereclause = '';
602 // Quick test
603 if(is_bool($users) && is_bool($groups) && is_bool($courses)) {
604 return array();
605 }
606
607 if(is_array($users) && !empty($users)) {
608 // Events from a number of users
609 if(!empty($whereclause)) $whereclause .= ' OR';
610 $whereclause .= ' (userid IN ('.implode(',', $users).') AND courseid = 0 AND groupid = 0)';
611 } else if(is_numeric($users)) {
612 // Events from one user
613 if(!empty($whereclause)) $whereclause .= ' OR';
614 $whereclause .= ' (userid = '.$users.' AND courseid = 0 AND groupid = 0)';
615 } else if($users === true) {
616 // Events from ALL users
617 if(!empty($whereclause)) $whereclause .= ' OR';
618 $whereclause .= ' (userid != 0 AND courseid = 0 AND groupid = 0)';
619 } else if($users === false) {
620 // No user at all, do nothing
621 }
622
623 if(is_array($groups) && !empty($groups)) {
624 // Events from a number of groups
625 if(!empty($whereclause)) $whereclause .= ' OR';
626 $whereclause .= ' groupid IN ('.implode(',', $groups).')';
627 } else if(is_numeric($groups)) {
628 // Events from one group
629 if(!empty($whereclause)) $whereclause .= ' OR ';
630 $whereclause .= ' groupid = '.$groups;
631 } else if($groups === true) {
632 // Events from ALL groups
633 if(!empty($whereclause)) $whereclause .= ' OR ';
634 $whereclause .= ' groupid != 0';
635 }
636 // boolean false (no groups at all): we don't need to do anything
637
638 if(is_array($courses) && !empty($courses)) {
639 if(!empty($whereclause)) {
640 $whereclause .= ' OR';
641 }
642 $whereclause .= ' (groupid = 0 AND courseid IN ('.implode(',', $courses).'))';
643 } else if(is_numeric($courses)) {
644 // One course
645 if(!empty($whereclause)) $whereclause .= ' OR';
646 $whereclause .= ' (groupid = 0 AND courseid = '.$courses.')';
647 } else if ($courses === true) {
648 // Events from ALL courses
649 if(!empty($whereclause)) $whereclause .= ' OR';
650 $whereclause .= ' (groupid = 0 AND courseid != 0)';
651 }
652
653 // Security check: if, by now, we have NOTHING in $whereclause, then it means
654 // that NO event-selecting clauses were defined. Thus, we won't be returning ANY
655 // events no matter what. Allowing the code to proceed might return a completely
656 // valid query with only time constraints, thus selecting ALL events in that time frame!
657 if(empty($whereclause)) {
658 return array();
659 }
660
661 if($withduration) {
662 $timeclause = '(timestart >= '.$tstart.' OR timestart + timeduration > '.$tstart.') AND timestart <= '.$tend;
663 }
664 else {
665 $timeclause = 'timestart >= '.$tstart.' AND timestart <= '.$tend;
666 }
667 if(!empty($whereclause)) {
668 // We have additional constraints
669 $whereclause = $timeclause.' AND ('.$whereclause.')';
670 }
671 else {
672 // Just basic time filtering
673 $whereclause = $timeclause;
674 }
675
676 if ($ignorehidden) {
677 $whereclause .= ' AND visible = 1';
678 }
679
680 $events = $DB->get_records_select('event', $whereclause, null, 'timestart');
681 if ($events === false) {
682 $events = array();
683 }
684 return $events;
685 }
686
687 function calendar_top_controls($type, $data) {
688 global $CFG;
689 $content = '';
690 if(!isset($data['d'])) {
691 $data['d'] = 1;
692 }
693
694 // Ensure course id passed if relevant
695 // Required due to changes in view/lib.php mainly (calendar_session_vars())
696 $courseid = '';
697 if (!empty($data['id'])) {
698 $courseid = '&amp;course='.$data['id'];
699 }
700
701 if(!checkdate($data['m'], $data['d'], $data['y'])) {
702 $time = time();
703 }
704 else {
705 $time = make_timestamp($data['y'], $data['m'], $data['d']);
706 }
707 $date = usergetdate($time);
708
709 $data['m'] = $date['mon'];
710 $data['y'] = $date['year'];
711
712 //Accessibility: calendar block controls, replaced <table> with <div>.
713 //$nexttext = link_arrow_right(get_string('monthnext', 'access'), $url='', $accesshide=true);
714 //$prevtext = link_arrow_left(get_string('monthprev', 'access'), $url='', $accesshide=true);
715
716 switch($type) {
717 case 'frontpage':
718 list($prevmonth, $prevyear) = calendar_sub_month($data['m'], $data['y']);
719 list($nextmonth, $nextyear) = calendar_add_month($data['m'], $data['y']);
720 $nextlink = calendar_get_link_next(get_string('monthnext', 'access'), 'index.php?', 0, $nextmonth, $nextyear, $accesshide=true);
721 $prevlink = calendar_get_link_previous(get_string('monthprev', 'access'), 'index.php?', 0, $prevmonth, $prevyear, true);
722
723 $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view'=>'month')), 1, $data['m'], $data['y']);
724 if (!empty($data['id'])) {
725 $calendarlink->param('course', $data['id']);
726 }
727
728 if (right_to_left()) {
729 $left = $nextlink;
730 $right = $prevlink;
731 } else {
732 $left = $prevlink;
733 $right = $nextlink;
734 }
735
736 $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
737 $content .= $left.'<span class="hide"> | </span>';
738 $content .= html_writer::tag('span', html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')), array('title'=>get_string('monththis','calendar'))), array('class'=>'current'));
739 $content .= '<span class="hide"> | </span>'. $right;
740 $content .= "<span class=\"clearer\"><!-- --></span>\n";
741 $content .= html_writer::end_tag('div');
742
743 break;
744 case 'course':
745 list($prevmonth, $prevyear) = calendar_sub_month($data['m'], $data['y']);
746 list($nextmonth, $nextyear) = calendar_add_month($data['m'], $data['y']);
747 $nextlink = calendar_get_link_next(get_string('monthnext', 'access'), 'view.php?id='.$data['id'].'&amp;', 0, $nextmonth, $nextyear, $accesshide=true);
748 $prevlink = calendar_get_link_previous(get_string('monthprev', 'access'), 'view.php?id='.$data['id'].'&amp;', 0, $prevmonth, $prevyear, true);
749
750 $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view'=>'month')), 1, $data['m'], $data['y']);
751 if (!empty($data['id'])) {
752 $calendarlink->param('course', $data['id']);
753 }
754
755 if (right_to_left()) {
756 $left = $nextlink;
757 $right = $prevlink;
758 } else {
759 $left = $prevlink;
760 $right = $nextlink;
761 }
762
763 $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
764 $content .= $left.'<span class="hide"> | </span>';
765 $content .= html_writer::tag('span', html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')), array('title'=>get_string('monththis','calendar'))), array('class'=>'current'));
766 $content .= '<span class="hide"> | </span>'. $right;
767 $content .= "<span class=\"clearer\"><!-- --></span>";
768 $content .= html_writer::end_tag('div');
769 break;
770 case 'upcoming':
771 $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view'=>'upcoming')), 1, $data['m'], $data['y']);
772 if (!empty($data['id'])) {
773 $calendarlink->param('course', $data['id']);
774 }
775 $calendarlink = html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')));
776 $content .= html_writer::tag('div', $calendarlink, array('class'=>'centered'));
777 break;
778 case 'display':
779 $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view'=>'month')), 1, $data['m'], $data['y']);
780 if (!empty($data['id'])) {
781 $calendarlink->param('course', $data['id']);
782 }
783 $calendarlink = html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')));
784 $content .= html_writer::tag('h3', $calendarlink);
785 break;
786 case 'month':
787 list($prevmonth, $prevyear) = calendar_sub_month($data['m'], $data['y']);
788 list($nextmonth, $nextyear) = calendar_add_month($data['m'], $data['y']);
789 $prevdate = make_timestamp($prevyear, $prevmonth, 1);
790 $nextdate = make_timestamp($nextyear, $nextmonth, 1);
791 $prevlink = calendar_get_link_previous(userdate($prevdate, get_string('strftimemonthyear')), 'view.php?view=month'.$courseid.'&amp;', 1, $prevmonth, $prevyear);
792 $nextlink = calendar_get_link_next(userdate($nextdate, get_string('strftimemonthyear')), 'view.php?view=month'.$courseid.'&amp;', 1, $nextmonth, $nextyear);
793
794 if (right_to_left()) {
795 $left = $nextlink;
796 $right = $prevlink;
797 } else {
798 $left = $prevlink;
799 $right = $nextlink;
800 }
801
802 $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
803 $content .= $left . '<span class="hide"> | </span><h1 class="current">'.userdate($time, get_string('strftimemonthyear'))."</h1>";
804 $content .= '<span class="hide"> | </span>' . $right;
805 $content .= '<span class="clearer"><!-- --></span>';
806 $content .= html_writer::end_tag('div')."\n";
807 break;
808 case 'day':
809 $days = calendar_get_days();
810 $data['d'] = $date['mday']; // Just for convenience
811 $prevdate = usergetdate(make_timestamp($data['y'], $data['m'], $data['d'] - 1));
812 $nextdate = usergetdate(make_timestamp($data['y'], $data['m'], $data['d'] + 1));
813 $prevname = calendar_wday_name($days[$prevdate['wday']]);
814 $nextname = calendar_wday_name($days[$nextdate['wday']]);
815 $prevlink = calendar_get_link_previous($prevname, 'view.php?view=day'.$courseid.'&amp;', $prevdate['mday'], $prevdate['mon'], $prevdate['year']);
816 $nextlink = calendar_get_link_next($nextname, 'view.php?view=day'.$courseid.'&amp;', $nextdate['mday'], $nextdate['mon'], $nextdate['year']);
817
818 if (right_to_left()) {
819 $left = $nextlink;
820 $right = $prevlink;
821 } else {
822 $left = $prevlink;
823 $right = $nextlink;
824 }
825
826 $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
827 $content .= $left;
828 $content .= '<span class="hide"> | </span><span class="current">'.userdate($time, get_string('strftimedaydate')).'</span>';
829 $content .= '<span class="hide"> | </span>'. $right;
830 $content .= "<span class=\"clearer\"><!-- --></span>";
831 $content .= html_writer::end_tag('div')."\n";
832
833 break;
834 }
835 return $content;
836 }
837
838 function calendar_filter_controls(moodle_url $returnurl) {
839 global $CFG, $USER, $OUTPUT;
840
841 $groupevents = true;
842
843 $id = optional_param( 'id',0,PARAM_INT );
844
845 $seturl = new moodle_url('/calendar/set.php', array('return' => $returnurl));
846
847 $content = '<table>';
848 $content .= '<tr>';
849
850 $seturl->param('var', 'showglobal');
851 if (calendar_show_event_type(CALENDAR_EVENT_GLOBAL)) {
852 $content .= '<td class="eventskey calendar_event_global" style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/hide') . '" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_hideglobal', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
853 $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_hideglobal', 'calendar').'">'.get_string('global', 'calendar').'</a></td>'."\n";
854 } else {
855 $content .= '<td style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/show') . '" class="iconsmall" alt="'.get_string('show').'" title="'.get_string('tt_showglobal', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
856 $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_showglobal', 'calendar').'">'.get_string('global', 'calendar').'</a></td>'."\n";
857 }
858
859 $seturl->param('var', 'showcourses');
860 if (calendar_show_event_type(CALENDAR_EVENT_COURSE)) {
861 $content .= '<td class="eventskey calendar_event_course" style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/hide') . '" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_hidecourse', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
862 $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_hidecourse', 'calendar').'">'.get_string('course', 'calendar').'</a></td>'."\n";
863 } else {
864 $content .= '<td style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/show') . '" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_showcourse', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
865 $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_showcourse', 'calendar').'">'.get_string('course', 'calendar').'</a></td>'."\n";
866 }
867
868 if (isloggedin() && !isguestuser()) {
869 $content .= "</tr>\n<tr>";
870
871 if ($groupevents) {
872 // This course MIGHT have group events defined, so show the filter
873 $seturl->param('var', 'showgroups');
874 if (calendar_show_event_type(CALENDAR_EVENT_GROUP)) {
875 $content .= '<td class="eventskey calendar_event_group" style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/hide') . '" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_hidegroups', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
876 $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_hidegroups', 'calendar').'">'.get_string('group', 'calendar').'</a></td>'."\n";
877 } else {
878 $content .= '<td style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/show') . '" class="iconsmall" alt="'.get_string('show').'" title="'.get_string('tt_showgroups', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
879 $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_showgroups', 'calendar').'">'.get_string('group', 'calendar').'</a></td>'."\n";
880 }
881 } else {
882 // This course CANNOT have group events, so lose the filter
883 $content .= '<td style="width: 11px;"></td><td>&nbsp;</td>'."\n";
884 }
885
886 $seturl->param('var', 'showuser');
887 if (calendar_show_event_type(CALENDAR_EVENT_USER)) {
888 $content .= '<td class="eventskey calendar_event_user" style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/hide') . '" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_hideuser', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
889 $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_hideuser', 'calendar').'">'.get_string('user', 'calendar').'</a></td>'."\n";
890 } else {
891 $content .= '<td style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/show') . '" class="iconsmall" alt="'.get_string('show').'" title="'.get_string('tt_showuser', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
892 $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_showuser', 'calendar').'">'.get_string('user', 'calendar').'</a></td>'."\n";
893 }
894 }
895 $content .= "</tr>\n</table>\n";
896
897 return $content;
898 }
899
900 function calendar_day_representation($tstamp, $now = false, $usecommonwords = true) {
901
902 static $shortformat;
903 if(empty($shortformat)) {
904 $shortformat = get_string('strftimedayshort');
905 }
906
907 if($now === false) {
908 $now = time();
909 }
910
911 // To have it in one place, if a change is needed
912 $formal = userdate($tstamp, $shortformat);
913
914 $datestamp = usergetdate($tstamp);
915 $datenow = usergetdate($now);
916
917 if($usecommonwords == false) {
918 // We don't want words, just a date
919 return $formal;
920 }
921 else if($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday']) {
922 // Today
923 return get_string('today', 'calendar');
924 }
925 else if(
926 ($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] - 1 ) ||
927 ($datestamp['year'] == $datenow['year'] - 1 && $datestamp['mday'] == 31 && $datestamp['mon'] == 12 && $datenow['yday'] == 1)
928 ) {
929 // Yesterday
930 return get_string('yesterday', 'calendar');
931 }
932 else if(
933 ($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] + 1 ) ||
934 ($datestamp['year'] == $datenow['year'] + 1 && $datenow['mday'] == 31 && $datenow['mon'] == 12 && $datestamp['yday'] == 1)
935 ) {
936 // Tomorrow
937 return get_string('tomorrow', 'calendar');
938 }
939 else {
940 return $formal;
941 }
942 }
943
944 function calendar_time_representation($time) {
945 static $langtimeformat = NULL;
946 if($langtimeformat === NULL) {
947 $langtimeformat = get_string('strftimetime');
948 }
949 $timeformat = get_user_preferences('calendar_timeformat');
950 if(empty($timeformat)){
951 $timeformat = get_config(NULL,'calendar_site_timeformat');
952 }
953 // The ? is needed because the preference might be present, but empty
954 return userdate($time, empty($timeformat) ? $langtimeformat : $timeformat);
955 }
956
957 /**
958 * Adds day, month, year arguments to a URL and returns a moodle_url object.
959 *
960 * @param string|moodle_url $linkbase
961 * @param int $d
962 * @param int $m
963 * @param int $y
964 * @return moodle_url
965 */
966 function calendar_get_link_href($linkbase, $d, $m, $y) {
967 if (empty($linkbase)) {
968 return '';
969 }
970 if (!($linkbase instanceof moodle_url)) {
971 $linkbase = new moodle_url();
972 }
973 if (!empty($d)) {
974 $linkbase->param('cal_d', $d);
975 }
976 if (!empty($m)) {
977 $linkbase->param('cal_m', $m);
978 }
979 if (!empty($y)) {
980 $linkbase->param('cal_y', $y);
981 }
982 return $linkbase;
983 }
984
985 /**
986 * This function has been deprecated as of Moodle 2.0... DO NOT USE!!!!!
987 *
988 * @deprecated
989 * @since 2.0
990 *
991 * @param string $text
992 * @param string|moodle_url $linkbase
993 * @param int|null $d
994 * @param int|null $m
995 * @param int|null $y
996 * @return string HTML link
997 */
998 function calendar_get_link_tag($text, $linkbase, $d, $m, $y) {
999 $url = calendar_get_link_href(new moodle_url($linkbase), $d, $m, $y);
1000 if (empty($url)) {
1001 return $text;
1002 }
1003 return html_writer::link($url, $text);
1004 }
1005
1006 /**
1007 * Build and return a previous month HTML link, with an arrow.
1008 *
1009 * @param string $text The text label.
1010 * @param string|moodle_url $linkbase The URL stub.
1011 * @param int $d $m $y Day of month, month and year numbers.
1012 * @param bool $accesshide Default visible, or hide from all except screenreaders.
1013 * @return string HTML string.
1014 */
1015 function calendar_get_link_previous($text, $linkbase, $d, $m, $y, $accesshide=false) {
1016 $href = calendar_get_link_href(new moodle_url($linkbase), $d, $m, $y);
1017 if (empty($href)) {
1018 return $text;
1019 }
1020 return link_arrow_left($text, (string)$href, $accesshide, 'previous');
1021 }
1022
1023 /**
1024 * Build and return a next month HTML link, with an arrow.
1025 *
1026 * @param string $text The text label.
1027 * @param string|moodle_url $linkbase The URL stub.
1028 * @param int $d $m $y Day of month, month and year numbers.
1029 * @param bool $accesshide Default visible, or hide from all except screenreaders.
1030 * @return string HTML string.
1031 */
1032 function calendar_get_link_next($text, $linkbase, $d, $m, $y, $accesshide=false) {
1033 $href = calendar_get_link_href(new moodle_url($linkbase), $d, $m, $y);
1034 if (empty($href)) {
1035 return $text;
1036 }
1037 return link_arrow_right($text, (string)$href, $accesshide, 'next');
1038 }
1039
1040 function calendar_wday_name($englishname) {
1041 return get_string(strtolower($englishname), 'calendar');
1042 }
1043
1044 function calendar_days_in_month($month, $year) {
1045 return intval(date('t', mktime(0, 0, 0, $month, 1, $year)));
1046 }
1047
1048 function calendar_get_block_upcoming($events, $linkhref = NULL) {
1049 $content = '';
1050 $lines = count($events);
1051 if (!$lines) {
1052 return $content;
1053 }
1054
1055 for ($i = 0; $i < $lines; ++$i) {
1056 if (!isset($events[$i]->time)) { // Just for robustness
1057 continue;
1058 }
1059 $events[$i] = calendar_add_event_metadata($events[$i]);
1060 $content .= '<div class="event"><span class="icon c0">'.$events[$i]->icon.'</span> ';
1061 if (!empty($events[$i]->referer)) {
1062 // That's an activity event, so let's provide the hyperlink
1063 $content .= $events[$i]->referer;
1064 } else {
1065 if(!empty($linkhref)) {
1066 $ed = usergetdate($events[$i]->timestart);
1067 $href = calendar_get_link_href(new moodle_url(CALENDAR_URL.$linkhref), $ed['mday'], $ed['mon'], $ed['year']);
1068 $href->set_anchor('event_'.$events[$i]->id);
1069 $content .= html_writer::link($href, $events[$i]->name);
1070 }
1071 else {
1072 $content .= $events[$i]->name;
1073 }
1074 }
1075 $events[$i]->time = str_replace('&raquo;', '<br />&raquo;', $events[$i]->time);
1076 $content .= '<div class="date">'.$events[$i]->time.'</div></div>';
1077 if ($i < $lines - 1) $content .= '<hr />';
1078 }
1079
1080 return $content;
1081 }
1082
1083 function calendar_add_month($month, $year) {
1084 if($month == 12) {
1085 return array(1, $year + 1);
1086 }
1087 else {
1088 return array($month + 1, $year);
1089 }
1090 }
1091
1092 function calendar_sub_month($month, $year) {
1093 if($month == 1) {
1094 return array(12, $year - 1);
1095 }
1096 else {
1097 return array($month - 1, $year);
1098 }
1099 }
1100
1101 function calendar_events_by_day($events, $month, $year, &$eventsbyday, &$durationbyday, &$typesbyday, &$courses) {
1102 $eventsbyday = array();
1103 $typesbyday = array();
1104 $durationbyday = array();
1105
1106 if($events === false) {
1107 return;
1108 }
1109
1110 foreach($events as $event) {
1111
1112 $startdate = usergetdate($event->timestart);
1113 // Set end date = start date if no duration
1114 if ($event->timeduration) {
1115 $enddate = usergetdate($event->timestart + $event->timeduration - 1);
1116 } else {
1117 $enddate = $startdate;
1118 }
1119
1120 // Simple arithmetic: $year * 13 + $month is a distinct integer for each distinct ($year, $month) pair
1121 if(!($startdate['year'] * 13 + $startdate['mon'] <= $year * 13 + $month) && ($enddate['year'] * 13 + $enddate['mon'] >= $year * 13 + $month)) {
1122 // Out of bounds
1123 continue;
1124 }
1125
1126 $eventdaystart = intval($startdate['mday']);
1127
1128 if($startdate['mon'] == $month && $startdate['year'] == $year) {
1129 // Give the event to its day
1130 $eventsbyday[$eventdaystart][] = $event->id;
1131
1132 // Mark the day as having such an event
1133 if($event->courseid == SITEID && $event->groupid == 0) {
1134 $typesbyday[$eventdaystart]['startglobal'] = true;
1135 // Set event class for global event
1136 $events[$event->id]->class = 'calendar_event_global';
1137 }
1138 else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
1139 $typesbyday[$eventdaystart]['startcourse'] = true;
1140 // Set event class for course event
1141 $events[$event->id]->class = 'calendar_event_course';
1142 }
1143 else if($event->groupid) {
1144 $typesbyday[$eventdaystart]['startgroup'] = true;
1145 // Set event class for group event
1146 $events[$event->id]->class = 'calendar_event_group';
1147 }
1148 else if($event->userid) {
1149 $typesbyday[$eventdaystart]['startuser'] = true;
1150 // Set event class for user event
1151 $events[$event->id]->class = 'calendar_event_user';
1152 }
1153 }
1154
1155 if($event->timeduration == 0) {
1156 // Proceed with the next
1157 continue;
1158 }
1159
1160 // The event starts on $month $year or before. So...
1161 $lowerbound = $startdate['mon'] == $month && $startdate['year'] == $year ? intval($startdate['mday']) : 0;
1162
1163 // Also, it ends on $month $year or later...
1164 $upperbound = $enddate['mon'] == $month && $enddate['year'] == $year ? intval($enddate['mday']) : calendar_days_in_month($month, $year);
1165
1166 // Mark all days between $lowerbound and $upperbound (inclusive) as duration
1167 for($i = $lowerbound + 1; $i <= $upperbound; ++$i) {
1168 $durationbyday[$i][] = $event->id;
1169 if($event->courseid == SITEID && $event->groupid == 0) {
1170 $typesbyday[$i]['durationglobal'] = true;
1171 }
1172 else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
1173 $typesbyday[$i]['durationcourse'] = true;
1174 }
1175 else if($event->groupid) {
1176 $typesbyday[$i]['durationgroup'] = true;
1177 }
1178 else if($event->userid) {
1179 $typesbyday[$i]['durationuser'] = true;
1180 }
1181 }
1182
1183 }
1184 return;
1185 }
1186
1187 function calendar_get_module_cached(&$coursecache, $modulename, $instance) {
1188 $module = get_coursemodule_from_instance($modulename, $instance);
1189
1190 if($module === false) return false;
1191 if(!calendar_get_course_cached($coursecache, $module->course)) {
1192 return false;
1193 }
1194 return $module;
1195 }
1196
1197 function calendar_get_course_cached(&$coursecache, $courseid) {
1198 global $COURSE, $DB;
1199
1200 if (!isset($coursecache[$courseid])) {
1201 if ($courseid == $COURSE->id) {
1202 $coursecache[$courseid] = $COURSE;
1203 } else {
1204 $coursecache[$courseid] = $DB->get_record('course', array('id'=>$courseid));
1205 }
1206 }
1207 return $coursecache[$courseid];
1208 }
1209
1210 /**
1211 * Returns the courses to load events for, the
1212 *
1213 * @global moodle_database $DB
1214 * @param array $courseeventsfrom An array of courses to load calendar events for
1215 * @param bool $ignorefilters
1216 * @return array An array of courses, groups, and user to load calendar events for based upon filters
1217 */
1218 function calendar_set_filters(array $courseeventsfrom, $ignorefilters = false) {
1219 global $USER, $CFG, $DB;
1220
1221 // For backwards compatability we have to check whether the courses array contains
1222 // just id's in which case we need to load course objects.
1223 $coursestoload = array();
1224 foreach ($courseeventsfrom as $id => $something) {
1225 if (!is_object($something)) {
1226 $coursestoload[] = $id;
1227 unset($courseeventsfrom[$id]);
1228 }
1229 }
1230 if (!empty($coursestoload)) {
1231 // TODO remove this in 2.2
1232 debugging('calendar_set_filters now preferes an array of course objects with preloaded contexts', DEBUG_DEVELOPER);
1233 $courseeventsfrom = array_merge($courseeventsfrom, $DB->get_records_list('course', 'id', $coursestoload));
1234 }
1235
1236 $courses = array();
1237 $user = false;
1238 $group = false;
1239
1240 $isloggedin = isloggedin();
1241
1242 if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_COURSE)) {
1243 $courses = array_keys($courseeventsfrom);
1244 }
1245 if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_GLOBAL)) {
1246 $courses[] = SITEID;
1247 }
1248 $courses = array_unique($courses);
1249 sort($courses);
1250
1251 if (!empty($courses) && in_array(SITEID, $courses)) {
1252 // Sort courses for consistent colour highlighting
1253 // Effectively ignoring SITEID as setting as last course id
1254 $key = array_search(SITEID, $courses);
1255 unset($courses[$key]);
1256 $courses[] = SITEID;
1257 }
1258
1259 if ($ignorefilters || ($isloggedin && calendar_show_event_type(CALENDAR_EVENT_USER))) {
1260 $user = $USER->id;
1261 }
1262
1263 if (!empty($courseeventsfrom) && (calendar_show_event_type(CALENDAR_EVENT_GROUP) || $ignorefilters)) {
1264
1265 if (!empty($CFG->calendar_adminseesall) && has_capability('moodle/calendar:manageentries', get_system_context())) {
1266 $group = true;
1267 } else if ($isloggedin) {
1268 $groupids = array();
1269
1270 // We already have the courses to examine in $courses
1271 // For each course...
1272 foreach ($courseeventsfrom as $courseid => $course) {
1273 // If the user is an editing teacher in there,
1274 if (!empty($USER->groupmember[$course->id])) {
1275 // We've already cached the users groups for this course so we can just use that
1276 $groupids = array_merge($groupids, $USER->groupmember[$course->id]);
1277 } else if (($course->groupmode != NOGROUPS || !$course->groupmodeforce) && has_capability('moodle/calendar:manageentries', get_context_instance(CONTEXT_COURSE, $course->id))) {
1278 // If this course has groups, show events from all of them
1279 $coursegroups = groups_get_user_groups($course->id, $USER->id);
1280 $groupids = array_merge($groupids, $coursegroups['0']);
1281 }
1282 }
1283 if (!empty($groupids)) {
1284 $group = $groupids;
1285 }
1286 }
1287 }
1288 if (empty($courses)) {
1289 $courses = false;
1290 }
1291
1292 return array($courses, $group, $user);
1293 }
1294
1295 function calendar_edit_event_allowed($event) {
1296 global $USER, $DB;
1297
1298 // Must be logged in
1299 if (!isloggedin()) {
1300 return false;
1301 }
1302
1303 // can not be using guest account
1304 if (isguestuser()) {
1305 return false;
1306 }
1307
1308 $sitecontext = get_context_instance(CONTEXT_SYSTEM);
1309 // if user has manageentries at site level, return true
1310 if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
1311 return true;
1312 }
1313
1314 // if groupid is set, it's definitely a group event
1315 if (!empty($event->groupid)) {
1316 // Allow users to add/edit group events if:
1317 // 1) They have manageentries (= entries for whole course)
1318 // 2) They have managegroupentries AND are in the group
1319 $group = $DB->get_record('groups', array('id'=>$event->groupid));
1320 return $group && (
1321 has_capability('moodle/calendar:manageentries', $event->context) ||
1322 (has_capability('moodle/calendar:managegroupentries', $event->context)
1323 && groups_is_member($event->groupid)));
1324 } else if (!empty($event->courseid)) {
1325 // if groupid is not set, but course is set,
1326 // it's definiely a course event
1327 return has_capability('moodle/calendar:manageentries', $event->context);
1328 } else if (!empty($event->userid) && $event->userid == $USER->id) {
1329 // if course is not set, but userid id set, it's a user event
1330 return (has_capability('moodle/calendar:manageownentries', $event->context));
1331 } else if (!empty($event->userid)) {
1332 return (has_capability('moodle/calendar:manageentries', $event->context));
1333 }
1334 return false;
1335 }
1336
1337 /**
1338 * Returns the default courses to display on the calendar when there isn't a specific
1339 * course to display.
1340 *
1341 * @global moodle_database $DB
1342 * @return array Array of courses to display
1343 */
1344 function calendar_get_default_courses() {
1345 global $CFG, $DB;
1346
1347 if (!isloggedin()) {
1348 return array();
1349 }
1350
1351 $courses = array();
1352 if (!empty($CFG->calendar_adminseesall) && has_capability('moodle/calendar:manageentries', get_context_instance(CONTEXT_SYSTEM))) {
1353 list ($select, $join) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1354 $sql = "SELECT c.* $select
1355 FROM {course} c
1356 JOIN {event} e ON e.courseid = c.id
1357 $join";
1358 $courses = $DB->get_records_sql($sql, null, 0, 20);
1359 foreach ($courses as $course) {
1360 context_instance_preload($course);
1361 }
1362 return $courses;
1363 }
1364
1365 $courses = enrol_get_my_courses();
1366
1367 return $courses;
1368 }
1369
1370 function calendar_preferences_button(stdClass $course) {
1371 global $OUTPUT;
1372
1373 // Guests have no preferences
1374 if (!isloggedin() || isguestuser()) {
1375 return '';
1376 }
1377
1378 return $OUTPUT->single_button(new moodle_url('/calendar/preferences.php', array('course' => $course->id)), get_string("preferences", "calendar"));
1379 }
1380
1381 function calendar_format_event_time($event, $now, $linkparams = null, $usecommonwords = true, $showtime=0) {
1382 $startdate = usergetdate($event->timestart);
1383 $enddate = usergetdate($event->timestart + $event->timeduration);
1384 $usermidnightstart = usergetmidnight($event->timestart);
1385
1386 if($event->timeduration) {
1387 // To avoid doing the math if one IF is enough :)
1388 $usermidnightend = usergetmidnight($event->timestart + $event->timeduration);
1389 }
1390 else {
1391 $usermidnightend = $usermidnightstart;
1392 }
1393
1394 if (empty($linkparams) || !is_array($linkparams)) {
1395 $linkparams = array();
1396 }
1397 $linkparams['view'] = 'day';
1398
1399 // OK, now to get a meaningful display...
1400 // First of all we have to construct a human-readable date/time representation
1401
1402 if($event->timeduration) {
1403 // It has a duration
1404 if($usermidnightstart == $usermidnightend ||
1405 ($event->timestart == $usermidnightstart) && ($event->timeduration == 86400 || $event->timeduration == 86399) ||
1406 ($event->timestart + $event->timeduration <= $usermidnightstart + 86400)) {
1407 // But it's all on the same day
1408 $timestart = calendar_time_representation($event->timestart);
1409 $timeend = calendar_time_representation($event->timestart + $event->timeduration);
1410 $time = $timestart.' <strong>&raquo;</strong> '.$timeend;
1411
1412 if ($event->timestart == $usermidnightstart && ($event->timeduration == 86400 || $event->timeduration == 86399)) {
1413 $time = get_string('allday', 'calendar');
1414 }
1415
1416 // Set printable representation
1417 if (!$showtime) {
1418 $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
1419 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $enddate['mday'], $enddate['mon'], $enddate['year']);
1420 $eventtime = html_writer::link($url, $day).', '.$time;
1421 } else {
1422 $eventtime = $time;
1423 }
1424 } else {
1425 // It spans two or more days
1426 $daystart = calendar_day_representation($event->timestart, $now, $usecommonwords).', ';
1427 if ($showtime == $usermidnightstart) {
1428 $daystart = '';
1429 }
1430 $timestart = calendar_time_representation($event->timestart);
1431 $dayend = calendar_day_representation($event->timestart + $event->timeduration, $now, $usecommonwords).', ';
1432 if ($showtime == $usermidnightend) {
1433 $dayend = '';
1434 }
1435 $timeend = calendar_time_representation($event->timestart + $event->timeduration);
1436
1437 // Set printable representation
1438 if ($now >= $usermidnightstart && $now < ($usermidnightstart + 86400)) {
1439 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $enddate['mday'], $enddate['mon'], $enddate['year']);
1440 $eventtime = $timestart.' <strong>&raquo;</strong> '.html_writer::link($url, $dayend).$timeend;
1441 } else {
1442 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $enddate['mday'], $enddate['mon'], $enddate['year']);
1443 $eventtime = html_writer::link($url, $daystart).$timestart.' <strong>&raquo;</strong> ';
1444
1445 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $startdate['mday'], $startdate['mon'], $startdate['year']);
1446 $eventtime .= html_writer::link($url, $dayend).$timeend;
1447 }
1448 }
1449 } else {
1450 $time = ' ';
1451
1452 // Set printable representation
1453 if (!$showtime) {
1454 $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
1455 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $startdate['mday'], $startdate['mon'], $startdate['year']);
1456 $eventtime = html_writer::link($url, $day).trim($time);
1457 } else {
1458 $eventtime = $time;
1459 }
1460 }
1461
1462 if($event->timestart + $event->timeduration < $now) {
1463 // It has expired
1464 $eventtime = '<span class="dimmed_text">'.str_replace(' href=', ' class="dimmed" href=', $eventtime).'</span>';
1465 }
1466
1467 return $eventtime;
1468 }
1469
1470 function calendar_print_month_selector($name, $selected) {
1471 $months = array();
1472 for ($i=1; $i<=12; $i++) {
1473 $months[$i] = userdate(gmmktime(12, 0, 0, $i, 15, 2000), '%B');
1474 }
1475 echo html_writer::select($months, $name, $selected, false);
1476 }
1477
1478 /**
1479 * Checks to see if the requested type of event should be shown for the given user.
1480 *
1481 * @param CALENDAR_EVENT_GLOBAL|CALENDAR_EVENT_COURSE|CALENDAR_EVENT_GROUP|CALENDAR_EVENT_USER $type
1482 * The type to check the display for (default is to display all)
1483 * @param stdClass|int|null $user The user to check for - by default the current user
1484 * @return bool True if the tyep should be displayed false otherwise
1485 */
1486 function calendar_show_event_type($type, $user = null) {
1487 $default = CALENDAR_EVENT_GLOBAL + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP + CALENDAR_EVENT_USER;
1488 if (get_user_preferences('calendar_persistflt', 0, $user) === 0) {
1489 global $SESSION;
1490 if (!isset($SESSION->calendarshoweventtype)) {
1491 $SESSION->calendarshoweventtype = $default;
1492 }
1493 return $SESSION->calendarshoweventtype & $type;
1494 } else {
1495 return get_user_preferences('calendar_savedflt', $default, $user) & $type;
1496 }
1497 }
1498
1499 /**
1500 * Sets the display of the event type given $display.
1501 * If $display = true the event type will be shown.
1502 * If $display = false the event type will NOT be shown.
1503 * If $display = null the current value will be toggled and saved.
1504 *
1505 * @param CALENDAR_EVENT_GLOBAL|CALENDAR_EVENT_COURSE|CALENDAR_EVENT_GROUP|CALENDAR_EVENT_USER $type
1506 * @param true|false|null $display
1507 * @param stdClass|int|null $user
1508 */
1509 function calendar_set_event_type_display($type, $display = null, $user = null) {
1510 $persist = get_user_preferences('calendar_persistflt', 0, $user);
1511 $default = CALENDAR_EVENT_GLOBAL + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP + CALENDAR_EVENT_USER;
1512 if ($persist === 0) {
1513 global $SESSION;
1514 if (!isset($SESSION->calendarshoweventtype)) {
1515 $SESSION->calendarshoweventtype = $default;
1516 }
1517 $preference = $SESSION->calendarshoweventtype;
1518 } else {
1519 $preference = get_user_preferences('calendar_savedflt', $default, $user);
1520 }
1521 $current = $preference & $type;
1522 if ($display === null) {
1523 $display = !$current;
1524 }
1525 if ($display && !$current) {
1526 $preference += $type;
1527 } else if (!$display && $current) {
1528 $preference -= $type;
1529 }
1530 if ($persist === 0) {
1531 $SESSION->calendarshoweventtype = $preference;
1532 } else {
1533 if ($preference == $default) {
1534 unset_user_preference('calendar_savedflt', $user);
1535 } else {
1536 set_user_preference('calendar_savedflt', $preference, $user);
1537 }
1538 }
1539 }
1540
1541 function calendar_get_allowed_types(&$allowed, $course = null) {
1542 global $USER, $CFG, $DB;
1543 $allowed->user = has_capability('moodle/calendar:manageownentries', get_system_context());
1544 $allowed->groups = false; // This may change just below
1545 $allowed->courses = false; // This may change just below
1546 $allowed->site = has_capability('moodle/calendar:manageentries', get_context_instance(CONTEXT_COURSE, SITEID));
1547
1548 if (!empty($course)) {
1549 if (!is_object($course)) {
1550 $course = $DB->get_record('course', array('id' => $course), '*', MUST_EXIST);
1551 }
1552 if ($course->id != SITEID) {
1553 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1554
1555 if (has_capability('moodle/calendar:manageentries', $coursecontext)) {
1556 $allowed->courses = array($course->id => 1);
1557
1558 if ($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
1559 $allowed->groups = groups_get_all_groups($course->id);
1560 }
1561 } else if (has_capability('moodle/calendar:managegroupentries', $coursecontext)) {
1562 if($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
1563 $allowed->groups = groups_get_all_groups($course->id);
1564 }
1565 }
1566 }
1567 }
1568 }
1569
1570 /**
1571 * see if user can add calendar entries at all
1572 * used to print the "New Event" button
1573 * @return bool
1574 */
1575 function calendar_user_can_add_event($course) {
1576 if (!isloggedin() || isguestuser()) {
1577 return false;
1578 }
1579 calendar_get_allowed_types($allowed, $course);
1580 return (bool)($allowed->user || $allowed->groups || $allowed->courses || $allowed->site);
1581 }
1582
1583 /**
1584 * Check wether the current user is permitted to add events
1585 *
1586 * @param object $event
1587 * @return bool
1588 */
1589 function calendar_add_event_allowed($event) {
1590 global $USER, $DB;
1591
1592 // can not be using guest account
1593 if (!isloggedin() or isguestuser()) {
1594 return false;
1595 }
1596
1597 $sitecontext = get_context_instance(CONTEXT_SYSTEM);
1598 // if user has manageentries at site level, always return true
1599 if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
1600 return true;
1601 }
1602
1603 switch ($event->eventtype) {
1604 case 'course':
1605 return has_capability('moodle/calendar:manageentries', $event->context);
1606
1607 case 'group':
1608 // Allow users to add/edit group events if:
1609 // 1) They have manageentries (= entries for whole course)
1610 // 2) They have managegroupentries AND are in the group
1611 $group = $DB->get_record('groups', array('id'=>$event->groupid));
1612 return $group && (
1613 has_capability('moodle/calendar:manageentries', $event->context) ||
1614 (has_capability('moodle/calendar:managegroupentries', $event->context)
1615 && groups_is_member($event->groupid)));
1616
1617 case 'user':
1618 if ($event->userid == $USER->id) {
1619 return (has_capability('moodle/calendar:manageownentries', $event->context));
1620 }
1621 //there is no 'break;' intentionally
1622
1623 case 'site':
1624 return has_capability('moodle/calendar:manageentries', $event->context);
1625
1626 default:
1627 return has_capability('moodle/calendar:manageentries', $event->context);
1628 }
1629 }
1630
1631 /**
1632 * A class to manage calendar events
1633 *
1634 * This class provides the required functionality in order to manage calendar events.
1635 * It was introduced as part of Moodle 2.0 and was created in order to provide a
1636 * better framework for dealing with calendar events in particular regard to file
1637 * handling through the new file API
1638 *
1639 * @property int $id The id within the event table
1640 * @property string $name The name of the event
1641 * @property string $description The description of the event
1642 * @property int $format The format of the description FORMAT_?
1643 * @property int $courseid The course the event is associated with (0 if none)
1644 * @property int $groupid The group the event is associated with (0 if none)
1645 * @property int $userid The user the event is associated with (0 if none)
1646 * @property int $repeatid If this is a repeated event this will be set to the
1647 * id of the original
1648 * @property string $modulename If added by a module this will be the module name
1649 * @property int $instance If added by a module this will be the module instance
1650 * @property string $eventtype The event type
1651 * @property int $timestart The start time as a timestamp
1652 * @property int $timeduration The duration of the event in seconds
1653 * @property int $visible 1 if the event is visible
1654 * @property int $uuid ?
1655 * @property int $sequence ?
1656 * @property int $timemodified The time last modified as a timestamp
1657 */
1658 class calendar_event {
1659
1660 /**
1661 * An object containing the event properties can be accessed via the
1662 * magic __get/set methods
1663 * @var array
1664 */
1665 protected $properties = null;
1666 /**
1667 * The converted event discription with file paths resolved
1668 * This gets populated when someone requests description for the first time
1669 * @var string
1670 */
1671 protected $_description = null;
1672 /**
1673 * The options to use with this description editor
1674 * @var array
1675 */
1676 protected $editoroptions = array(
1677 'subdirs'=>false,
1678 'forcehttps'=>false,
1679 'maxfiles'=>-1,
1680 'maxbytes'=>null,
1681 'trusttext'=>false);
1682 /**
1683 * The context to use with the description editor
1684 * @var object
1685 */
1686 protected $editorcontext = null;
1687
1688 /**
1689 * Instantiates a new event and optionally populates its properties with the
1690 * data provided
1691 *
1692 * @param stdClass $data Optional. An object containing the properties to for
1693 * an event
1694 */
1695 public function __construct($data=null) {
1696 global $CFG, $USER;
1697
1698 // First convert to object if it is not already (should either be object or assoc array)
1699 if (!is_object($data)) {
1700 $data = (object)$data;
1701 }
1702
1703 $this->editoroptions['maxbytes'] = $CFG->maxbytes;
1704
1705 $data->eventrepeats = 0;
1706
1707 if (empty($data->id)) {
1708 $data->id = null;
1709 }
1710
1711 // Default to a user event
1712 if (empty($data->eventtype)) {
1713 $data->eventtype = 'user';
1714 }
1715
1716 // Default to the current user
1717 if (empty($data->userid)) {
1718 $data->userid = $USER->id;
1719 }
1720
1721 if (!empty($data->timeduration) && is_array($data->timeduration)) {
1722 $data->timeduration = make_timestamp($data->timeduration['year'], $data->timeduration['month'], $data->timeduration['day'], $data->timeduration['hour'], $data->timeduration['minute']) - $data->timestart;
1723 }
1724 if (!empty($data->description) && is_array($data->description)) {
1725 $data->format = $data->description['format'];
1726 $data->description = $data->description['text'];
1727 } else if (empty($data->description)) {
1728 $data->description = '';
1729 $data->format = editors_get_preferred_format();
1730 }
1731 // Ensure form is defaulted correctly
1732 if (empty($data->format)) {
1733 $data->format = editors_get_preferred_format();
1734 }
1735
1736 if (empty($data->context)) {
1737 $data->context = $this->calculate_context($data);
1738 }
1739 $this->properties = $data;
1740 }
1741
1742 /**
1743 * Magic property method
1744 *
1745 * Attempts to call a set_$key method if one exists otherwise falls back
1746 * to simply set the property
1747 *
1748 * @param string $key
1749 * @param mixed $value
1750 */
1751 public function __set($key, $value) {
1752 if (method_exists($this, 'set_'.$key)) {
1753 $this->{'set_'.$key}($value);
1754 }
1755 $this->properties->{$key} = $value;
1756 }
1757
1758 /**
1759 * Magic get method
1760 *
1761 * Attempts to call a get_$key method to return the property and ralls over
1762 * to return the raw property
1763 *
1764 * @param str $key
1765 * @return mixed
1766 */
1767 public function __get($key) {
1768 if (method_exists($this, 'get_'.$key)) {
1769 return $this->{'get_'.$key}();
1770 }
1771 if (!isset($this->properties->{$key})) {
1772 throw new coding_exception('Undefined property requested');
1773 }
1774 return $this->properties->{$key};
1775 }
1776
1777 /**
1778 * Stupid PHP needs an isset magic method if you use the get magic method and
1779 * still want empty calls to work.... blah ~!
1780 *
1781 * @param string $key
1782 * @return bool
1783 */
1784 public function __isset($key) {
1785 return !empty($this->properties->{$key});
1786 }
1787
1788 /**
1789 * Calculate the context value needed for calendar_event.
1790 * Event's type can be determine by the available value store in $data
1791 * It is important to check for the existence of course/courseid to determine
1792 * the course event.
1793 * Default value is set to CONTEXT_USER
1794 *
1795 * @return stdClass
1796 */
1797 protected function calculate_context(stdClass $data) {
1798 global $USER;
1799
1800 $context = null;
1801 if (isset($data->courseid) && $data->courseid > 0) {
1802 $context = get_context_instance(CONTEXT_COURSE, $data->courseid);
1803 } else if (isset($data->course) && $data->course > 0) {
1804 $context = get_context_instance(CONTEXT_COURSE, $data->course);
1805 } else if (isset($data->groupid) && $data->groupid > 0) {
1806 $group = $DB->get_record('groups', array('id'=>$data->groupid));
1807 $context = get_context_instance(CONTEXT_COURSE, $group->courseid);
1808 } else if (isset($data->userid) && $data->userid > 0 && $data->userid == $USER->id) {
1809 $context = get_context_instance(CONTEXT_USER);
1810 } else if (isset($data->userid) && $data->userid > 0 && $data->userid != $USER->id &&
1811 isset($data->instance) && $data->instance > 0) {
1812 $cm = get_coursemodule_from_instance($data->modulename, $data->instance, 0, false, MUST_EXIST);
1813 $context = get_context_instance(CONTEXT_COURSE, $cm->course);
1814 } else {
1815 $context = get_context_instance(CONTEXT_USER);
1816 }
1817
1818 return $context;
1819 }
1820
1821 /**
1822 * Returns an array of editoroptions for this event: Called by __get
1823 * Please use $blah = $event->editoroptions;
1824 * @return array
1825 */
1826 protected function get_editoroptions() {
1827 return $this->editoroptions;
1828 }
1829
1830 /**
1831 * Returns an event description: Called by __get
1832 * Please use $blah = $event->description;
1833 *
1834 * @return string
1835 */
1836 protected function get_description() {
1837 global $CFG;
1838
1839 require_once($CFG->libdir . '/filelib.php');
1840
1841 if ($this->_description === null) {
1842 // Check if we have already resolved the context for this event
1843 if ($this->editorcontext === null) {
1844 // Switch on the event type to decide upon the appropriate context
1845 // to use for this event
1846 $this->editorcontext = $this->properties->context;
1847 if ($this->properties->eventtype != 'user' && $this->properties->eventtype != 'course'
1848 && $this->properties->eventtype != 'site' && $this->properties->eventtype != 'group') {
1849 return clean_text($this->properties->description, $this->properties->format);
1850 }
1851 }
1852
1853 // Work out the item id for the editor, if this is a repeated event then the files will
1854 // be associated with the original
1855 if (!empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
1856 $itemid = $this->properties->repeatid;
1857 } else {
1858 $itemid = $this->properties->id;
1859 }
1860
1861 // Convert file paths in the description so that things display correctly
1862 $this->_description = file_rewrite_pluginfile_urls($this->properties->description, 'pluginfile.php', $this->editorcontext->id, 'calendar', 'event_description', $itemid);
1863 // Clean the text so no nasties get through
1864 $this->_description = clean_text($this->_description, $this->properties->format);
1865 }
1866 // Finally return the description
1867 return $this->_description;
1868 }
1869
1870 /**
1871 * Return the number of repeat events there are in this events series
1872 *
1873 * @return int
1874 */
1875 public function count_repeats() {
1876 global $DB;
1877 if (!empty($this->properties->repeatid)) {
1878 $this->properties->eventrepeats = $DB->count_records('event', array('repeatid'=>$this->properties->repeatid));
1879 // We don't want to count ourselves
1880 $this->properties->eventrepeats--;
1881 }
1882 return $this->properties->eventrepeats;
1883 }
1884
1885 /**
1886 * Update or create an event within the database
1887 *
1888 * Pass in a object containing the event properties and this function will
1889 * insert it into the database and deal with any associated files
1890 *
1891 * @see add_event()
1892 * @see update_event()
1893 *
1894 * @param stdClass $data
1895 * @param boolean $checkcapability if moodle should check calendar managing capability or not
1896 */
1897 public function update($data, $checkcapability=true) {
1898 global $CFG, $DB, $USER;
1899
1900 foreach ($data as $key=>$value) {
1901 $this->properties->$key = $value;
1902 }
1903
1904 $this->properties->timemodified = time();
1905 $usingeditor = (!empty($this->properties->description) && is_array($this->properties->description));
1906
1907 if (empty($this->properties->id) || $this->properties->id < 1) {
1908
1909 if ($checkcapability) {
1910 if (!calendar_add_event_allowed($this->properties)) {
1911 print_error('nopermissiontoupdatecalendar');
1912 }
1913 }
1914
1915 if ($usingeditor) {
1916 switch ($this->properties->eventtype) {
1917 case 'user':
1918 $this->editorcontext = $this->properties->context;
1919 $this->properties->courseid = 0;
1920 $this->properties->groupid = 0;
1921 $this->properties->userid = $USER->id;
1922 break;
1923 case 'site':
1924 $this->editorcontext = $this->properties->context;
1925 $this->properties->courseid = SITEID;
1926 $this->properties->groupid = 0;
1927 $this->properties->userid = $USER->id;
1928 break;
1929 case 'course':
1930 $this->editorcontext = $this->properties->context;
1931 $this->properties->groupid = 0;
1932 $this->properties->userid = $USER->id;
1933 break;
1934 case 'group':
1935 $this->editorcontext = $this->properties->context;
1936 $this->properties->userid = $USER->id;
1937 break;
1938 default:
1939 // Ewww we should NEVER get here, but just incase we do lets
1940 // fail gracefully
1941 $usingeditor = false;
1942 break;
1943 }
1944
1945 $editor = $this->properties->description;
1946 $this->properties->format = $this->properties->description['format'];
1947 $this->properties->description = $this->properties->description['text'];
1948 }
1949
1950 // Insert the event into the database
1951 $this->properties->id = $DB->insert_record('event', $this->properties);
1952
1953 if ($usingeditor) {
1954 $this->properties->description = file_save_draft_area_files(
1955 $editor['itemid'],
1956 $this->editorcontext->id,
1957 'calendar',
1958 'event_description',
1959 $this->properties->id,
1960 $this->editoroptions,
1961 $editor['text'],
1962 $this->editoroptions['forcehttps']);
1963
1964 $DB->set_field('event', 'description', $this->properties->description, array('id'=>$this->properties->id));
1965 }
1966
1967 // Log the event entry.
1968 add_to_log($this->properties->courseid, 'calendar', 'add', 'event.php?action=edit&amp;id='.$this->properties->id, $this->properties->name);
1969
1970 $repeatedids = array();
1971
1972 if (!empty($this->properties->repeat)) {
1973 $this->properties->repeatid = $this->properties->id;
1974 $DB->set_field('event', 'repeatid', $this->properties->repeatid, array('id'=>$this->properties->id));
1975
1976 $eventcopy = clone($this->properties);
1977 unset($eventcopy->id);
1978
1979 for($i = 1; $i < $eventcopy->repeats; $i++) {
1980
1981 $eventcopy->timestart = ($eventcopy->timestart+WEEKSECS) + dst_offset_on($eventcopy->timestart) - dst_offset_on($eventcopy->timestart+WEEKSECS);
1982
1983 // Get the event id for the log record.
1984 $eventcopyid = $DB->insert_record('event', $eventcopy);
1985
1986 // If the context has been set delete all associated files
1987 if ($usingeditor) {
1988 $fs = get_file_storage();
1989 $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description', $this->properties->id);
1990 foreach ($files as $file) {
1991 $fs->create_file_from_storedfile(array('itemid'=>$eventcopyid), $file);
1992 }
1993 }
1994
1995 $repeatedids[] = $eventcopyid;
1996 // Log the event entry.
1997 add_to_log($eventcopy->courseid, 'calendar', 'add', 'event.php?action=edit&amp;id='.$eventcopyid, $eventcopy->name);
1998 }
1999 }
2000
2001 // Hook for tracking added events
2002 self::calendar_event_hook('add_event', array($this->properties, $repeatedids));
2003 return true;
2004 } else {
2005
2006 if ($checkcapability) {
2007 if(!calendar_edit_event_allowed($this->properties)) {
2008 print_error('nopermissiontoupdatecalendar');
2009 }
2010 }
2011
2012 if ($usingeditor) {
2013 if ($this->editorcontext !== null) {
2014 $this->properties->description = file_save_draft_area_files(
2015 $this->properties->description['itemid'],
2016 $this->editorcontext->id,
2017 'calendar',
2018 'event_description',
2019 $this->properties->id,
2020 $this->editoroptions,
2021 $this->properties->description['text'],
2022 $this->editoroptions['forcehttps']);
2023 } else {
2024 $this->properties->format = $this->properties->description['format'];
2025 $this->properties->description = $this->properties->description['text'];
2026 }
2027 }
2028
2029 $event = $DB->get_record('event', array('id'=>$this->properties->id));
2030
2031 $updaterepeated = (!empty($this->properties->repeatid) && !empty($this->properties->repeateditall));
2032
2033 if ($updaterepeated) {
2034 // Update all
2035 if ($this->properties->timestart != $event->timestart) {
2036 $timestartoffset = $this->properties->timestart - $event->timestart;
2037 $sql = "UPDATE {event}
2038 SET name = ?,
2039 description = ?,
2040 timestart = timestart + ?,
2041 timeduration = ?,
2042 timemodified = ?
2043 WHERE repeatid = ?";
2044 $params = array($this->properties->name, $this->properties->description, $timestartoffset, $this->properties->timeduration, time(), $event->repeatid);
2045 } else {
2046 $sql = "UPDATE {event} SET name = ?, description = ?, timeduration = ?, timemodified = ? WHERE repeatid = ?";
2047 $params = array($this->properties->name, $this->properties->description, $this->properties->timeduration, time(), $event->repeatid);
2048 }
2049 $DB->execute($sql, $params);
2050
2051 // Log the event update.
2052 add_to_log($this->properties->courseid, 'calendar', 'edit all', 'event.php?action=edit&amp;id='.$this->properties->id, $this->properties->name);
2053 } else {
2054 $DB->update_record('event', $this->properties);
2055 $event = calendar_event::load($this->properties->id);
2056 $this->properties = $event->properties();
2057 add_to_log($this->properties->courseid, 'calendar', 'edit', 'event.php?action=edit&amp;id='.$this->properties->id, $this->properties->name);
2058 }
2059
2060 // Hook for tracking event updates
2061 self::calendar_event_hook('update_event', array($this->properties, $updaterepeated));
2062 return true;
2063 }
2064 }
2065
2066 /**
2067 * Deletes an event and if selected an repeated events in the same series
2068 *
2069 * This function deletes an event, any associated events if $deleterepeated=true,
2070 * and cleans up any files associated with the events.
2071 *
2072 * @see delete_event()
2073 *
2074 * @param bool $deleterepeated
2075 * @return bool
2076 */
2077 public function delete($deleterepeated=false) {
2078 global $DB;
2079
2080 // If $this->properties->id is not set then something is wrong
2081 if (empty($this->properties->id)) {
2082 debugging('Attempting to delete an event before it has been loaded', DEBUG_DEVELOPER);
2083 return false;
2084 }
2085
2086 // Delete the event
2087 $DB->delete_records('event', array('id'=>$this->properties->id));
2088
2089 // If the editor context hasn't already been set then set it now
2090 if ($this->editorcontext === null) {
2091 $this->editorcontext = $this->properties->context;
2092 }
2093
2094 // If the context has been set delete all associated files
2095 if ($this->editorcontext !== null) {
2096 $fs = get_file_storage();
2097 $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description', $this->properties->id);
2098 foreach ($files as $file) {
2099 $file->delete();
2100 }
2101 }
2102
2103 // Fire the event deleted hook
2104 self::calendar_event_hook('delete_event', array($this->properties->id, $deleterepeated));
2105
2106 // If we need to delete repeated events then we will fetch them all and delete one by one
2107 if ($deleterepeated && !empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
2108 // Get all records where the repeatid is the same as the event being removed
2109 $events = $DB->get_records('event', array('repeatid'=>$this->properties->repeatid));
2110 // For each of the returned events populate a calendar_event object and call delete
2111 // make sure the arg passed is false as we are already deleting all repeats
2112 foreach ($events as $event) {
2113 $event = new calendar_event($event);
2114 $event->delete(false);
2115 }
2116 }
2117
2118 return true;
2119 }
2120
2121 /**
2122 * Fetch all event properties
2123 *
2124 * This function returns all of the events properties as an object and optionally
2125 * can prepare an editor for the description field at the same time. This is
2126 * designed to work when the properties are going to be used to set the default
2127 * values of a moodle forms form.
2128 *
2129 * @param bool $prepareeditor If set to true a editor is prepared for use with
2130 * the mforms editor element. (for description)
2131 * @return stdClass Object containing event properties
2132 */
2133 public function properties($prepareeditor=false) {
2134 global $USER, $CFG, $DB;
2135
2136 // First take a copy of the properties. We don't want to actually change the
2137 // properties or we'd forever be converting back and forwards between an
2138 // editor formatted description and not
2139 $properties = clone($this->properties);
2140 // Clean the description here
2141 $properties->description = clean_text($properties->description, $properties->format);
2142
2143 // If set to true we need to prepare the properties for use with an editor
2144 // and prepare the file area
2145 if ($prepareeditor) {
2146
2147 // We may or may not have a property id. If we do then we need to work
2148 // out the context so we can copy the existing files to the draft area
2149 if (!empty($properties->id)) {
2150
2151 if ($properties->eventtype === 'site') {
2152 // Site context
2153 $this->editorcontext = $this->properties->context;
2154 } else if ($properties->eventtype === 'user') {
2155 // User context
2156 $this->editorcontext = $this->properties->context;
2157 } else if ($properties->eventtype === 'group' || $properties->eventtype === 'course') {
2158 // First check the course is valid
2159 $course = $DB->get_record('course', array('id'=>$properties->courseid));
2160 if (!$course) {
2161 print_error('invalidcourse');
2162 }
2163 // Course context
2164 $this->editorcontext = $this->properties->context;
2165 // We have a course and are within the course context so we had
2166 // better use the courses max bytes value
2167 $this->editoroptions['maxbytes'] = $course->maxbytes;
2168 } else {
2169 // If we get here we have a custom event type as used by some
2170 // modules. In this case the event will have been added by
2171 // code and we won't need the editor
2172 $this->editoroptions['maxbytes'] = 0;
2173 $this->editoroptions['maxfiles'] = 0;
2174 }
2175
2176 if (empty($this->editorcontext) || empty($this->editorcontext->id)) {
2177 $contextid = false;
2178 } else {
2179 // Get the context id that is what we really want
2180 $contextid = $this->editorcontext->id;
2181 }
2182 } else {
2183
2184 // If we get here then this is a new event in which case we don't need a
2185 // context as there is no existing files to copy to the draft area.
2186 $contextid = null;
2187 }
2188
2189 // If the contextid === false we don't support files so no preparing
2190 // a draft area
2191 if ($contextid !== false) {
2192 // Just encase it has already been submitted
2193 $draftiddescription = file_get_submitted_draft_itemid('description');
2194 // Prepare the draft area, this copies existing files to the draft area as well
2195 $properties->description = file_prepare_draft_area($draftiddescription, $contextid, 'calendar', 'event_description', $properties->id, $this->editoroptions, $properties->description);
2196 } else {
2197 $draftiddescription = 0;
2198 }
2199
2200 // Structure the description field as the editor requires
2201 $properties->description = array('text'=>$properties->description, 'format'=>$properties->format, 'itemid'=>$draftiddescription);
2202 }
2203
2204 // Finally return the properties
2205 return $properties;
2206 }
2207
2208 /**
2209 * Toggles the visibility of an event
2210 *
2211 * @param null|bool $force If it is left null the events visibility is flipped,
2212 * If it is false the event is made hidden, if it is true it
2213 * is made visible.
2214 */
2215 public function toggle_visibility($force=null) {
2216 global $CFG, $DB;
2217
2218 // Set visible to the default if it is not already set
2219 if (empty($this->properties->visible)) {
2220 $this->properties->visible = 1;
2221 }
2222
2223 if ($force === true || ($force !== false && $this->properties->visible == 0)) {
2224 // Make this event visible
2225 $this->properties->visible = 1;
2226 // Fire the hook
2227 self::calendar_event_hook('show_event', array($this->properties));
2228 } else {
2229 // Make this event hidden
2230 $this->properties->visible = 0;
2231 // Fire the hook
2232 self::calendar_event_hook('hide_event', array($this->properties));
2233 }
2234
2235 // Update the database to reflect this change
2236 return $DB->set_field('event', 'visible', $this->properties->visible, array('id'=>$this->properties->id));
2237 }
2238
2239 /**
2240 * Attempts to call the hook for the specified action should a calendar type
2241 * by set $CFG->calendar, and the appopriate function defined
2242 *
2243 * @static
2244 * @staticvar bool $extcalendarinc Used to track the inclusion of the calendar lib
2245 * @param string $action One of `update_event`, `add_event`, `delete_event`, `show_event`, `hide_event`
2246 * @param array $args The args to pass to the hook, usually the event is the first element
2247 * @return bool
2248 */
2249 public static function calendar_event_hook($action, array $args) {
2250 global $CFG;
2251 static $extcalendarinc;
2252 if ($extcalendarinc === null) {
2253 if (!empty($CFG->calendar) && file_exists($CFG->dirroot .'/calendar/'. $CFG->calendar .'/lib.php')) {
2254 include_once($CFG->dirroot .'/calendar/'. $CFG->calendar .'/lib.php');
2255 $extcalendarinc = true;
2256 } else {
2257 $extcalendarinc = false;
2258 }
2259 }
2260 if($extcalendarinc === false) {
2261 return false;
2262 }
2263 $hook = $CFG->calendar .'_'.$action;
2264 if (function_exists($hook)) {
2265 call_user_func_array($hook, $args);
2266 return true;
2267 }
2268 return false;
2269 }
2270
2271 /**
2272 * Returns a calendar_event object when provided with an event id
2273 *
2274 * This function makes use of MUST_EXIST, if the event id passed in is invalid
2275 * it will result in an exception being thrown
2276 *
2277 * @param int|object $param
2278 * @return calendar_event|false
2279 */
2280 public static function load($param) {
2281 global $DB;
2282 if (is_object($param)) {
2283 $event = new calendar_event($param);
2284 } else {
2285 $event = $DB->get_record('event', array('id'=>(int)$param), '*', MUST_EXIST);
2286 $event = new calendar_event($event);
2287 }
2288 return $event;
2289 }
2290
2291 /**
2292 * Creates a new event and returns a calendar_event object
2293 *
2294 * @param object|array $properties An object containing event properties
2295 * @return calendar_event|false The event object or false if it failed
2296 */
2297 public static function create($properties) {
2298 if (is_array($properties)) {
2299 $properties = (object)$properties;
2300 }
2301 if (!is_object($properties)) {
2302 throw new coding_exception('When creating an event properties should be either an object or an assoc array');
2303 }
2304 $event = new calendar_event($properties);
2305 if ($event->update($properties)) {
2306 return $event;
2307 } else {
2308 return false;
2309 }
2310 }
2311 }
2312
2313 /**
2314 * Calendar information class
2315 *
2316 * This class is used simply to organise the information pertaining to a calendar
2317 * and is used primarily to make information easily available.
2318 */
2319 class calendar_information {
2320 /**
2321 * The day
2322 * @var int
2323 */
2324 public $day;
2325 /**
2326 * The month
2327 * @var int
2328 */
2329 public $month;
2330 /**
2331 * The year
2332 * @var int
2333 */
2334 public $year;
2335
2336 /**
2337 * A course id
2338 * @var int
2339 */
2340 public $courseid = null;
2341 /**
2342 * An array of courses
2343 * @var array
2344 */
2345 public $courses = array();
2346 /**
2347 * An array of groups
2348 * @var array
2349 */
2350 public $groups = array();
2351 /**
2352 * An array of users
2353 * @var array
2354 */
2355 public $users = array();
2356
2357 /**
2358 * Creates a new instance
2359 *
2360 * @param int $day
2361 * @param int $month
2362 * @param int $year
2363 */
2364 public function __construct($day=0, $month=0, $year=0) {
2365
2366 $date = usergetdate(time());
2367
2368 if (empty($day)) {
2369 $day = $date['mday'];
2370 }
2371
2372 if (empty($month)) {
2373 $month = $date['mon'];
2374 }
2375
2376 if (empty($year)) {
2377 $year = $date['year'];
2378 }
2379
2380 $this->day = $day;
2381 $this->month = $month;
2382 $this->year = $year;
2383 }
2384
2385 /**
2386 *
2387 * @param stdClass $course
2388 * @param array $coursestoload An array of courses [$course->id => $course]
2389 * @param type $ignorefilters
2390 */
2391 public function prepare_for_view(stdClass $course, array $coursestoload, $ignorefilters = false) {
2392 $this->courseid = $course->id;
2393 $this->course = $course;
2394 list($courses, $group, $user) = calendar_set_filters($coursestoload, $ignorefilters);
2395 $this->courses = $courses;
2396 $this->groups = $group;
2397 $this->users = $user;
2398 }
2399
2400 /**
2401 * Ensures the date for the calendar is correct and either sets it to now
2402 * or throws a moodle_exception if not
2403 *
2404 * @param bool $defaultonow
2405 * @return bool
2406 */
2407 public function checkdate($defaultonow = true) {
2408 if (!checkdate($this->month, $this->day, $this->year)) {
2409 if ($defaultonow) {
2410 $now = usergetdate(time());
2411 $this->day = intval($now['mday']);
2412 $this->month = intval($now['mon']);
2413 $this->year = intval($now['year']);
2414 return true;
2415 } else {
2416 throw new moodle_exception('invaliddate');
2417 }
2418 }
2419 return true;
2420 }
2421 /**
2422 * Gets todays timestamp for the calendar
2423 * @return int
2424 */
2425 public function timestamp_today() {
2426 return make_timestamp($this->year, $this->month, $this->day);
2427 }
2428 /**
2429 * Gets tomorrows timestamp for the calendar
2430 * @return int
2431 */
2432 public function timestamp_tomorrow() {
2433 return make_timestamp($this->year, $this->month, $this->day+1);
2434 }
2435 /**
2436 * Adds the pretend blocks for teh calendar
2437 *
2438 * @param core_calendar_renderer $renderer
2439 * @param bool $showfilters
2440 * @param string|null $view
2441 */
2442 public function add_sidecalendar_blocks(core_calendar_renderer $renderer, $showfilters=false, $view=null) {
2443 if ($showfilters) {
2444 $filters = new block_contents();
2445 $filters->content = $renderer->fake_block_filters($this->courseid, $this->day, $this->month, $this->year, $view, $this->courses);
2446 $filters->footer = '';
2447 $filters->title = get_string('eventskey', 'calendar');
2448 $renderer->add_pretend_calendar_block($filters, BLOCK_POS_RIGHT);
2449 }
2450 $block = new block_contents;
2451 $block->content = $renderer->fake_block_threemonths($this);
2452 $block->footer = '';
2453 $block->title = get_string('monthlyview', 'calendar');
2454 $renderer->add_pretend_calendar_block($block, BLOCK_POS_RIGHT);
2455 }
2456 }
Read-only mirror of the Moodle CVS