mirror of
https://github.com/moodle/moodle.git
synced 2025-07-23 15:22:05 +02:00
This enables a plugin to implement rewriting rules enabling 'clean' or 'semantic' urls such as /course/COMP100/ instead of /course/view.php?id=1234
59 lines
1.6 KiB
PHP
59 lines
1.6 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* URL rewriter base.
|
|
*
|
|
* @package core
|
|
* @author Brendan Heywood <brendan@catalyst-au.net>
|
|
* @copyright Catalyst IT
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace core\output;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* URL rewriter interface
|
|
*
|
|
* @package core
|
|
* @author Brendan Heywood <brendan@catalyst-au.net>
|
|
* @copyright Catalyst IT
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
interface url_rewriter {
|
|
|
|
/**
|
|
* Rewrite moodle_urls into another form.
|
|
*
|
|
* @param moodle_url $url a url to potentially rewrite
|
|
* @return moodle_url Returns a new, or the original, moodle_url;
|
|
*/
|
|
public static function url_rewrite(\moodle_url $url);
|
|
|
|
/**
|
|
* Gives a url rewriting plugin a chance to rewrite the current page url
|
|
* avoiding redirects and improving performance.
|
|
*
|
|
* @return void
|
|
*/
|
|
public static function html_head_setup();
|
|
|
|
|
|
}
|
|
|