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/>.
  16
  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  */
  26
  27 $functions = array(
  28
  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         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  37     ),
  38
  39     'mod_wiki_view_wiki' => array(
  40         'classname'     => 'mod_wiki_external',
  41         'methodname'    => 'view_wiki',
  42         'description'   => 'Trigger the course module viewed event and update the module completion status.',
  43         'type'          => 'write',
  44         'capabilities'  => 'mod/wiki:viewpage',
  45         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  46     ),
  47
  48     'mod_wiki_view_page' => array(
  49         'classname'     => 'mod_wiki_external',
  50         'methodname'    => 'view_page',
  51         'description'   => 'Trigger the page viewed event and update the module completion status.',
  52         'type'          => 'write',
  53         'capabilities'  => 'mod/wiki:viewpage',
  54         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  55     ),
  56
  57     'mod_wiki_get_subwikis' => array(
  58         'classname'     => 'mod_wiki_external',
  59         'methodname'    => 'get_subwikis',
  60         'description'   => 'Returns the list of subwikis the user can see in a specific wiki.',
  61         'type'          => 'read',
  62         'capabilities'  => 'mod/wiki:viewpage',
  63         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  64     ),
  65     'mod_wiki_get_subwiki_pages' => array(
  66         'classname'     => 'mod_wiki_external',
  67         'methodname'    => 'get_subwiki_pages',
  68         'description'   => 'Returns the list of pages for a specific subwiki.',
  69         'type'          => 'read',
  70         'capabilities'  => 'mod/wiki:viewpage',
  71         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  72     ),
  73
  74     'mod_wiki_get_subwiki_files' => array(
  75         'classname'     => 'mod_wiki_external',
  76         'methodname'    => 'get_subwiki_files',
  77         'description'   => 'Returns the list of files for a specific subwiki.',
  78         'type'          => 'read',
  79         'capabilities'  => 'mod/wiki:viewpage',
  80         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  81     ),
  82
  83     'mod_wiki_get_page_contents' => array(
  84         'classname'     => 'mod_wiki_external',
  85         'methodname'    => 'get_page_contents',
  86         'description'   => 'Returns the contents of a page.',
  87         'type'          => 'read',
  88         'capabilities'  => 'mod/wiki:viewpage',
  89         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  90     )
  91 );