mirrored from git://git.moodle.org/moodle.git
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-50015 mod_imscp: New WS mod_imscp_view_imscp
- Loading branch information
Showing
6 changed files
with
261 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
<?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/>. | ||
|
||
/** | ||
* IMSCP external API | ||
* | ||
* @package mod_imscp | ||
* @category external | ||
* @copyright 2015 Juan Leyva <juan@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
* @since Moodle 3.0 | ||
*/ | ||
|
||
defined('MOODLE_INTERNAL') || die; | ||
|
||
require_once("$CFG->libdir/externallib.php"); | ||
|
||
/** | ||
* IMSCP external functions | ||
* | ||
* @package mod_imscp | ||
* @category external | ||
* @copyright 2015 Juan Leyva <juan@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
* @since Moodle 3.0 | ||
*/ | ||
class mod_imscp_external extends external_api { | ||
|
||
/** | ||
* Returns description of method parameters | ||
* | ||
* @return external_function_parameters | ||
* @since Moodle 3.0 | ||
*/ | ||
public static function view_imscp_parameters() { | ||
return new external_function_parameters( | ||
array( | ||
'imscpid' => new external_value(PARAM_INT, 'imscp instance id') | ||
) | ||
); | ||
} | ||
|
||
/** | ||
* Simulate the imscp/view.php web interface page: trigger events, completion, etc... | ||
* | ||
* @param int $imscpid the imscp instance id | ||
* @return array of warnings and status result | ||
* @since Moodle 3.0 | ||
* @throws moodle_exception | ||
*/ | ||
public static function view_imscp($imscpid) { | ||
global $DB, $CFG; | ||
require_once($CFG->dirroot . "/mod/imscp/lib.php"); | ||
|
||
$params = self::validate_parameters(self::view_imscp_parameters(), | ||
array( | ||
'imscpid' => $imscpid | ||
)); | ||
$warnings = array(); | ||
|
||
// Request and permission validation. | ||
$imscp = $DB->get_record('imscp', array('id' => $params['imscpid']), '*', MUST_EXIST); | ||
list($course, $cm) = get_course_and_cm_from_instance($imscp, 'imscp'); | ||
|
||
$context = context_module::instance($cm->id); | ||
self::validate_context($context); | ||
|
||
require_capability('mod/imscp:view', $context); | ||
|
||
// Call the imscp/lib API. | ||
imscp_view($imscp, $course, $cm, $context); | ||
|
||
$result = array(); | ||
$result['status'] = true; | ||
$result['warnings'] = $warnings; | ||
return $result; | ||
} | ||
|
||
/** | ||
* Returns description of method result value | ||
* | ||
* @return external_description | ||
* @since Moodle 3.0 | ||
*/ | ||
public static function view_imscp_returns() { | ||
return new external_single_structure( | ||
array( | ||
'status' => new external_value(PARAM_BOOL, 'status: true if success'), | ||
'warnings' => new external_warnings() | ||
) | ||
); | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
<?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/>. | ||
|
||
/** | ||
* IMSCP external functions and service definitions. | ||
* | ||
* @package mod_imscp | ||
* @category external | ||
* @copyright 2015 Juan Leyva <juan@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
* @since Moodle 3.0 | ||
*/ | ||
|
||
defined('MOODLE_INTERNAL') || die; | ||
|
||
$functions = array( | ||
|
||
'mod_imscp_view_imscp' => array( | ||
'classname' => 'mod_imscp_external', | ||
'methodname' => 'view_imscp', | ||
'description' => 'Simulate the view.php web interface imscp: trigger events, completion, etc...', | ||
'type' => 'write', | ||
'capabilities' => 'mod/imscp:view' | ||
), | ||
|
||
); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
<?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/>. | ||
|
||
/** | ||
* External mod_imscp functions unit tests | ||
* | ||
* @package mod_imscp | ||
* @category external | ||
* @copyright 2015 Juan Leyva <juan@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
* @since Moodle 3.0 | ||
*/ | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
global $CFG; | ||
|
||
require_once($CFG->dirroot . '/webservice/tests/helpers.php'); | ||
|
||
/** | ||
* External mod_imscp functions unit tests | ||
* | ||
* @package mod_imscp | ||
* @category external | ||
* @copyright 2015 Juan Leyva <juan@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
* @since Moodle 3.0 | ||
*/ | ||
class mod_imscp_external_testcase extends externallib_advanced_testcase { | ||
|
||
/** | ||
* Test view_imscp | ||
*/ | ||
public function test_view_imscp() { | ||
global $DB; | ||
|
||
$this->resetAfterTest(true); | ||
|
||
$this->setAdminUser(); | ||
// Setup test data. | ||
$course = $this->getDataGenerator()->create_course(); | ||
$imscp = $this->getDataGenerator()->create_module('imscp', array('course' => $course->id)); | ||
$context = context_module::instance($imscp->cmid); | ||
$cm = get_coursemodule_from_instance('imscp', $imscp->id); | ||
|
||
// Test invalid instance id. | ||
try { | ||
mod_imscp_external::view_imscp(0); | ||
$this->fail('Exception expected due to invalid mod_imscp instance id.'); | ||
} catch (moodle_exception $e) { | ||
$this->assertEquals('invalidrecord', $e->errorcode); | ||
} | ||
|
||
// Test not-enrolled user. | ||
$user = self::getDataGenerator()->create_user(); | ||
$this->setUser($user); | ||
try { | ||
mod_imscp_external::view_imscp($imscp->id); | ||
$this->fail('Exception expected due to not enrolled user.'); | ||
} catch (moodle_exception $e) { | ||
$this->assertEquals('requireloginerror', $e->errorcode); | ||
} | ||
|
||
// Test user with full capabilities. | ||
$studentrole = $DB->get_record('role', array('shortname' => 'student')); | ||
$this->getDataGenerator()->enrol_user($user->id, $course->id, $studentrole->id); | ||
|
||
// Trigger and capture the event. | ||
$sink = $this->redirectEvents(); | ||
|
||
$result = mod_imscp_external::view_imscp($imscp->id); | ||
$result = external_api::clean_returnvalue(mod_imscp_external::view_imscp_returns(), $result); | ||
|
||
$events = $sink->get_events(); | ||
$this->assertCount(1, $events); | ||
$event = array_shift($events); | ||
|
||
// Checking that the event contains the expected values. | ||
$this->assertInstanceOf('\mod_imscp\event\course_module_viewed', $event); | ||
$this->assertEquals($context, $event->get_context()); | ||
$moodleurl = new \moodle_url('/mod/imscp/view.php', array('id' => $cm->id)); | ||
$this->assertEquals($moodleurl, $event->get_url()); | ||
$this->assertEventContextNotUsed($event); | ||
$this->assertNotEmpty($event->get_name()); | ||
|
||
// Test user with no capabilities. | ||
// We need a explicit prohibit since this capability is only defined in authenticated user and guest roles. | ||
assign_capability('mod/imscp:view', CAP_PROHIBIT, $studentrole->id, $context->id); | ||
accesslib_clear_all_caches_for_unit_testing(); | ||
|
||
try { | ||
mod_imscp_external::view_imscp($imscp->id); | ||
$this->fail('Exception expected due to missing capability.'); | ||
} catch (moodle_exception $e) { | ||
$this->assertEquals('nopermissions', $e->errorcode); | ||
} | ||
|
||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters