Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
locallib.php File Reference

Classes

class  book_file_info
 File browsing support class. More...
 

Functions

 book_add_fake_block ($chapters, $chapter, $book, $cm, $edit=null)
 Add the book TOC sticky block to the default region.
 
 book_get_chapter_title ($chid, $chapters, $book, $context)
 Returns the title for a given chapter.
 
 book_get_toc ($chapters, $chapter, $book, $cm, $edit)
 Generate toc structure.
 
 book_preload_chapters ($book)
 Preload book chapters and fix toc structure if necessary.
 
 mod_book_get_tagged_chapters ($tag, $exclusivemode=false, $fromctx=0, $ctx=0, $rec=true, $page=0)
 Returns book chapters tagged with a specified tag.
 

Variables

const BOOK_LINK_IMAGE '1'
 
const BOOK_LINK_TEXT '2'
 
const BOOK_LINK_TOCONLY '0'
 The following defines are used to define the navigation style used within a book.
 
const BOOK_NUM_BULLETS '2'
 
const BOOK_NUM_INDENTED '3'
 
const BOOK_NUM_NONE '0'
 The following defines are used to define how the chapters and subchapters of a book should be displayed in that table of contents.
 
const BOOK_NUM_NUMBERS '1'