AbstractUri
实现 UriInterface基本 Joomla Uri 类
| 自版本 |
1.0 |
|---|---|
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct( uri = null) :
您可以将 URI 字符串传递给构造函数以初始化特定的 URI。
| 自版本 |
1.0 |
|---|
参数
- uri
string可选的 URI 字符串
返回值
混合类型
__toString
获取 UriInterface 对象的字符串表示形式的魔术方法。
__toString() :
| 自版本 |
1.0 |
|---|
返回值
字符串
buildQuery
从数组构建查询（PHP parse_str() 的反向操作）。
buildQuery(mixed||string|int params) :
| 参见 | parse_str() |
|---|---|
| 自版本 |
1.0 |
参数
- params
array<string|int, mixed>要作为查询字符串返回的键 => 值对数组。
返回值
string生成的查询字符串。
cleanPath
解析路径中的 //、../ 和 ./ 并返回结果。
cleanPath( path) :
例如：/foo/bar/../boo.php => /foo/boo.php /foo/bar/../../boo.php => /boo.php /foo/bar/.././/boo.php => /foo/boo.php
| 自版本 |
1.0 |
|---|
参数
- path
string要清理的 URI 路径。
返回值
string已清理和解析的 URI 路径。
getFragment
获取 URI 锚字符串
getFragment() :
| 自版本 |
1.0 |
|---|
返回值
stringURI 锚字符串。
getHost
获取 URI 主机
getHost() :
| 自版本 |
1.0 |
|---|
返回值
string主机名/IP 或如果未指定主机名/IP 则为 null。
getPass
获取 URI 密码
getPass() :
| 自版本 |
1.0 |
|---|
返回值
string密码，或如果未指定密码则为 null。
getPath
获取 URI 路径字符串
getPath() :
| 自版本 |
1.0 |
|---|
返回值
stringURI 路径字符串。
getPort
获取 URI 端口
getPort() :
| 自版本 |
1.0 |
|---|
返回值
int端口号，或如果未指定端口则为 null。
getQuery
返回扁平化的查询字符串。
getQuery( toArray = false) : string|array
| 自版本 |
1.0 |
|---|
参数
- toArray
bool如果要将查询作为键 => 值对数组返回，则为 true。
返回值
string|array<string|int, mixed>根据函数参数，查询字符串或查询字符串中各部分的数组
getScheme
获取 URI 方案（协议）
getScheme() :
| 自版本 |
1.0 |
|---|
返回值
stringURI 方案。
getUser
获取 URI 用户名
getUser() :
| 自版本 |
1.0 |
|---|
返回值
string用户名，或如果未指定用户名则为 null。
getVar
按名称返回查询变量。
getVar( name, default = null) :
| 自版本 |
1.0 |
|---|
参数
- name
string要获取的查询变量的名称。- default
string如果未设置变量，则返回的默认值。
返回值
mixed如果存在，则为请求的查询变量，否则为默认值。
hasVar
检查变量是否存在。
hasVar( name) :
| 自版本 |
1.0 |
|---|
参数
- name
string要检查的查询变量的名称。
返回值
bool如果变量存在，则为 true。
isSsl
检查当前 URI 是否使用 HTTPS。
isSsl() :
| 自版本 |
1.0 |
|---|
返回值
bool如果通过 HTTPS 使用 SSL，则为 true。
parse
解析给定的 URI 并填充类字段。
parse( uri) :
| 自版本 |
1.0 |
|---|
参数
- uri
string要解析的 URI 字符串。
返回值
bool成功时为 true。
render
返回完整的 uri 字符串。
render( parts = self::ALL) :
| 自版本 |
1.2.0 |
|---|
参数
- parts
int指定要呈现的部分的位掩码。
返回值
string呈现的 URI 字符串。
toString
返回完整的 URI 字符串。
toString(mixed||string|int parts = ['scheme', 'user', 'pass', 'host', 'port', 'path', 'query', 'fragment']) :
| 自版本 |
1.0 |
|---|
参数
- parts
array<string|int, mixed>指定要呈现的部分的字符串数组。
返回值
string呈现的 URI 字符串。
属性
uri
原始 URI
| 自版本 |
1.0 |
|---|
类型
字符串
scheme
协议
| 自版本 |
1.0 |
|---|
类型
字符串
host
主机
| 自版本 |
1.0 |
|---|
类型
字符串
port
端口
| 自版本 |
1.0 |
|---|
类型
int
user
用户名
| 自版本 |
1.0 |
|---|
类型
字符串
pass
密码
| 自版本 |
1.0 |
|---|
类型
字符串
path
路径
| 自版本 |
1.0 |
|---|
类型
字符串
query
查询
| 自版本 |
1.0 |
|---|
类型
字符串
fragment
锚点
| 自版本 |
1.0 |
|---|
类型
字符串
vars
查询变量哈希
| 自版本 |
1.0 |
|---|
类型
array<string|int, mixed>