ApiRouter

扩展 Router

Joomla! API 路由器类

4.0.0

Joomla CMS

方法

__construct

构造函数。

__construct(\Joomla\CMS\Application\CMSApplicationInterface app, mixed||string|int maps = []) : 

1.0

参数

app

CMSApplicationInterface应用程序对象

maps

array<string|int, mixed>一个可选的路由映射数组

响应

混合

createCRUDRoutes

为 CRUD 创建路由映射

createCRUDRoutes( baseName,  controller, mixed||string|int defaults = [],  publicGets = false) : 

4.0.0

参数

baseName

string组件的基本名称。

controller

string包含 CRUD 函数的控制器的名称。

defaults

array<string|int, mixed>在匹配 URL 时使用的默认值数组。

publicGets

bool允许公众进行 GET 请求。

响应

getMatchingRoutes

从所有已知路由中提取匹配当前路由的路由。

getMatchingRoutes() : \Joomla\Router\Route||string|int

4.0.0

响应

array<string|int, Route>

getRoutePath

从路由中获取路径并删除前导或尾随斜杠。

getRoutePath() : 

4.0.0

响应

string

parseApiRoute

解析给定的路由并返回映射到给定路由的控制器的名称。

parseApiRoute( method = 'GET') : mixed||string|int

4.0.0

抛出

InvalidArgumentException

参数

method

string要匹配的请求方法。 GET、POST、PUT、DELETE、HEAD、OPTIONS、TRACE 或 PATCH 之一

响应

array<string|int, mixed>包含控制器和匹配变量的数组。

removeIndexPhpFromPath

从路由的路径中删除 index.php。

removeIndexPhpFromPath( path) : 

4.0.0

参数

path

string路径

响应

string

属性

app

应用程序对象

4.0.0

类型

CMSApplicationInterface