Skip to content

Commit

Permalink
MDL-52798 calendar: Move calendar preferences to a user preferences page
Browse files Browse the repository at this point in the history
This is based on the work of Shamim Rezaie and will also resolve
MDL-52375 and MDL-50378
  • Loading branch information
sbourget committed Sep 7, 2016
1 parent 5c33a0d commit 9629790
Show file tree
Hide file tree
Showing 11 changed files with 224 additions and 120 deletions.
1 change: 0 additions & 1 deletion calendar/export.php
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,6 @@
$PAGE->set_title($course->shortname.': '.get_string('calendar', 'calendar').': '.$pagetitle);
$PAGE->set_heading($course->fullname);
$PAGE->set_pagelayout('standard');
$PAGE->set_button(calendar_preferences_button($course));

$renderer = $PAGE->get_renderer('core_calendar');
$calendar->add_sidecalendar_blocks($renderer);
Expand Down
5 changes: 4 additions & 1 deletion calendar/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -1658,6 +1658,8 @@ function calendar_get_default_courses() {
* Display calendar preference button
*
* @param stdClass $course course object
* @deprecated since Moodle 3.2
* @todo MDL-55875 This will be deleted in Moodle 3.6.
* @return string return preference button in html
*/
function calendar_preferences_button(stdClass $course) {
Expand All @@ -1667,8 +1669,9 @@ function calendar_preferences_button(stdClass $course) {
if (!isloggedin() || isguestuser()) {
return '';
}
debugging('This should no longer be used, the calendar preferences are now linked to the user preferences page');

return $OUTPUT->single_button(new moodle_url('/calendar/preferences.php', array('course' => $course->id)), get_string("preferences", "calendar"));
return $OUTPUT->single_button(new moodle_url('/user/calendar.php'), get_string("preferences", "calendar"));
}

/**
Expand Down
1 change: 0 additions & 1 deletion calendar/managesubscriptions.php
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,6 @@
// Print title and header.
$PAGE->set_title("$course->shortname: ".get_string('calendar', 'calendar').": ".get_string('subscriptions', 'calendar'));
$PAGE->set_heading($course->fullname);
$PAGE->set_button(calendar_preferences_button($course));

$renderer = $PAGE->get_renderer('core_calendar');

Expand Down
84 changes: 0 additions & 84 deletions calendar/preferences.php

This file was deleted.

8 changes: 5 additions & 3 deletions calendar/tests/behat/calendar_lookahead.feature
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,13 @@ Feature: Limit displayed upcoming events
| Event title | Two months away event |
When I follow "C1"
Then I should not see "Two months away event"
And I follow "Go to calendar"
And I click on "Preferences" "button"
And I am on site homepage
And I follow "Preferences" in the user menu
And I follow "Calendar preferences"
And I set the following fields to these values:
| Upcoming events look-ahead | 3 months |
And I press "Save changes"
And I wait to be redirected
And I follow "C1"
And I am on site homepage
And I follow "Course 1"
And I should see "Two months away event"
3 changes: 3 additions & 0 deletions calendar/upgrade.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
This files describes API changes in /calendar/* ,
information provided here is intended especially for developers.

=== 3.2 ===
* calendar_preferences_button() is now depreciated. Calendar preferences have been moved to the user preferences page.

=== 2.9 ===
default values changes in code:
* core_calendar_external::get_calendar_events_parameters() 'timeend' default option changed; now, by default,
Expand Down
8 changes: 6 additions & 2 deletions calendar/view.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,12 @@
// //
/////////////////////////////////////////////////////////////////////////////

// Display the calendar page.
/**
* Display the calendar page.
* @copyright 2003 Jon Papaioannou
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package core_calendar
*/

require_once('../config.php');
require_once($CFG->dirroot.'/course/lib.php');
Expand Down Expand Up @@ -117,7 +122,6 @@
$PAGE->set_pagelayout('standard');
$PAGE->set_title("$course->shortname: $strcalendar: $pagetitle");
$PAGE->set_heading($COURSE->fullname);
$PAGE->set_button(calendar_preferences_button($course));

$renderer = $PAGE->get_renderer('core_calendar');
$calendar->add_sidecalendar_blocks($renderer, true, $view);
Expand Down
9 changes: 9 additions & 0 deletions lib/navigationlib.php
Original file line number Diff line number Diff line change
Expand Up @@ -4461,6 +4461,15 @@ protected function generate_user_settings($courseid, $userid, $gstitle='usercurr
}
}

// Add "Calendar preferences" link.
if (isloggedin() && !isguestuser($user)) {
if ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext) ||
has_capability('moodle/user:editprofile', $usercontext)) {
$url = new moodle_url('/user/calendar.php', array('id' => $user->id));
$useraccount->add(get_string('calendarpreferences', 'calendar'), $url, self::TYPE_SETTING, null, 'preferredcalendar');
}
}

// View the roles settings.
if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride', 'moodle/role:override',
'moodle/role:manage'), $usercontext)) {
Expand Down
123 changes: 123 additions & 0 deletions user/calendar.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.

/**
* Allows you to edit a users profile
*
* @copyright 2015 Shamim Rezaie http://foodle.org
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package core_user
*/

require_once('../config.php');
require_once($CFG->dirroot.'/calendar/lib.php');
require_once($CFG->dirroot.'/user/editlib.php');
require_once($CFG->dirroot.'/user/lib.php');

$userid = optional_param('id', $USER->id, PARAM_INT); // User id.

$PAGE->set_url('/user/calendar.php', array('id' => $userid));

list($user, $course) = useredit_setup_preference_page($userid, SITEID);

$defaultlookahead = CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD;
if (isset($CFG->calendar_lookahead)) {
$defaultlookahead = intval($CFG->calendar_lookahead);
}
$defaultmaxevents = CALENDAR_DEFAULT_UPCOMING_MAXEVENTS;
if (isset($CFG->calendar_maxevents)) {
$defaultmaxevents = intval($CFG->calendar_maxevents);
}

// Create form.
$calendarform = new core_user\form\calendar_form(null, array('userid' => $user->id));

$user->timeformat = get_user_preferences('calendar_timeformat', '');
$user->startwday = calendar_get_starting_weekday();
$user->maxevents = get_user_preferences('calendar_maxevents', $defaultmaxevents);
$user->lookahead = get_user_preferences('calendar_lookahead', $defaultlookahead);
$user->persistflt = get_user_preferences('calendar_persistflt', 0);
$calendarform->set_data($user);

$redirect = new moodle_url("/user/preferences.php", array('userid' => $user->id));
if ($calendarform->is_cancelled()) {
redirect($redirect);
} else if ($calendarform->is_submitted() && $calendarform->is_validated() && confirm_sesskey()) {
$data = $calendarform->get_data();

// Time format.
if ($data->timeformat != CALENDAR_TF_12 && $data->timeformat != CALENDAR_TF_24) {
$data->timeformat = '';
}
set_user_preference('calendar_timeformat', $data->timeformat);

// Start weekday.
$data->startwday = intval($data->startwday);
if ($data->startwday < 0 || $data->startwday > 6) {
$data->startwday = abs($data->startwday % 7);
}
set_user_preference('calendar_startwday', $data->startwday);

// Calendar events.
if (intval($data->maxevents) >= 1) {
set_user_preference('calendar_maxevents', $data->maxevents);
}

// Calendar lookahead.
if (intval($data->lookahead) >= 1) {
set_user_preference('calendar_lookahead', $data->lookahead);
}

set_user_preference('calendar_persistflt', intval($data->persistflt));

// Calendar type.
$calendartype = $data->calendartype;
// If the specified calendar type does not exist, use the site default.
if (!array_key_exists($calendartype, \core_calendar\type_factory::get_list_of_calendar_types())) {
$calendartype = $CFG->calendartype;
}

$user->calendartype = $calendartype;
// Update user with new calendar type.
user_update_user($user, false, false);

// Trigger event.
\core\event\user_updated::create_from_userid($user->id)->trigger();

if ($USER->id == $user->id) {
$USER->calendartype = $calendartype;
}

redirect($redirect);
}

// Display page header.
$streditmycalendar = get_string('calendarpreferences', 'calendar');
$userfullname = fullname($user, true);

$PAGE->navbar->includesettingsbase = true;

$PAGE->set_title("$course->shortname: $streditmycalendar");
$PAGE->set_heading($userfullname);

echo $OUTPUT->header();
echo $OUTPUT->heading($streditmycalendar);

// Finally display THE form.
$calendarform->display();

// And proper footer.
echo $OUTPUT->footer();
Loading

0 comments on commit 9629790

Please sign in to comment.