Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
mod_book_external Class Reference

Book external functions. More...

Inheritance diagram for mod_book_external:

Static Public Member Functions

static get_books_by_courses ($courseids=array())
 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.
 
static get_books_by_courses_parameters ()
 Describes the parameters for get_books_by_courses.
 
static get_books_by_courses_returns ()
 Describes the get_books_by_courses return value.
 
static view_book ($bookid, $chapterid=0)
 Simulate the book/view.php web interface page: trigger events, completion, etc...
 
static view_book_parameters ()
 Returns description of method parameters.
 
static view_book_returns ()
 Returns description of method result value.
 

Detailed Description

Book external functions.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Since
Moodle 3.0

Member Function Documentation

◆ get_books_by_courses()

static mod_book_external::get_books_by_courses ( $courseids = array())
static

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.

Parameters
array$courseidsthe course ids
Return values
arrayof books details
Since
Moodle 3.0

◆ get_books_by_courses_parameters()

static mod_book_external::get_books_by_courses_parameters ( )
static

Describes the parameters for get_books_by_courses.

Return values
external_function_parameters
Since
Moodle 3.0

◆ get_books_by_courses_returns()

static mod_book_external::get_books_by_courses_returns ( )
static

Describes the get_books_by_courses return value.

Return values
external_single_structure
Since
Moodle 3.0

◆ view_book()

static mod_book_external::view_book ( $bookid,
$chapterid = 0 )
static

Simulate the book/view.php web interface page: trigger events, completion, etc...

Parameters
int$bookidthe book instance id
int$chapteridthe book chapter id
Return values
arrayof warnings and status result
Since
Moodle 3.0
Exceptions
moodle_exception

◆ view_book_parameters()

static mod_book_external::view_book_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.0

◆ view_book_returns()

static mod_book_external::view_book_returns ( )
static

Returns description of method result value.

Return values
core_external\external_description
Since
Moodle 3.0

The documentation for this class was generated from the following file: