PHP Class Bluz\Router\Router

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

Protected Properties

Property 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

Public Methods

Method 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

Protected Methods

Method 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 method

Constructor of Router
public __construct ( )

getBaseUrl() public method

Get the base URL.
public getBaseUrl ( ) : string
return string

getCleanUri() public method

Get the request URI without baseUrl
public getCleanUri ( ) : string
return string

getDefaultController() public method

Get default controller
public getDefaultController ( ) : string
return string

getDefaultModule() public method

Get default module
public getDefaultModule ( ) : string
return string

getErrorController() public method

Get error controller
public getErrorController ( ) : string
return string

getErrorModule() public method

Get error module
public getErrorModule ( ) : string
return string

getFullUrl() public method

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
return string

getParam() public method

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

getParams() public method

Get parameters
public getParams ( ) : array
return array

getRawParams() public method

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

getUrl() public method

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
return string

process() public method

Process routing
public process ( ) : Router
return Router

processCustom() protected method

Process custom router
protected processCustom ( ) : boolean
return boolean

processDefault() protected method

Process default router
protected processDefault ( ) : boolean
return boolean

processRoute() protected method

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

resetRequest() protected method

Reset Request
protected resetRequest ( ) : void
return void

setBaseUrl() public method

Set the base URL.
public setBaseUrl ( string $baseUrl ) : void
$baseUrl string
return void

setDefaultController() public method

Set default controller
public setDefaultController ( string $defaultController ) : void
$defaultController string
return void

setDefaultModule() public method

Set default module
public setDefaultModule ( string $defaultModule ) : void
$defaultModule string
return void

setErrorController() public method

Set error controller
public setErrorController ( string $errorController ) : void
$errorController string
return void

setErrorModule() public method

Set error module
public setErrorModule ( string $errorModule ) : void
$errorModule string
return void

setParam() public method

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

urlCustom() protected method

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

urlRoute() protected method

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

Property Details

$baseUrl protected property

base URL
protected $baseUrl

$cleanUri protected property

REQUEST_URI minus Base URL
protected $cleanUri

$defaultController protected property

default Controller
protected $defaultController

$defaultModule protected property

default module
protected $defaultModule

$errorController protected property

error Controller
protected $errorController

$errorModule protected property

error module
protected $errorModule

$params protected property

instance parameters
protected $params

$rawParams protected property

instance raw parameters
protected $rawParams

$reverse protected property

reverse map
protected $reverse

$routers protected property

routers map
protected $routers