CrossPHP

Router
in package
implements RouterInterface

Tags
author

wonli wonli@live.com Class Router

Interfaces, Classes and Traits

RouterInterface
Interface RouterInterface

Table of Contents

DEFAULT_ACTION  = 'index'
默认Action名称
$action  : string
Action名称
$controller  : string
控制器名称
$defaultRouter  : array<string|int, mixed>
$delegate  : Delegate
$originUriRequest  : string
$params  : array<string|int, mixed>
url参数
$uriRequest  : string
__construct()  : mixed
Router constructor.
getAction()  : string
返回action名称
getController()  : string
返回控制器名称
getDefaultRouter()  : array<string|int, mixed>
获取默认控制器
getParams()  : mixed
返回参数
getRouter()  : $this
Router
getRouterAlias()  : string
处理路由别名
getUriRequest()  : string
按类型解析请求字符串
setAction()  : void
设置Action
setController()  : void
设置controller
setParams()  : void
设置参数
setUriRequest()  : $this
设置请求字符串
useDefaulterRouter()  : void
使用默认路由
parseDefaultRouter()  : array<string|int, mixed>
解析默认控制器和方法
parseParams()  : array<string|int, mixed>
解析参数并处理附加参数
parseRequestString()  : array<string|int, mixed>
将字符串参数解析成数组

Constants

DEFAULT_ACTION

默认Action名称

public mixed DEFAULT_ACTION = 'index'

Properties

$action

Action名称

private string $action

$controller

控制器名称

private string $controller

$defaultRouter

private array<string|int, mixed> $defaultRouter = []

$originUriRequest

private string $originUriRequest

$params

url参数

private array<string|int, mixed> $params = []

$uriRequest

private string $uriRequest

Methods

__construct()

Router constructor.

public __construct(Delegate $delegate) : mixed
Parameters
$delegate : Delegate
Return values
mixed

getAction()

返回action名称

public getAction() : string
Return values
string

getController()

返回控制器名称

public getController() : string
Return values
string

getDefaultRouter()

获取默认控制器

public getDefaultRouter() : array<string|int, mixed>
Tags
throws
CoreException
Return values
array<string|int, mixed>

getParams()

返回参数

public getParams() : mixed
Return values
mixed

getRouterAlias()

处理路由别名

public getRouterAlias(string $name) : string
Parameters
$name : string
Return values
string

getUriRequest()

按类型解析请求字符串

public getUriRequest([string $prefix = '/' ][, array<string|int, mixed> &$urlConfig = [] ][, bool $convertHtmlEntities = true ]) : string
Parameters
$prefix : string = '/'
$urlConfig : array<string|int, mixed> = []
$convertHtmlEntities : bool = true
Return values
string

setAction()

设置Action

public setAction( $action) : void
Parameters
$action :
Return values
void

setController()

设置controller

public setController( $controller) : void
Parameters
$controller :
Return values
void

setParams()

设置参数

public setParams( $params) : void
Parameters
$params :
Return values
void

setUriRequest()

设置请求字符串

public setUriRequest(string $uriRequest) : $this
Parameters
$uriRequest : string
Return values
$this

useDefaulterRouter()

使用默认路由

public useDefaulterRouter() : void
Tags
throws
CoreException
Return values
void

parseDefaultRouter()

解析默认控制器和方法

private parseDefaultRouter(string $defaultRouter) : array<string|int, mixed>
Parameters
$defaultRouter : string
Tags
throws
CoreException
Return values
array<string|int, mixed>

parseParams()

解析参数并处理附加参数

private parseParams(array<string|int, mixed> $params, array<string|int, mixed> $urlConfig[, array<string|int, mixed> &$additionParams = [] ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
$urlConfig : array<string|int, mixed>
$additionParams : array<string|int, mixed> = []
Return values
array<string|int, mixed>

parseRequestString()

将字符串参数解析成数组

private static parseRequestString(string $queryString, array<string|int, mixed> $urlConfig) : array<string|int, mixed>
Parameters
$queryString : string
$urlConfig : array<string|int, mixed>
Tags
throws
FrontException
Return values
array<string|int, mixed>

Search results