diff --git a/mod/book/tool/print/locallib.php b/mod/book/tool/print/locallib.php index 169caf3dc11..549de3d9c1e 100644 --- a/mod/book/tool/print/locallib.php +++ b/mod/book/tool/print/locallib.php @@ -28,85 +28,9 @@ require_once(__DIR__.'/lib.php'); require_once($CFG->dirroot.'/mod/book/locallib.php'); /** - * Generate toc structure and titles - * * @deprecated since Moodle 3.7 - * @param array $chapters - * @param stdClass $book - * @param stdClass $cm - * @return array */ -function booktool_print_get_toc($chapters, $book, $cm) { - debugging('booktool_print_get_toc() is deprecated. Please use booktool_print renderer - function render_print_book_toc().', DEBUG_DEVELOPER); - - $first = true; - $titles = array(); - - $context = context_module::instance($cm->id); - - $toc = ''; // Representation of toc (HTML). - - switch ($book->numbering) { - case BOOK_NUM_NONE: - $toc .= html_writer::start_tag('div', array('class' => 'book_toc_none')); - break; - case BOOK_NUM_NUMBERS: - $toc .= html_writer::start_tag('div', array('class' => 'book_toc_numbered')); - break; - case BOOK_NUM_BULLETS: - $toc .= html_writer::start_tag('div', array('class' => 'book_toc_bullets')); - break; - case BOOK_NUM_INDENTED: - $toc .= html_writer::start_tag('div', array('class' => 'book_toc_indented')); - break; - } - - $toc .= html_writer::tag('a', '', array('name' => 'toc')); // Representation of toc (HTML). - - $toc .= html_writer::tag('h2', get_string('toc', 'mod_book')); - $toc .= html_writer::start_tag('ul'); - foreach ($chapters as $ch) { - if (!$ch->hidden) { - $title = book_get_chapter_title($ch->id, $chapters, $book, $context); - if (!$ch->subchapter) { - - if ($first) { - $toc .= html_writer::start_tag('li'); - } else { - $toc .= html_writer::end_tag('ul'); - $toc .= html_writer::end_tag('li'); - $toc .= html_writer::start_tag('li'); - } - - } else { - - if ($first) { - $toc .= html_writer::start_tag('li'); - $toc .= html_writer::start_tag('ul'); - $toc .= html_writer::start_tag('li'); - } else { - $toc .= html_writer::start_tag('li'); - } - - } - $titles[$ch->id] = $title; - $toc .= html_writer::link(new moodle_url('#ch'.$ch->id), $title, array('title' => s($title))); - if (!$ch->subchapter) { - $toc .= html_writer::start_tag('ul'); - } else { - $toc .= html_writer::end_tag('li'); - } - $first = false; - } - } - - $toc .= html_writer::end_tag('ul'); - $toc .= html_writer::end_tag('li'); - $toc .= html_writer::end_tag('ul'); - $toc .= html_writer::end_tag('div'); - - $toc = str_replace('', '', $toc); // Cleanup of invalid structures. - - return array($toc, $titles); +function booktool_print_get_toc() { + throw new coding_exception(__FUNCTION__ . ' can not be used any more. Please use booktool_print renderer + function render_print_book_toc().'); } diff --git a/mod/book/upgrade.txt b/mod/book/upgrade.txt index f58e5dc285c..1e563ca3e5c 100644 --- a/mod/book/upgrade.txt +++ b/mod/book/upgrade.txt @@ -1,5 +1,8 @@ This files describes API changes in the book code. +=== 3.11 === +* Final deprecation - booktool_print_get_toc(). Please use render_print_book_toc() instead. + === 3.8 === * The following functions have been finally deprecated and can not be used anymore: