[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  
  17  namespace core_courseformat\output\local;
  18  
  19  /**
  20   * Base templatable class for coursformat templateables which are typically overridden by course formats.
  21   *
  22   * @package   core_courseformat
  23   * @copyright 2022 Andrew Lyons <andrew@nicols.co.uk>
  24   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25   */
  26  trait courseformat_named_templatable {
  27  
  28      /**
  29       * Get the name of the template to use for this templatable.
  30       *
  31       * @param \renderer_base $renderer The renderer requesting the template name
  32       * @return string
  33       */
  34      public function get_template_name(\renderer_base $renderer): string {
  35          $fullpath = str_replace('\\', '/', get_class($this));
  36  
  37          $specialrenderers = '@^.*/output/(local|courseformat)/(?<template>.+)$@';
  38          $matches = null;
  39  
  40          if (preg_match($specialrenderers, $fullpath, $matches)) {
  41              return "core_courseformat/local/{$matches['template']}";
  42          }
  43  
  44          throw new \coding_exception("Unable to determine template name for class " . get_class($this));
  45      }
  46  }