[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\output;
  18  
  19  use templatable;
  20  
  21  /**
  22   * A subset of templatable which provides the name of the template to use.
  23   *
  24   * @package   core
  25   * @copyright 2022 Andrew Lyons <andrew@nicols.co.uk>
  26   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27   */
  28  interface named_templatable extends templatable {
  29  
  30      /**
  31       * Get the name of the template to use for this templatable.
  32       *
  33       * @param \renderer_base $renderer The renderer requesting the template name
  34       * @return string
  35       */
  36      public function get_template_name(\renderer_base $renderer): string;
  37  }