46cf320d97b3ced540983329e927d6984cbbfd74
[moodle.git] / mod / wiki / db / services.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Wiki external functions and service definitions.
19  *
20  * @package    mod_wiki
21  * @category   external
22  * @copyright  2015 Dani Palou <dani@moodle.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  * @since      Moodle 3.1
25  */
27 $functions = array(
29     'mod_wiki_get_wikis_by_courses' => array(
30         'classname'     => 'mod_wiki_external',
31         'methodname'    => 'get_wikis_by_courses',
32         'description'   => 'Returns a list of wiki instances in a provided set of courses, if ' .
33                            'no courses are provided then all the wiki instances the user has access to will be returned.',
34         'type'          => 'read',
35         'capabilities'  => 'mod/wiki:viewpage'
36     ),
38     'mod_wiki_view_wiki' => array(
39         'classname'     => 'mod_wiki_external',
40         'methodname'    => 'view_wiki',
41         'description'   => 'Trigger the course module viewed event and update the module completion status.',
42         'type'          => 'write',
43         'capabilities'  => 'mod/wiki:viewpage'
44     ),
46     'mod_wiki_view_page' => array(
47         'classname'     => 'mod_wiki_external',
48         'methodname'    => 'view_page',
49         'description'   => 'Trigger the page viewed event and update the module completion status.',
50         'type'          => 'write',
51         'capabilities'  => 'mod/wiki:viewpage'
52     )
53 );