Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Functions
lib.php File Reference

Book module core interaction API. More...

Functions

 book_add_instance ($data, $mform)
 Add book instance. More...
 
 book_check_updates_since (cm_info $cm, $from, $filter=array())
 Check if the module has any update that affects the current user since a given time. More...
 
 book_cron ()
 No cron in book. More...
 
 book_delete_instance ($id)
 Delete book instance by activity id. More...
 
 book_export_contents ($cm, $baseurl)
 Export book resource contents. More...
 
 book_extend_settings_navigation (settings_navigation $settingsnav, navigation_node $booknode)
 Adds module specific settings to the settings block. More...
 
 book_get_file_areas ($course, $cm, $context)
 Lists all browsable file areas. More...
 
 book_get_file_info ($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename)
 File browsing support for book module chapter area. More...
 
 book_get_nav_classes ()
 Returns list of available navigation link CSS classes. More...
 
 book_get_nav_types ()
 Returns list of available navigation link types. More...
 
 book_get_numbering_types ()
 Returns list of available numbering types. More...
 
 book_get_post_actions ()
 Return write actions. More...
 
 book_get_view_actions ()
 Return read actions. More...
 
 book_grades ($bookid)
 No grading in book. More...
 
 book_page_type_list ($pagetype, $parentcontext, $currentcontext)
 Return a list of page types. More...
 
 book_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array())
 Serves the book attachments. More...
 
 book_print_recent_activity ($course, $viewfullnames, $timestart)
 Given a course and a time, this module should find recent activity that has occurred in book activities and print it out. More...
 
 book_reset_course_form_definition (&$mform)
 The elements to add the course reset form. More...
 
 book_reset_userdata ($data)
 This function is used by the reset_course_userdata function in moodlelib. More...
 
 book_scale_used ()
 
 book_scale_used_anywhere ($scaleid)
 Checks if scale is being used by any instance of book. More...
 
 book_supports ($feature)
 Supported features. More...
 
 book_update_instance ($data, $mform)
 Update book instance. More...
 
 book_view ($book, $chapter, $islastchapter, $course, $cm, $context)
 Mark the activity completed (if required) and trigger the course_module_viewed event. More...
 
 mod_book_core_calendar_provide_event_action (calendar_event $event, core_calendar\action_factory $factory, int $userid=0)
 This function receives a calendar event and returns the action associated with it, or null if there is none. More...
 
 mod_book_get_fontawesome_icon_map ()
 Get icon mapping for font-awesome.
 

Detailed Description

Book module core interaction API.

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