mod/book/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  * Book external functions and service definitions.
  19  *
  20  * @package    mod_book
  21  * @category   external
  22  * @copyright  2015 Juan Leyva <juan@moodle.com>
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  * @since      Moodle 3.0
  25  */
  26
  27 defined('MOODLE_INTERNAL') || die;
  28
  29 $functions = array(
  30
  31     'mod_book_view_book' => array(
  32         'classname'     => 'mod_book_external',
  33         'methodname'    => 'view_book',
  34         'description'   => 'Simulate the view.php web interface book: trigger events, completion, etc...',
  35         'type'          => 'write',
  36         'capabilities'  => 'mod/book:read',
  37         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  38     ),
  39
  40     'mod_book_get_books_by_courses' => array(
  41         'classname'     => 'mod_book_external',
  42         'methodname'    => 'get_books_by_courses',
  43         'description'   => 'Returns a list of book instances in a provided set of courses,
  44                             if no courses are provided then all the book instances the user has access to will be returned.',
  45         'type'          => 'read',
  46         'capabilities'  => '',
  47         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  48     )
  49 );