mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-17 21:49:15 +01:00
Code Issues Projects Releases Wiki Activity

MDL-65978 blog: New WS core_blog_get_access_information

Browse Source
This commit is contained in:
Juan Leyva 2023-12-14 12:31:48 +01:00
parent 98daf57a8d
commit b6b2077e60
3 changed files with 126 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
blog/classes/external/get_access_information.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_blog\external;
use context_system;
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;
/**
* External blog API implementation
*
* @package core_blog
* @copyright 2024 Juan Leyva <juan@moodle.com>
* @category external
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class get_access_information extends external_api {
/**
* Returns description of method parameters.
*
* @return external_function_parameters.
* @since Moodle 4.4
*/
public static function execute_parameters(): external_function_parameters {
return new external_function_parameters([]);
}
/**
* Convenience function to retrieve some permissions information for the blogs system.
*
* @return array The access information
* @since Moodle 4.4
*/
public static function execute(): array {
$context = context_system::instance();
self::validate_context($context);
return [
'canview' => has_capability('moodle/blog:view', $context),
'cansearch' => has_capability('moodle/blog:search', $context),
'canviewdrafts' => has_capability('moodle/blog:viewdrafts', $context),
'cancreate' => has_capability('moodle/blog:create', $context),
'canmanageentries' => has_capability('moodle/blog:manageentries', $context),
'canmanageexternal' => has_capability('moodle/blog:manageexternal', $context),
'warnings' => [],
];
}
/**
* Returns description of method result value.
*
* @return external_single_structure.
* @since Moodle 4.4
*/
public static function execute_returns(): external_single_structure {
return new external_single_structure(
[
'canview' => new external_value(PARAM_BOOL, 'Whether the user can view blogs'),
'cansearch' => new external_value(PARAM_BOOL, 'Whether the user can search blogs'),
'canviewdrafts' => new external_value(PARAM_BOOL, 'Whether the user can view drafts'),
'cancreate' => new external_value(PARAM_BOOL, 'Whether the user can create blog entries'),
'canmanageentries' => new external_value(PARAM_BOOL, 'Whether the user can manage blog entries'),
'canmanageexternal' => new external_value(PARAM_BOOL, 'Whether the user can manage external blogs'),
'warnings' => new external_warnings(),
]
);
}
}

31
blog/tests/external/external_test.php vendored
View File

@ -641,4 +641,35 @@ class external_test extends \advanced_testcase {
$this->assertEventContextNotUsed($event);
$this->assertNotEmpty($event->get_name());
}
/**
* Test get_access_information
*/
public function test_get_access_information() {
global $CFG;
$this->setAdminUser();
$result = get_access_information::execute();
$result = external_api::clean_returnvalue(get_access_information::execute_returns(), $result);
$this->assertTrue($result['canview']);
$this->assertTrue($result['cansearch']);
$this->assertTrue($result['canviewdrafts']);
$this->assertTrue($result['cancreate']);
$this->assertTrue($result['canmanageentries']);
$this->assertTrue($result['canmanageexternal']);
$this->assertEmpty($result['warnings']);
$this->setUser($this->userid);
$result = get_access_information::execute();
$result = external_api::clean_returnvalue(get_access_information::execute_returns(), $result);
$this->assertTrue($result['canview']);
$this->assertTrue($result['cansearch']);
$this->assertFalse($result['canviewdrafts']);
$this->assertTrue($result['cancreate']);
$this->assertFalse($result['canmanageentries']);
$this->assertTrue($result['canmanageexternal']);
$this->assertEmpty($result['warnings']);
}
}

6
lib/db/services.php
View File

@ -151,6 +151,12 @@ $functions = array(
'ajax' => true,
'loginrequired' => false,
),
'core_blog_get_access_information' => [
'classname' => '\core_blog\external\get_access_information',
'description' => 'Retrieves permission information for the current user.',
'type' => 'read',
'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE],
],
'core_calendar_get_calendar_monthly_view' => array(
'classname' => 'core_calendar_external',
'methodname' => 'get_calendar_monthly_view',