PHP Class Bluz\Router\Router

See link: https://github.com/bluzphp/framework/wiki/Router
Author: Anton Shevchuk
Inheritance: use trait Bluz\Common\Options
Afficher le fichier Open project: bluzphp/framework Class Usage Examples

Protected Properties

Свойство Type Description
$baseUrl base URL
$cleanUri REQUEST_URI minus Base URL
$defaultController default Controller
$defaultModule default module
$errorController error Controller
$errorModule error module
$params instance parameters
$rawParams instance raw parameters
$reverse reverse map
$routers routers map

Méthodes publiques

Méthode Description
__construct ( ) Constructor of Router
getBaseUrl ( ) : string Get the base URL.
getCleanUri ( ) : string Get the request URI without baseUrl
getDefaultController ( ) : string Get default controller
getDefaultModule ( ) : string Get default module
getErrorController ( ) : string Get error controller
getErrorModule ( ) : string Get error module
getFullUrl ( string $module = self::DEFAULT_MODULE, string $controller = self::DEFAULT_CONTROLLER, array $params = [] ) : string Build full URL to controller
getParam ( string $key, mixed $default = null ) : mixed Get an action parameter
getParams ( ) : array Get parameters
getRawParams ( ) : array Get raw params, w/out module and controller
getUrl ( string $module = self::DEFAULT_MODULE, string $controller = self::DEFAULT_CONTROLLER, array $params = [] ) : string Build URL to controller
process ( ) : Router Process routing
setBaseUrl ( string $baseUrl ) : void Set the base URL.
setDefaultController ( string $defaultController ) : void Set default controller
setDefaultModule ( string $defaultModule ) : void Set default module
setErrorController ( string $errorController ) : void Set error controller
setErrorModule ( string $errorModule ) : void Set error module
setParam ( string $key, mixed $value ) : void Set an action parameter

Méthodes protégées

Méthode Description
processCustom ( ) : boolean Process custom router
processDefault ( ) : boolean Process default router
processRoute ( ) : boolean Process router by default rules
resetRequest ( ) : void Reset Request
urlCustom ( string $module, string $controller, array $params ) : string Build URL by custom route
urlRoute ( string $module, string $controller, array $params ) : string Build URL by default route

Method Details

__construct() public méthode

Constructor of Router
public __construct ( )

getBaseUrl() public méthode

Get the base URL.
public getBaseUrl ( ) : string
Résultat string

getCleanUri() public méthode

Get the request URI without baseUrl
public getCleanUri ( ) : string
Résultat string

getDefaultController() public méthode

Get default controller
public getDefaultController ( ) : string
Résultat string

getDefaultModule() public méthode

Get default module
public getDefaultModule ( ) : string
Résultat string

getErrorController() public méthode

Get error controller
public getErrorController ( ) : string
Résultat string

getErrorModule() public méthode

Get error module
public getErrorModule ( ) : string
Résultat string

getFullUrl() public méthode

Build full URL to controller
public getFullUrl ( string $module = self::DEFAULT_MODULE, string $controller = self::DEFAULT_CONTROLLER, array $params = [] ) : string
$module string
$controller string
$params array
Résultat string

getParam() public méthode

Get an action parameter
public getParam ( string $key, mixed $default = null ) : mixed
$key string
$default mixed Default value to use if key not found
Résultat mixed

getParams() public méthode

Get parameters
public getParams ( ) : array
Résultat array

getRawParams() public méthode

Get raw params, w/out module and controller
public getRawParams ( ) : array
Résultat array

getUrl() public méthode

Build URL to controller
public getUrl ( string $module = self::DEFAULT_MODULE, string $controller = self::DEFAULT_CONTROLLER, array $params = [] ) : string
$module string
$controller string
$params array
Résultat string

process() public méthode

Process routing
public process ( ) : Router
Résultat Router

processCustom() protected méthode

Process custom router
protected processCustom ( ) : boolean
Résultat boolean

processDefault() protected méthode

Process default router
protected processDefault ( ) : boolean
Résultat boolean

processRoute() protected méthode

Default routers examples :module/ :module/:controller/ :module/:controller/:key1/:value1/:key2/:value2...
protected processRoute ( ) : boolean
Résultat boolean

resetRequest() protected méthode

Reset Request
protected resetRequest ( ) : void
Résultat void

setBaseUrl() public méthode

Set the base URL.
public setBaseUrl ( string $baseUrl ) : void
$baseUrl string
Résultat void

setDefaultController() public méthode

Set default controller
public setDefaultController ( string $defaultController ) : void
$defaultController string
Résultat void

setDefaultModule() public méthode

Set default module
public setDefaultModule ( string $defaultModule ) : void
$defaultModule string
Résultat void

setErrorController() public méthode

Set error controller
public setErrorController ( string $errorController ) : void
$errorController string
Résultat void

setErrorModule() public méthode

Set error module
public setErrorModule ( string $errorModule ) : void
$errorModule string
Résultat void

setParam() public méthode

A $value of null will unset the $key if it exists
public setParam ( string $key, mixed $value ) : void
$key string
$value mixed
Résultat void

urlCustom() protected méthode

Build URL by custom route
protected urlCustom ( string $module, string $controller, array $params ) : string
$module string
$controller string
$params array
Résultat string

urlRoute() protected méthode

Build URL by default route
protected urlRoute ( string $module, string $controller, array $params ) : string
$module string
$controller string
$params array
Résultat string

Property Details

$baseUrl protected_oe property

base URL
protected $baseUrl

$cleanUri protected_oe property

REQUEST_URI minus Base URL
protected $cleanUri

$defaultController protected_oe property

default Controller
protected $defaultController

$defaultModule protected_oe property

default module
protected $defaultModule

$errorController protected_oe property

error Controller
protected $errorController

$errorModule protected_oe property

error module
protected $errorModule

$params protected_oe property

instance parameters
protected $params

$rawParams protected_oe property

instance raw parameters
protected $rawParams

$reverse protected_oe property

reverse map
protected $reverse

$routers protected_oe property

routers map
protected $routers