PHP Класс Bluz\Router\Router

Автор: Anton Shevchuk
Наследование: use trait Bluz\Common\Options
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$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

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

Метод Описание
__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

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

Метод Описание
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

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

__construct() публичный Метод

Constructor of Router
public __construct ( )

getBaseUrl() публичный Метод

Get the base URL.
public getBaseUrl ( ) : string
Результат string

getCleanUri() публичный Метод

Get the request URI without baseUrl
public getCleanUri ( ) : string
Результат string

getDefaultController() публичный Метод

Get default controller
public getDefaultController ( ) : string
Результат string

getDefaultModule() публичный Метод

Get default module
public getDefaultModule ( ) : string
Результат string

getErrorController() публичный Метод

Get error controller
public getErrorController ( ) : string
Результат string

getErrorModule() публичный Метод

Get error module
public getErrorModule ( ) : string
Результат string

getFullUrl() публичный Метод

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
Результат string

getParam() публичный Метод

Get an action parameter
public getParam ( string $key, mixed $default = null ) : mixed
$key string
$default mixed Default value to use if key not found
Результат mixed

getParams() публичный Метод

Get parameters
public getParams ( ) : array
Результат array

getRawParams() публичный Метод

Get raw params, w/out module and controller
public getRawParams ( ) : array
Результат array

getUrl() публичный Метод

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
Результат string

process() публичный Метод

Process routing
public process ( ) : Router
Результат Router

processCustom() защищенный Метод

Process custom router
protected processCustom ( ) : boolean
Результат boolean

processDefault() защищенный Метод

Process default router
protected processDefault ( ) : boolean
Результат boolean

processRoute() защищенный Метод

Default routers examples :module/ :module/:controller/ :module/:controller/:key1/:value1/:key2/:value2...
protected processRoute ( ) : boolean
Результат boolean

resetRequest() защищенный Метод

Reset Request
protected resetRequest ( ) : void
Результат void

setBaseUrl() публичный Метод

Set the base URL.
public setBaseUrl ( string $baseUrl ) : void
$baseUrl string
Результат void

setDefaultController() публичный Метод

Set default controller
public setDefaultController ( string $defaultController ) : void
$defaultController string
Результат void

setDefaultModule() публичный Метод

Set default module
public setDefaultModule ( string $defaultModule ) : void
$defaultModule string
Результат void

setErrorController() публичный Метод

Set error controller
public setErrorController ( string $errorController ) : void
$errorController string
Результат void

setErrorModule() публичный Метод

Set error module
public setErrorModule ( string $errorModule ) : void
$errorModule string
Результат void

setParam() публичный Метод

A $value of null will unset the $key if it exists
public setParam ( string $key, mixed $value ) : void
$key string
$value mixed
Результат void

urlCustom() защищенный Метод

Build URL by custom route
protected urlCustom ( string $module, string $controller, array $params ) : string
$module string
$controller string
$params array
Результат string

urlRoute() защищенный Метод

Build URL by default route
protected urlRoute ( string $module, string $controller, array $params ) : string
$module string
$controller string
$params array
Результат string

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

$baseUrl защищенное свойство

base URL
protected $baseUrl

$cleanUri защищенное свойство

REQUEST_URI minus Base URL
protected $cleanUri

$defaultController защищенное свойство

default Controller
protected $defaultController

$defaultModule защищенное свойство

default module
protected $defaultModule

$errorController защищенное свойство

error Controller
protected $errorController

$errorModule защищенное свойство

error module
protected $errorModule

$params защищенное свойство

instance parameters
protected $params

$rawParams защищенное свойство

instance raw parameters
protected $rawParams

$reverse защищенное свойство

reverse map
protected $reverse

$routers защищенное свойство

routers map
protected $routers