moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-08 02:16:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'MDL-73239-master' of https://github.com/rmady/moodle

Browse source
This commit is contained in:
Andrew Nicols 2023-07-09 22:02:22 +08:00
commit c472ba4738
No known key found for this signature in database
GPG key ID: 6D1E3157C8CFBF14
3 changed files with 199 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
lib/db/services.php
View file

@ -1544,6 +1544,13 @@ $functions = array(
'type' => 'read',
'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE],
],
'core_my_view_page' => [
'classname' => '\core_my\external\view_page',
'methodname' => 'execute',
'description' => 'Trigger the My or Dashboard viewed event.',
'type' => 'write',
'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE],
],
'core_notes_create_notes' => array(
'classname' => 'core_notes_external',
'methodname' => 'create_notes',

103
my/classes/external/view_page.php vendored Normal file
View file

@ -0,0 +1,103 @@
<?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/>.
namespace core_my\external;
use core_external\external_api;
use core_external\external_function_parameters;
use core_external\external_single_structure;
use core_external\external_value;
use core_external\external_warnings;
defined('MOODLE_INTERNAL') || die();
global $CFG;
/**
* External service to log viewed Dashboard and My pages.
*
* This is mainly used by the mobile application.
*
* @package core_my
* @category external
* @copyright 2023 Rodrigo Mady <rodrigo.mady@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 4.3
*/
class view_page extends external_api {
/**
* Returns description of method parameters
*
* @return external_function_parameters
*/
public static function execute_parameters(): external_function_parameters {
return new external_function_parameters([
'page' => new external_value(PARAM_TEXT, 'My page to trigger a view event'),
]);
}
/**
* Execute the My or Dashboard view event.
*
* @param string $page the page for trigger the event.
* @return array
*/
public static function execute(string $page): array {
$warnings = [];
$status = true;
// Validate the cmid ID.
['page' => $page] = self::validate_parameters(
self::execute_parameters(), ['page' => $page]
);
if ($page === 'my') {
$eventname = '\core\event\mycourses_viewed';
} else if ($page === 'dashboard') {
$eventname = '\core\event\dashboard_viewed';
} else {
$status = false;
$warnings[] = [
'item' => $page,
'warningcode' => 'invalidmypage',
'message' => 'The value for the page request is invalid!'
];
}
// Trigger my/dashboard view event.
$context = \context_system::instance();
self::validate_context($context);
if ($status) {
$event = $eventname::create(['context' => $context]);
$event->trigger();
}
$result = [
'status' => $status,
'warnings' => $warnings
];
return $result;
}
/**
* Describe the return structure of the external service.
*
* @return external_single_structure
*/
public static function execute_returns(): external_single_structure {
return new external_single_structure([
'status' => new external_value(PARAM_BOOL, 'status: true if success'),
'warnings' => new external_warnings()
]);
}
}

89
my/tests/external/view_page_test.php vendored Normal file
View file

@ -0,0 +1,89 @@
<?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/>.
namespace core_my\external;
use externallib_advanced_testcase;
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->dirroot . '/webservice/tests/helpers.php');
/**
* Test Class for external function core_my_view_page.
*
* @package core_my
* @category external
* @copyright 2023 Rodrigo Mady <rodrigo.mady@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 4.3
*/
class view_page_test extends externallib_advanced_testcase {
/**
* Set up for every test.
*/
public function setUp(): void {
$this->resetAfterTest();
}
/**
* Helper.
*
* @param string $page
* @return array
*/
protected function view_page(string $page): array {
$result = view_page::execute($page);
return \core_external\external_api::clean_returnvalue(view_page::execute_returns(), $result);
}
/**
* Test for webservice my view page.
* @covers ::core_my_view_page
*/
public function test_view_page(): void {
$user = $this->getDataGenerator()->create_user();
$this->setUser($user);
// Trigger and capture the event.
$sink = $this->redirectEvents();
// Request to trigger the view event in my.
$result = $this->view_page('my');
$this->assertTrue($result['status']);
$this->assertEmpty($result['warnings']);
// Request to trigger the view event in dashboard.
$result = $this->view_page('dashboard');
$this->assertTrue($result['status']);
$this->assertEmpty($result['warnings']);
// Wrong page to trigger the event.
$result = $this->view_page('test');
$this->assertFalse($result['status']);
$this->assertNotEmpty($result['warnings']);
$events = $sink->get_events();
// Check if the log still with two rows.
$this->assertCount(2, $events);
$this->assertInstanceOf('\core\event\mycourses_viewed', $events[0]);
$this->assertInstanceOf('\core\event\dashboard_viewed', $events[1]);
$sink->close();
}
}