[Summary view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  namespace mod_book;
  17  
  18  /**
  19   * Book helper
  20   *
  21   * @package    mod_book
  22   * @copyright  2023 Laurent David <laurent.david@moodle.com>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  class helper {
  26      /**
  27       * Check if we are on the last visible chapter of the book.
  28       *
  29       * @param int $chapterid
  30       * @param array $chapters chapter list provided by book_preload_chapters
  31       * @see book_preload_chapters
  32       * @return bool
  33       */
  34      public static function is_last_visible_chapter(int $chapterid, array $chapters): bool {
  35          $lastchapterid = 0;
  36          foreach ($chapters as $ch) {
  37              if ($ch->hidden) {
  38                  continue;
  39              }
  40              $lastchapterid = $ch->id;
  41          }
  42          return $chapterid == $lastchapterid;
  43      }
  44  }