UriImmutable
继承自 AbstractUriUriImmutable 类
这是 AbstractUri 类的不可变版本。
| 自 |
1.0 |
|---|---|
| 包 |
Joomla 框架 |
方法
__construct
这是一个特殊的构造函数，它阻止再次调用 __construct 方法。
__construct( uri = null) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- uri
string可选的 URI 字符串
响应
mixed
__set
防止设置未声明的属性。
__set( name, value) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- name
string这是一个不可变对象，不允许设置 $name。- value
mixed这是一个不可变对象，不允许设置 $value。
响应
void此方法始终抛出异常。
__toString
魔术方法，用于获取 UriInterface 对象的字符串表示形式。
__toString() :
| 自 |
1.0 |
|---|
响应
string
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 或 null（如果未指定主机名/IP）。
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 |
|---|
类型
string
scheme
协议
| 自 |
1.0 |
|---|
类型
string
host
主机
| 自 |
1.0 |
|---|
类型
string
port
端口
| 自 |
1.0 |
|---|
类型
int
user
用户名
| 自 |
1.0 |
|---|
类型
string
pass
密码
| 自 |
1.0 |
|---|
类型
string
path
路径
| 自 |
1.0 |
|---|
类型
string
query
查询
| 自 |
1.0 |
|---|
类型
string
fragment
锚点
| 自 |
1.0 |
|---|
类型
string
vars
查询变量哈希
| 自 |
1.0 |
|---|
类型
array<string|int, mixed>
constructed
类是否已实例化的标志
| 自 |
1.0 |
|---|
类型
bool