mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-20 07:56:06 +02:00
Code Issues Projects Releases Wiki Activity

MDL-57916 mod_data: New WS mod_data_get_access_information

Browse Source
This commit is contained in:
Juan Leyva 2017-02-09 16:38:51 +01:00
parent a99c13af84
commit cac43b9b6a
3 changed files with 187 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

131
mod/data/classes/external.php
View File

@ -150,6 +150,27 @@ class mod_data_external extends external_api {
);
}
/**
* Utility function for validating a database.
*
* @param int $databaseid database instance id
* @return array array containing the database object, course, context and course module objects
* @since Moodle 3.3
*/
protected static function validate_database($databaseid) {
global $DB;
// Request and permission validation.
$database = $DB->get_record('data', array('id' => $databaseid), '*', MUST_EXIST);
list($course, $cm) = get_course_and_cm_from_instance($database, 'data');
$context = context_module::instance($cm->id);
self::validate_context($context);
require_capability('mod/data:viewentry', $context);
return array($database, $course, $cm, $context);
}
/**
* Returns description of method parameters
*
@ -173,22 +194,14 @@ class mod_data_external extends external_api {
* @throws moodle_exception
*/
public static function view_database($databaseid) {
global $DB;
$params = self::validate_parameters(self::view_database_parameters(), array('databaseid' => $databaseid));
$warnings = array();
// Request and permission validation.
$data = $DB->get_record('data', array('id' => $params['databaseid']), '*', MUST_EXIST);
list($course, $cm) = get_course_and_cm_from_instance($data, 'data');
$context = context_module::instance($cm->id);
self::validate_context($context);
require_capability('mod/data:viewentry', $context);
list($database, $course, $cm, $context) = self::validate_database($params['databaseid']);
// Call the data/lib API.
data_view($data, $course, $cm, $context);
data_view($database, $course, $cm, $context);
$result = array();
$result['status'] = true;
@ -211,4 +224,102 @@ class mod_data_external extends external_api {
);
}
/**
* Returns description of method parameters.
*
* @return external_function_parameters
* @since Moodle 3.3
*/
public static function get_data_access_information_parameters() {
return new external_function_parameters(
array(
'databaseid' => new external_value(PARAM_INT, 'Database instance id.'),
'groupid' => new external_value(PARAM_INT, 'Group id, 0 means that the function will determine the user group.',
VALUE_DEFAULT, 0),
)
);
}
/**
* Return access information for a given database.
*
* @param int $databaseid the database instance id
* @param int $groupid (optional) group id, 0 means that the function will determine the user group
* @return array of warnings and access information
* @since Moodle 3.3
* @throws moodle_exception
*/
public static function get_data_access_information($databaseid, $groupid = 0) {
$params = array('databaseid' => $databaseid, 'groupid' => $groupid);
$params = self::validate_parameters(self::get_data_access_information_parameters(), $params);
$warnings = array();
list($database, $course, $cm, $context) = self::validate_database($params['databaseid']);
$result = array(
'warnings' => $warnings
);
$groupmode = groups_get_activity_groupmode($cm);
if (!empty($params['groupid'])) {
$groupid = $params['groupid'];
// Determine is the group is visible to user.
if (!groups_group_visible($groupid, $course, $cm)) {
throw new moodle_exception('notingroup');
}
} else {
// Check to see if groups are being used here.
if ($groupmode) {
$groupid = groups_get_activity_group($cm);
// Determine is the group is visible to user (this is particullary for the group 0 -> all groups).
if (!groups_group_visible($groupid, $course, $cm)) {
throw new moodle_exception('notingroup');
}
} else {
$groupid = 0;
}
}
// Group related information.
$result['groupid'] = $groupid;
$result['canaddentry'] = data_user_can_add_entry($database, $groupid, $groupmode, $context);
// Now capabilities.
$result['canmanageentries'] = has_capability('mod/data:manageentries', $context);
$result['canapprove'] = has_capability('mod/data:approve', $context);
// Now time access restrictions.
list($result['timeavailable'], $warnings) = data_get_time_availability_status($database, $result['canmanageentries']);
// Other information.
$result['numentries'] = data_numentries($database);
$result['entrieslefttoadd'] = data_get_entries_left_to_add($database, $result['numentries'], $result['canmanageentries']);
$result['entrieslefttoview'] = data_get_entries_left_to_view($database, $result['numentries'], $result['canmanageentries']);
$result['inreadonlyperiod'] = data_in_readonly_period($database);
return $result;
}
/**
* Returns description of method result value.
*
* @return external_description
* @since Moodle 3.3
*/
public static function get_data_access_information_returns() {
return new external_single_structure(
array(
'groupid' => new external_value(PARAM_INT, 'User current group id (calculated)'),
'canaddentry' => new external_value(PARAM_BOOL, 'Whether the user can add entries or not.'),
'canmanageentries' => new external_value(PARAM_BOOL, 'Whether the user can manage entries or not.'),
'canapprove' => new external_value(PARAM_BOOL, 'Whether the user can approve entries or not.'),
'timeavailable' => new external_value(PARAM_BOOL, 'Whether the database is available or not by time restrictions.'),
'inreadonlyperiod' => new external_value(PARAM_BOOL, 'Whether the database is in read mode only.'),
'numentries' => new external_value(PARAM_INT, 'The number of entries the current user added.'),
'entrieslefttoadd' => new external_value(PARAM_INT, 'The number of entries left to complete the activity.'),
'entrieslefttoview' => new external_value(PARAM_INT, 'The number of entries left to view other users entries.'),
'warnings' => new external_warnings()
)
);
}
}

8
mod/data/db/services.php
View File

@ -43,4 +43,12 @@ $functions = array(
'capabilities' => 'mod/data:viewentry',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_data_get_data_access_information' => array(
'classname' => 'mod_data_external',
'methodname' => 'get_data_access_information',
'description' => 'Return access information for a given database.',
'type' => 'read',
'capabilities' => 'mod/data:viewentry',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
);

58
mod/data/tests/externallib_test.php
View File

@ -257,4 +257,62 @@ class mod_data_external_testcase extends externallib_advanced_testcase {
$this->assertEventContextNotUsed($event);
$this->assertNotEmpty($event->get_name());
}
/**
* Test get_data_access_information for student.
*/
public function test_get_data_access_information_student() {
global $DB;
// Modify the database to add access restrictions.
$this->data->timeavailablefrom = time() + DAYSECS;
$this->data->requiredentries = 2;
$this->data->requiredentriestoview = 2;
$DB->update_record('data', $this->data);
// Test user with full capabilities.
$this->setUser($this->student1);
$result = mod_data_external::get_data_access_information($this->data->id);
$result = external_api::clean_returnvalue(mod_data_external::get_data_access_information_returns(), $result);
$this->assertEquals(0, $result['groupid']);
$this->assertFalse($result['canmanageentries']);
$this->assertFalse($result['canapprove']);
$this->assertTrue($result['canaddentry']); // It return true because it doen't check time restrictions.
$this->assertFalse($result['timeavailable']);
$this->assertFalse($result['inreadonlyperiod']);
$this->assertEquals(0, $result['numentries']);
$this->assertEquals($this->data->requiredentries, $result['entrieslefttoadd']);
$this->assertEquals($this->data->requiredentriestoview, $result['entrieslefttoview']);
}
/**
* Test get_data_access_information for teacher.
*/
public function test_get_data_access_information_teacher() {
global $DB;
// Modify the database to add access restrictions.
$this->data->timeavailablefrom = time() + DAYSECS;
$this->data->requiredentries = 2;
$this->data->requiredentriestoview = 2;
$DB->update_record('data', $this->data);
// Test user with full capabilities.
$this->setUser($this->teacher);
$result = mod_data_external::get_data_access_information($this->data->id);
$result = external_api::clean_returnvalue(mod_data_external::get_data_access_information_returns(), $result);
$this->assertEquals(0, $result['groupid']);
$this->assertTrue($result['canmanageentries']);
$this->assertTrue($result['canapprove']);
$this->assertTrue($result['canaddentry']); // It return true because it doen't check time restrictions.
$this->assertTrue($result['timeavailable']);
$this->assertFalse($result['inreadonlyperiod']);
$this->assertEquals(0, $result['numentries']);
$this->assertEquals(0, $result['entrieslefttoadd']);
$this->assertEquals(0, $result['entrieslefttoview']);
}
}