• Главная
• Router

PHP Класс Router

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$initialized	boolean	Have routes been loaded
$routes	array	Array of routes connected with Router::connect()

Защищенные свойства (Protected)

Свойство	Тип	Описание
$_currentRoute	array	The route matching the URL of the current request
$_fullBaseUrl	string	Contains the base string that will be applied to all generated URLs For example https://example.com
$_initialState	array	Initial state is populated the first time reload() is called which is at the bottom of this file. This is a cheat as get_class_vars() returns the value of static vars even if they have changed.
$_namedConfig	string	Stores all information necessary to decide what named arguments are parsed under what conditions.
$_namedExpressions	array	Named expressions
$_parseExtensions	boolean	Directive for Router to parse out file extensions for mapping to Content-types.
$_prefixes	array	Includes admin prefix
$_requests	array	This will contain more than one request object when requestAction is used.
$_resourceMap	array	Default HTTP request method => controller action map.
$_resourceMapped	array	List of resource-mapped controllers
$_routeClass	string	Default route class to use
$_validExtensions	array	List of valid extensions to parse from a URL. If null, any extension is allowed.

Открытые методы

Метод	Описание
connect ( string $route, array $defaults = [], array $options = [] ) : array	Connects a new Route in the router.
connectNamed ( array $named, array $options = [] ) : array	Specifies what named parameters CakePHP should be parsing out of incoming URLs. By default CakePHP will parse every named parameter out of incoming URLs. However, if you want to take more control over how named parameters are parsed you can use one of the following setups:
currentRoute ( ) : CakeRoute	Returns the route matching the current request (useful for requestAction traces)
defaultRouteClass ( string $routeClass = null ) : string | null	Set the default route class to use or return the current one
extensions ( ) : array	Get the list of extensions that can be parsed by Router.
fullBaseUrl ( string $base = null ) : string	Sets the full base URL that will be used as a prefix for generating fully qualified URLs for this application. If no parameters are passed, the currently configured value is returned.
getNamedExpressions ( ) : array	Gets the named route elements for use in app/Config/routes.php
getParam ( string $name = 'controller', boolean $current = false ) : string | null	Gets URL parameter by name
getParams ( boolean $current = false ) : array	Gets parameter information
getPaths ( boolean $current = false ) : array	Gets path information
getRequest ( boolean $current = false ) : CakeRequest | null	Gets the current request object, or the first one.
mapResources ( string | array $controller, array $options = [] ) : array	Creates REST resource routes for the given controller(s). When creating resource routes for a plugin, by default the prefix will be changed to the lower_underscore version of the plugin name. By providing a prefix you can override this behavior.
namedConfig ( ) : array	Gets the current named parameter configuration values.
normalize ( array | string $url = '/' ) : string	Normalizes a URL for purposes of comparison.
parse ( string $url ) : array	Parses given URL string. Returns 'routing' parameters for that URL.
parseExtensions ( ) : void	Instructs the router to parse out file extensions from the URL.
popRequest ( ) : CakeRequest	Pops a request off of the request stack. Used when doing requestAction
prefixes ( ) : array	Returns the list of prefixes used in connected routes
promote ( integer $which = null ) : boolean	Promote a route (by default, the last one added) to the beginning of the list
queryString ( string | array $q, array $extra = [], boolean $escape = false ) : array	Generates a well-formed querystring from $q
redirect ( string $route, array $url, array $options = [] ) : array	Connects a new redirection Route in the router.
reload ( ) : void	Reloads default Router settings. Resets all class variables and removes all connected routes.
requestRoute ( ) : CakeRoute	Returns the route matching the current request URL.
resourceMap ( array $resourceMap = null ) : mixed	Resource map getter & setter.
reverse ( CakeRequest | array $params, boolean $full = false ) : string	Reverses a parsed parameter array into a string.
setExtensions ( array $extensions, boolean $merge = true ) : array	Set/add valid extensions.
setRequestInfo ( CakeRequest | array $request ) : void	Takes parameter and path information back from the Dispatcher, sets these parameters as the current request parameters that are merged with URL arrays created later in the request.
stripPlugin ( string $base, string $plugin = null ) : string	Removes the plugin name from the base URL.
url ( string | array $url = null, boolean | array $full = false ) : string	Finds URL for specified action.

Защищенные методы

Метод	Описание
_handleNoRoute ( array $url ) : string	A special fallback method that handles URL arrays that cannot match any defined routes.
_loadRoutes ( ) : void	Loads route configuration
_parseExtension ( string $url ) : array	Parses a file extension out of a URL, if Router::parseExtensions() is enabled.
_setPrefixes ( ) : void	Sets the Routing prefixes.
_validateRouteClass ( string $routeClass ) : string	Validates that the passed route class exists and is a subclass of CakeRoute

Описание методов

Описание свойств