Commit 66ef16d3 authored by Juan Leyva's avatar Juan Leyva
Browse files

MDL-58713 filters: New WS core_filters_get_available_in_context

parent dc78f150
<?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/>.
/**
* This is the external API for the filter component.
*
* @package core_filters
* @copyright 2017 Juan Leyva
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core_filters;
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir . '/externallib.php');
require_once($CFG->libdir . '/filterlib.php');
use external_api;
use external_function_parameters;
use external_value;
use external_single_structure;
use external_multiple_structure;
use external_warnings;
use Exception;
/**
* This is the external API for the filter component.
*
* @copyright 2017 Juan Leyva
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class external extends external_api {
/**
* Returns description of get_available_in_context() parameters.
*
* @return external_function_parameters
* @since Moodle 3.4
*/
public static function get_available_in_context_parameters() {
return new external_function_parameters (
array(
'contexts' => new external_multiple_structure(
new external_single_structure(
array(
'contextlevel' => new external_value(PARAM_ALPHA, 'The context level where the filters are:
(coursecat, course, module)'),
'instanceid' => new external_value(PARAM_INT, 'The instance id of item associated with the context.')
)
), 'The list of contexts to check.'
),
)
);
}
/**
* Returns the filters available in the given contexts.
*
* @param array $contexts the list of contexts to check
* @return array with the filters information and warnings
* @since Moodle 3.4
*/
public static function get_available_in_context($contexts) {
$params = self::validate_parameters(self::get_available_in_context_parameters(), array('contexts' => $contexts));
$filters = $warnings = array();
foreach ($params['contexts'] as $contextinfo) {
try {
$context = self::get_context_from_params($contextinfo);
self::validate_context($context);
$contextinfo['contextid'] = $context->id;
} catch (Exception $e) {
$warnings[] = array(
'item' => 'context',
'itemid' => $context['instanceid'],
'warningcode' => $e->getCode(),
'message' => $e->getMessage(),
);
continue;
}
$contextfilters = filter_get_available_in_context($context);
foreach ($contextfilters as $filter) {
$filters[] = array_merge($contextinfo, (array) $filter);
}
}
return array(
'filters' => $filters,
'warnings' => $warnings,
);
}
/**
* Returns description of get_available_in_context() result value.
*
* @return external_single_structure
* @since Moodle 3.4
*/
public static function get_available_in_context_returns() {
return new external_single_structure(
array(
'filters' => new external_multiple_structure(
new external_single_structure(
array(
'contextlevel' => new external_value(PARAM_ALPHA, 'The context level where the filters are:
(coursecat, course, module).'),
'instanceid' => new external_value(PARAM_INT, 'The instance id of item associated with the context.'),
'contextid' => new external_value(PARAM_INT, 'The context id.'),
'filter' => new external_value(PARAM_PLUGIN, 'Filter plugin name.'),
'localstate' => new external_value(PARAM_INT, 'Filter state: 1 for on, -1 for off, 0 if inherit.'),
'inheritedstate' => new external_value(PARAM_INT, '1 or 0 to use when localstate is set to inherit.'),
)
),
'Available filters'
),
'warnings' => new external_warnings(),
)
);
}
}
<?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 filter functions unit tests.
*
* @package core_filters
* @category external
* @copyright 2017 Juan Leyva
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.4
*/
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->dirroot . '/webservice/tests/helpers.php');
use core_filters\external;
/**
* External filter functions unit tests.
*
* @package core_filters
* @category external
* @copyright 2017 Juan Leyva
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.4
*/
class core_filter_external_testcase extends externallib_advanced_testcase {
/**
* Test get_available_in_context_system
*/
public function test_get_available_in_context_system() {
global $DB;
$this->resetAfterTest(true);
$this->setAdminUser();
$this->expectException('moodle_exception');
external::get_available_in_context(array(array('contextlevel' => 'system', 'instanceid' => 0)));
}
/**
* Test get_available_in_context_category
*/
public function test_get_available_in_context_category() {
global $DB;
$this->resetAfterTest(true);
$this->setAdminUser();
$category = self::getDataGenerator()->create_category();
// Get all filters and disable them all globally.
$allfilters = filter_get_all_installed();
foreach ($allfilters as $filter => $filtername) {
filter_set_global_state($filter, TEXTFILTER_DISABLED);
}
$result = external::get_available_in_context(array(array('contextlevel' => 'coursecat', 'instanceid' => $category->id)));
$result = external_api::clean_returnvalue(external::get_available_in_context_returns(), $result);
$this->assertEmpty($result['filters']); // No filters, all disabled.
$this->assertEmpty($result['warnings']);
// Enable one filter at global level.
reset($allfilters);
$firstfilter = key($allfilters);
filter_set_global_state($firstfilter, TEXTFILTER_ON);
$result = external::get_available_in_context(array(array('contextlevel' => 'coursecat', 'instanceid' => $category->id)));
$result = external_api::clean_returnvalue(external::get_available_in_context_returns(), $result);
$this->assertEmpty($result['warnings']);
$this->assertEquals($firstfilter, $result['filters'][0]['filter']); // OK, the filter is enabled.
$this->assertEquals(TEXTFILTER_INHERIT, $result['filters'][0]['localstate']); // Inherits the parent context status.
$this->assertEquals(TEXTFILTER_ON, $result['filters'][0]['inheritedstate']); // In the parent context is available.
// Set off the same filter at local context level.
filter_set_local_state($firstfilter, context_coursecat::instance($category->id)->id, TEXTFILTER_OFF);
$result = external::get_available_in_context(array(array('contextlevel' => 'coursecat', 'instanceid' => $category->id)));
$result = external_api::clean_returnvalue(external::get_available_in_context_returns(), $result);
$this->assertEmpty($result['warnings']);
$this->assertEquals($firstfilter, $result['filters'][0]['filter']); // OK, the filter is enabled globally.
$this->assertEquals(TEXTFILTER_OFF, $result['filters'][0]['localstate']); // It is not available in this context.
$this->assertEquals(TEXTFILTER_ON, $result['filters'][0]['inheritedstate']); // In the parent context is available.
}
/**
* Test get_available_in_context_course
*/
public function test_get_available_in_context_course() {
global $DB;
$this->resetAfterTest(true);
$this->setAdminUser();
$course = self::getDataGenerator()->create_course();
// Get all filters and disable them all globally.
$allfilters = filter_get_all_installed();
foreach ($allfilters as $filter => $filtername) {
filter_set_global_state($filter, TEXTFILTER_DISABLED);
}
$result = external::get_available_in_context(array(array('contextlevel' => 'course', 'instanceid' => $course->id)));
$result = external_api::clean_returnvalue(external::get_available_in_context_returns(), $result);
$this->assertEmpty($result['filters']); // No filters, all disabled at global level.
$this->assertEmpty($result['warnings']);
// Enable one filter at global level.
reset($allfilters);
$firstfilter = key($allfilters);
filter_set_global_state($firstfilter, TEXTFILTER_ON);
$result = external::get_available_in_context(array(array('contextlevel' => 'course', 'instanceid' => $course->id)));
$result = external_api::clean_returnvalue(external::get_available_in_context_returns(), $result);
$this->assertEmpty($result['warnings']);
$this->assertEquals($firstfilter, $result['filters'][0]['filter']); // OK, the filter is enabled.
$this->assertEquals(TEXTFILTER_INHERIT, $result['filters'][0]['localstate']); // Inherits the parent context status.
$this->assertEquals(TEXTFILTER_ON, $result['filters'][0]['inheritedstate']); // In the parent context is available.
// Set off the same filter at local context level.
filter_set_local_state($firstfilter, context_course::instance($course->id)->id, TEXTFILTER_OFF);
$result = external::get_available_in_context(array(array('contextlevel' => 'course', 'instanceid' => $course->id)));
$result = external_api::clean_returnvalue(external::get_available_in_context_returns(), $result);
$this->assertEmpty($result['warnings']);
$this->assertEquals($firstfilter, $result['filters'][0]['filter']); // OK, the filter is enabled globally.
$this->assertEquals(TEXTFILTER_OFF, $result['filters'][0]['localstate']); // It is not available in this context.
$this->assertEquals(TEXTFILTER_ON, $result['filters'][0]['inheritedstate']); // In the parent context is available.
}
/**
* Test get_available_in_context_module
*/
public function test_get_available_in_context_module() {
global $DB;
$this->resetAfterTest(true);
$this->setAdminUser();
// Create one activity.
$course = self::getDataGenerator()->create_course();
$forum = self::getDataGenerator()->create_module('forum', (object) array('course' => $course->id));
// Get all filters and disable them all globally.
$allfilters = filter_get_all_installed();
foreach ($allfilters as $filter => $filtername) {
filter_set_global_state($filter, TEXTFILTER_DISABLED);
}
$result = external::get_available_in_context(array(array('contextlevel' => 'module', 'instanceid' => $forum->cmid)));
$result = external_api::clean_returnvalue(external::get_available_in_context_returns(), $result);
$this->assertEmpty($result['filters']); // No filters, all disabled at global level.
$this->assertEmpty($result['warnings']);
// Enable one filter at global level.
reset($allfilters);
$firstfilter = key($allfilters);
filter_set_global_state($firstfilter, TEXTFILTER_ON);
$result = external::get_available_in_context(array(array('contextlevel' => 'module', 'instanceid' => $forum->cmid)));
$result = external_api::clean_returnvalue(external::get_available_in_context_returns(), $result);
$this->assertEmpty($result['warnings']);
$this->assertEquals($firstfilter, $result['filters'][0]['filter']); // OK, the filter is enabled.
$this->assertEquals(TEXTFILTER_INHERIT, $result['filters'][0]['localstate']); // Inherits the parent context status.
$this->assertEquals(TEXTFILTER_ON, $result['filters'][0]['inheritedstate']); // In the parent context is available.
// Set off the same filter at local context level.
filter_set_local_state($firstfilter, context_module::instance($forum->cmid)->id, TEXTFILTER_OFF);
$result = external::get_available_in_context(array(array('contextlevel' => 'module', 'instanceid' => $forum->cmid)));
$result = external_api::clean_returnvalue(external::get_available_in_context_returns(), $result);
$this->assertEmpty($result['warnings']);
$this->assertEquals($firstfilter, $result['filters'][0]['filter']); // OK, the filter is enabled globally.
$this->assertEquals(TEXTFILTER_OFF, $result['filters'][0]['localstate']); // It is not available in this context.
$this->assertEquals(TEXTFILTER_ON, $result['filters'][0]['inheritedstate']); // In the parent context is available.
}
}
......@@ -2075,6 +2075,15 @@ $functions = array(
'capabilities' => '',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
),
// Filters functions.
'core_filters_get_available_in_context' => array(
'classname' => 'core_filters\external',
'methodname' => 'get_available_in_context',
'description' => 'Returns the filters available in the given contexts.',
'type' => 'read',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
)
);
$services = array(
......
......@@ -29,7 +29,7 @@
defined('MOODLE_INTERNAL') || die();
$version = 2017101300.00; // YYYYMMDD = weekly release date of this DEV branch.
$version = 2017101300.01; // YYYYMMDD = weekly release date of this DEV branch.
// RR = release increments - 00 in DEV branches.
// .XX = incremental changes.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment