UriInterface
Uri 接口
用于只读访问 URI 的接口。
自 |
1.0 |
---|---|
包 |
Joomla 框架 |
方法
__toString
获取 URI 对象字符串表示形式的魔术方法。
__toString() :
自 |
1.0 |
---|
响应
字符串
getFragment
获取 URI 锚点字符串
getFragment() :
自 |
1.0 |
---|
响应
string
URI 锚点字符串。
getHost
获取 URI 主机
getHost() :
自 |
1.0 |
---|
响应
string
主机名/IP,如果未指定主机名/IP,则为 null。
getPass
获取 URI 密码
getPass() :
自 |
1.0 |
---|
响应
string
密码,如果未指定密码,则为 null。
getPath
获取 URI 路径字符串
getPath() :
自 |
1.0 |
---|
响应
string
URI 路径字符串。
getPort
获取 URI 端口
getPort() :
自 |
1.0 |
---|
响应
int
端口号,如果未指定端口,则为 null。
getQuery
返回扁平查询字符串。
getQuery( toArray = false) : array|string
自 |
1.0 |
---|
参数
- toArray
bool
如果要将查询返回为键 => 值对数组,则为 true。
响应
array<string|int, mixed>|string
查询字符串,可选择性地作为数组。
getScheme
获取 URI 方案(协议)
getScheme() :
自 |
1.0 |
---|
响应
string
URI 方案。
getUser
获取 URI 用户名
getUser() :
自 |
1.0 |
---|
响应
string
用户名,如果未指定用户名,则为 null。
getVar
按名称返回查询变量。
getVar( name, default = null) :
自 |
1.0 |
---|
参数
- 名称
string
要获取的查询变量的名称。- 默认值
string
如果未设置变量,则返回的默认值。
响应
mixed
如果存在,则为请求的查询变量,否则为默认值。
hasVar
检查变量是否存在。
hasVar( name) :
自 |
1.0 |
---|
参数
- 名称
string
要检查的查询变量的名称。
响应
bool
如果变量存在,则为 true。
isSsl
检查当前 URI 是否使用 HTTPS。
isSsl() :
自 |
1.0 |
---|
响应
bool
如果通过 HTTPS 使用 SSL,则为 true。
toString
返回完整的 URI 字符串。
toString(mixed||string|int parts = ['scheme', 'user', 'pass', 'host', 'port', 'path', 'query', 'fragment']) :
自 |
1.0 |
---|
参数
- 部件
array<string|int, mixed>
一个字符串数组,指定要呈现的部件。
响应
string
呈现的 URI 字符串。
常量
SCHEME
包括方案(http、https 等)
值 | 1 |
---|---|
自 |
1.2.0 |
类型
int
USER
包括用户
值 | 2 |
---|---|
自 |
1.2.0 |
类型
int
PASS
包括密码
值 | 4 |
---|---|
自 |
1.2.0 |
类型
int
HOST
包括主机
值 | 8 |
---|---|
自 |
1.2.0 |
类型
int
PORT
包括端口
值 | 16 |
---|---|
自 |
1.2.0 |
类型
int
PATH
包括路径
值 | 32 |
---|---|
自 |
1.2.0 |
类型
int
QUERY
包括查询字符串
值 | 64 |
---|---|
自 |
1.2.0 |
类型
int
FRAGMENT
包括片段
值 | 128 |
---|---|
自 |
1.2.0 |
类型
int
ALL
包括所有可用的 URL 部件(方案、用户、密码、主机、端口、路径、查询、片段)
值 | 255 |
---|---|
自 |
1.2.0 |
类型
int