mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-03-14 12:40:01 +01:00
Code Issues Projects Releases Wiki Activity

MDL-57877 mod_data: added action events

Browse Source 
Part of MDL-55611 epic.
This commit is contained in:
Mark Nelson 2017-03-02 13:45:22 +08:00 committed by Damyon Wiese
parent d4718e5ab9
commit 7c6f961bf9
3 changed files with 237 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
mod/data/lib.php
View File

@ -39,6 +39,9 @@ define('DATA_PRESET_COMPONENT', 'mod_data');
define('DATA_PRESET_FILEAREA', 'site_presets');
define('DATA_PRESET_CONTEXT', SYSCONTEXTID);
define('DATA_EVENT_TYPE_OPEN', 'open');
define('DATA_EVENT_TYPE_CLOSE', 'close');
// Users having assigned the default role "Non-editing teacher" can export database records
// Using the mod/data capability "viewalluserpresets" existing in Moodle 1.9.x.
// In Moodle >= 2, new roles may be introduced and used instead.
@ -3272,7 +3275,7 @@ function data_extend_navigation($navigation, $course, $module, $cm) {
$currentgroup = groups_get_activity_group($cm);
$groupmode = groups_get_activity_groupmode($cm);
$numentries = data_numentries($data);
$numentries = data_numentries($data);
$canmanageentries = has_capability('mod/data:manageentries', context_module::instance($cm->id));
if ($data->entriesleft = data_get_entries_left_to_add($data, $numentries, $canmanageentries)) {
@ -4212,3 +4215,47 @@ function data_check_updates_since(cm_info $cm, $from, $filter = array()) {
return $updates;
}
/**
* Is the event visible?
*
* @param \core_calendar\event $event
* @return bool Returns true if the event is visible to the current user, false otherwise.
*/
function mod_data_core_calendar_is_event_visible(\core_calendar\event $event) {
$cm = get_fast_modinfo($event->courseid)->instances['data'][$event->instance];
$context = context_module::instance($cm->id);
return has_capability('mod/data:view', $context);
}
/**
* Handles creating actions for events.
*
* @param \core_calendar\event $event
* @param \core_calendar\action_factory $factory
* @return \core_calendar\local\event\value_objects\action|\core_calendar\local\interfaces\action_interface|null
*/
function mod_data_core_calendar_provide_event_action(\core_calendar\event $event,
\core_calendar\action_factory $factory) {
global $DB;
$cm = get_fast_modinfo($event->courseid)->instances['data'][$event->instance];
$data = $DB->get_record('data', array('id' => $event->instance), 'id, timeavailablefrom, timeavailableto');
if ($data->timeavailablefrom && $data->timeavailableto) {
$actionable = (time() >= $data->timeavailablefrom) && (time() <= $data->timeavailableto);
} else if ($data->timeavailableto) {
$actionable = time() < $data->timeavailableto;
} else if ($data->timeavailablefrom) {
$actionable = time() >= $data->timeavailablefrom;
} else {
$actionable = true;
}
return $factory->create_instance(
get_string('add', 'data'),
new \moodle_url('/mod/data/view.php', array('id' => $cm->id)),
1,
$actionable
);
}

16
mod/data/locallib.php
View File

@ -599,13 +599,17 @@ function data_set_events($data) {
}
// Data start calendar events.
$event = new stdClass();
$event->eventtype = DATA_EVENT_TYPE_OPEN;
// The DATA_EVENT_TYPE_OPEN event should only be an action event if no close time was specified.
$event->type = empty($data->timeavailableto) ? CALENDAR_EVENT_TYPE_ACTION : CALENDAR_EVENT_TYPE_STANDARD;
if ($event->id = $DB->get_field('event', 'id',
array('modulename' => 'data', 'instance' => $data->id, 'eventtype' => 'open'))) {
array('modulename' => 'data', 'instance' => $data->id, 'eventtype' => $event->eventtype))) {
if ($data->timeavailablefrom > 0) {
// Calendar event exists so update it.
$event->name = get_string('calendarstart', 'data', $data->name);
$event->description = format_module_intro('data', $data, $data->coursemodule);
$event->timestart = $data->timeavailablefrom;
$event->timesort = $data->timeavailablefrom;
$event->visible = instance_is_visible('data', $data);
$event->timeduration = 0;
$calendarevent = \core_calendar\event::load($event->id);
@ -625,8 +629,8 @@ function data_set_events($data) {
$event->userid = 0;
$event->modulename = 'data';
$event->instance = $data->id;
$event->eventtype = 'open';
$event->timestart = $data->timeavailablefrom;
$event->timesort = $data->timeavailablefrom;
$event->visible = instance_is_visible('data', $data);
$event->timeduration = 0;
\core_calendar\event::create($event);
@ -635,13 +639,16 @@ function data_set_events($data) {
// Data end calendar events.
$event = new stdClass();
$event->type = CALENDAR_EVENT_TYPE_ACTION;
$event->eventtype = DATA_EVENT_TYPE_CLOSE;
if ($event->id = $DB->get_field('event', 'id',
array('modulename' => 'data', 'instance' => $data->id, 'eventtype' => 'close'))) {
array('modulename' => 'data', 'instance' => $data->id, 'eventtype' => $event->eventtype))) {
if ($data->timeavailableto > 0) {
// Calendar event exists so update it.
$event->name = get_string('calendarend', 'data', $data->name);
$event->description = format_module_intro('data', $data, $data->coursemodule);
$event->timestart = $data->timeavailableto;
$event->timesort = $data->timeavailableto;
$event->visible = instance_is_visible('data', $data);
$event->timeduration = 0;
$calendarevent = \core_calendar\event::load($event->id);
@ -654,7 +661,6 @@ function data_set_events($data) {
} else {
// Event doesn't exist so create one.
if (isset($data->timeavailableto) && $data->timeavailableto > 0) {
$event = new stdClass();
$event->name = get_string('calendarend', 'data', $data->name);
$event->description = format_module_intro('data', $data, $data->coursemodule);
$event->courseid = $data->course;
@ -662,8 +668,8 @@ function data_set_events($data) {
$event->userid = 0;
$event->modulename = 'data';
$event->instance = $data->id;
$event->eventtype = 'close';
$event->timestart = $data->timeavailableto;
$event->timesort = $data->timeavailableto;
$event->visible = instance_is_visible('data', $data);
$event->timeduration = 0;
\core_calendar\event::create($event);

178
mod/data/tests/lib_test.php
View File

@ -994,4 +994,182 @@ class mod_data_lib_testcase extends advanced_testcase {
$this->assertTrue($updates->entries->updated);
$this->assertEquals([$datarecor1did, $datarecor2did], $updates->entries->itemids, '', 0, 10, true);
}
public function test_data_core_calendar_is_event_visible() {
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a database activity.
$data = $this->getDataGenerator()->create_module('data', array('course' => $course->id));
// Create a calendar event.
$event = $this->create_action_event($course->id, $data->id, DATA_EVENT_TYPE_OPEN);
// Check that we can see the event.
$this->assertTrue(mod_data_core_calendar_is_event_visible($event));
}
public function test_data_core_calendar_is_event_visible_as_non_user() {
global $CFG;
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a database activity.
$data = $this->getDataGenerator()->create_module('data', array('course' => $course->id));
// Create a calendar event.
$event = $this->create_action_event($course->id, $data->id, DATA_EVENT_TYPE_OPEN);
// Log out the user and set force login to true.
\core\session\manager::init_empty_session();
$CFG->forcelogin = true;
// Check that we can't see the event.
$this->assertFalse(mod_data_core_calendar_is_event_visible($event));
}
public function test_data_core_calendar_provide_event_action_open() {
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a database activity.
$data = $this->getDataGenerator()->create_module('data', array('course' => $course->id,
'timeavailablefrom' => time() - DAYSECS, 'timeavailableto' => time() + DAYSECS));
// Create a calendar event.
$event = $this->create_action_event($course->id, $data->id, DATA_EVENT_TYPE_OPEN);
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event.
$actionevent = mod_data_core_calendar_provide_event_action($event, $factory);
// Confirm the event was decorated.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent);
$this->assertEquals(get_string('add', 'data'), $actionevent->get_name());
$this->assertInstanceOf('moodle_url', $actionevent->get_url());
$this->assertEquals(1, $actionevent->get_item_count());
$this->assertTrue($actionevent->is_actionable());
}
public function test_data_core_calendar_provide_event_action_closed() {
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a database activity.
$data = $this->getDataGenerator()->create_module('data', array('course' => $course->id,
'timeavailableto' => time() - DAYSECS));
// Create a calendar event.
$event = $this->create_action_event($course->id, $data->id, DATA_EVENT_TYPE_OPEN);
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event.
$actionevent = mod_data_core_calendar_provide_event_action($event, $factory);
// Confirm the event was decorated.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent);
$this->assertEquals(get_string('add', 'data'), $actionevent->get_name());
$this->assertInstanceOf('moodle_url', $actionevent->get_url());
$this->assertEquals(1, $actionevent->get_item_count());
$this->assertFalse($actionevent->is_actionable());
}
public function test_data_core_calendar_provide_event_action_open_in_future() {
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a database activity.
$data = $this->getDataGenerator()->create_module('data', array('course' => $course->id,
'timeavailablefrom' => time() + DAYSECS));
// Create a calendar event.
$event = $this->create_action_event($course->id, $data->id, DATA_EVENT_TYPE_OPEN);
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event.
$actionevent = mod_data_core_calendar_provide_event_action($event, $factory);
// Confirm the event was decorated.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent);
$this->assertEquals(get_string('add', 'data'), $actionevent->get_name());
$this->assertInstanceOf('moodle_url', $actionevent->get_url());
$this->assertEquals(1, $actionevent->get_item_count());
$this->assertFalse($actionevent->is_actionable());
}
public function test_data_core_calendar_provide_event_action_no_time_specified() {
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a database activity.
$data = $this->getDataGenerator()->create_module('data', array('course' => $course->id));
// Create a calendar event.
$event = $this->create_action_event($course->id, $data->id, DATA_EVENT_TYPE_OPEN);
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event.
$actionevent = mod_data_core_calendar_provide_event_action($event, $factory);
// Confirm the event was decorated.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent);
$this->assertEquals(get_string('add', 'data'), $actionevent->get_name());
$this->assertInstanceOf('moodle_url', $actionevent->get_url());
$this->assertEquals(1, $actionevent->get_item_count());
$this->assertTrue($actionevent->is_actionable());
}
/**
* Creates an action event.
*
* @param int $courseid
* @param int $instanceid The data id.
* @param string $eventtype The event type. eg. DATA_EVENT_TYPE_OPEN.
* @return bool|\core_calendar\event
*/
private function create_action_event($courseid, $instanceid, $eventtype) {
$event = new stdClass();
$event->name = 'Calendar event';
$event->modulename = 'data';
$event->courseid = $courseid;
$event->instance = $instanceid;
$event->type = CALENDAR_EVENT_TYPE_ACTION;
$event->eventtype = $eventtype;
$event->timestart = time();
return \core_calendar\event::create($event);
}
}