[Summary view]

Differences Between: [Versions 311 and 402] [Versions 311 and 403]

   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  /**
  18   * URL rewriter base.
  19   *
  20   * @package    core
  21   * @author     Brendan Heywood <brendan@catalyst-au.net>
  22   * @copyright  Catalyst IT
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace core\output;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  /**
  31   * URL rewriter interface
  32   *
  33   * @package    core
  34   * @author     Brendan Heywood <brendan@catalyst-au.net>
  35   * @copyright  Catalyst IT
  36   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  interface url_rewriter {
  39  
  40      /**
  41       * Rewrite moodle_urls into another form.
  42       *
  43       * @param moodle_url $url a url to potentially rewrite
  44       * @return moodle_url Returns a new, or the original, moodle_url;
  45       */
  46      public static function url_rewrite(\moodle_url $url);
  47  
  48      /**
  49       * Gives a url rewriting plugin a chance to rewrite the current page url
  50       * avoiding redirects and improving performance.
  51       *
  52       * @return void
  53       */
  54      public static function html_head_setup();
  55  
  56  
  57  }
  58