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

MDL-58713 filters: New WS core_filters_get_available_in_context

Browse source
This commit is contained in:
Juan Leyva 2017-09-20 09:29:45 +02:00
parent dc78f150fa
commit 66ef16d364
4 changed files with 335 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

134
filter/classes/external.php Normal file
View file

@ -0,0 +1,134 @@
<?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(),
)
);
}
}