MDL-81326 mod_book: Deprecate book_get_nav_classes

While reviewing MDL-72376, I realised book_get_nav_classes is not
used anymore in Moodle LMS since Moodle 4.0 so it should be deprecated
Probably it should have been deprecated together with book_get_nav_types.
This commit is contained in:
Sara Arjona 2024-03-21 16:45:34 +01:00
parent 4da813d35e
commit 2cfb5b8efe
No known key found for this signature in database
3 changed files with 16 additions and 9 deletions

View File

@ -36,3 +36,16 @@ function book_scale_used() {
function book_get_nav_types() {
throw new coding_exception(__FUNCTION__ . '() has been removed.');
}
/**
* Returns list of available navigation link CSS classes.
*
* @deprecated since Moodle 4.4.
* @todo MDL-81328 Final deprecation in Moodle 4.8.
* @return array
*/
function book_get_nav_classes() {
debugging(__FUNCTION__ . '() is deprecated. There is no replacement.');
return ['navtoc', 'navimages', 'navtext'];
}

View File

@ -43,14 +43,6 @@ function book_get_numbering_types() {
);
}
/**
* Returns list of available navigation link CSS classes.
* @return array
*/
function book_get_nav_classes() {
return array ('navtoc', 'navimages', 'navtext');
}
/**
* Add book instance.
*

View File

@ -1,8 +1,10 @@
This files describes API changes in the book code.
This file describes API changes in the book code.
=== 4.4 ===
* The previously deprecated `book_get_nav_types` method has been removed, along with the `BOOK_LINK_*` constants
* book_get_nav_classes() has been deprecated and won't have replacement because it's not required anymore. It should have been
deprecated together with book_get_nav_types.
=== 4.0 ===