Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
- Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
- PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/mod/book/classes/ -> external.php (source)
Differences Between: [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]
Book external API
| Copyright: | 2015 Juan Leyva <juan@moodle.com> |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 271 lines (11 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
mod_book_external:: (6 methods):
view_book_parameters()
view_book()
view_book_returns()
get_books_by_courses_parameters()
get_books_by_courses()
get_books_by_courses_returns()
Class: mod_book_external - X-Ref
Book external functions| view_book_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| view_book($bookid, $chapterid = 0) X-Ref |
| Simulate the book/view.php web interface page: trigger events, completion, etc... param: int $bookid the book instance id param: int $chapterid the book chapter id return: array of warnings and status result |
| view_book_returns() X-Ref |
| Returns description of method result value return: external_description |
| get_books_by_courses_parameters() X-Ref |
| Describes the parameters for get_books_by_courses. return: external_function_parameters |
| get_books_by_courses($courseids = array() X-Ref |
| Returns a list of books in a provided list of courses, if no list is provided all books that the user can view will be returned. param: array $courseids the course ids return: array of books details |
| get_books_by_courses_returns() X-Ref |
| Describes the get_books_by_courses return value. return: external_single_structure |
