You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
115 lines
3.4 KiB
115 lines
3.4 KiB
<?php
|
|
|
|
/**
|
|
* CodeIgniter
|
|
*
|
|
* An open source application development framework for PHP
|
|
*
|
|
* This content is released under the MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2014-2019 British Columbia Institute of Technology
|
|
* Copyright (c) 2019 CodeIgniter Foundation
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*
|
|
* @package CodeIgniter
|
|
* @author CodeIgniter Dev Team
|
|
* @copyright 2019 CodeIgniter Foundation
|
|
* @license https://opensource.org/licenses/MIT MIT License
|
|
* @link https://codeigniter.com
|
|
* @since Version 4.0.0
|
|
* @filesource
|
|
*/
|
|
|
|
namespace CodeIgniter\Router;
|
|
|
|
use CodeIgniter\HTTP\Request;
|
|
|
|
/**
|
|
* Expected behavior of a Router.
|
|
*/
|
|
interface RouterInterface
|
|
{
|
|
|
|
/**
|
|
* Stores a reference to the RouteCollection object.
|
|
*
|
|
* @param RouteCollectionInterface $routes
|
|
* @param \CodeIgniter\HTTP\Request $request
|
|
*/
|
|
public function __construct(RouteCollectionInterface $routes, Request $request = null);
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Scans the URI and attempts to match the current URI to the
|
|
* one of the defined routes in the RouteCollection.
|
|
*
|
|
* @param string $uri
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function handle(string $uri = null);
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Returns the name of the matched controller.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function controllerName();
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Returns the name of the method to run in the
|
|
* chosen container.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function methodName();
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Returns the binds that have been matched and collected
|
|
* during the parsing process as an array, ready to send to
|
|
* instance->method(...$params).
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function params();
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Sets the value that should be used to match the index.php file. Defaults
|
|
* to index.php but this allows you to modify it in case your are using
|
|
* something like mod_rewrite to remove the page. This allows you to set
|
|
* it a blank.
|
|
*
|
|
* @param $page
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function setIndexPage($page);
|
|
|
|
//--------------------------------------------------------------------
|
|
}
|
|
|