Joomla! API

下载
启动

Uri

扩展 AbstractUri

Uri 类

此类解析 URI 并提供一个通用接口，用于 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 路径。

delVar

从查询字符串变量中删除一个项目（如果存在）。

delVar( name) :
自

1.0

参数

name

string要删除的变量的名称。

响应

无效

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 字符串。

setFragment

设置 URI 锚点字符串

setFragment( anchor) : \Joomla\Uri\Uri
自

1.0

参数

anchor

stringURI 锚点字符串。

响应

Uri此方法支持链接。

setHost

设置 URI 主机

setHost( host) : \Joomla\Uri\Uri
自

1.0

参数

host

stringURI 主机。

响应

Uri此方法支持链接。

setPass

设置 URI 密码

setPass( pass) : \Joomla\Uri\Uri
自

1.0

参数

pass

stringURI 密码。

响应

Uri此方法支持链接。

setPath

设置 URI 路径字符串

setPath( path) : \Joomla\Uri\Uri
自

1.0

参数

path

stringURI 路径字符串。

响应

Uri此方法支持链接。

setPort

设置 URI 端口

setPort( port) : \Joomla\Uri\Uri
自

1.0

参数

port

intURI 端口号。

响应

Uri此方法支持链接。

setQuery

将查询设置为格式为 foo=bar&x=y 的提供字符串。

setQuery(array|string query) :
自

1.0

参数

query

array<string|int, mixed>|string查询字符串或数组。

响应

无效

setScheme

设置 URI 方案（协议）

setScheme( scheme) : \Joomla\Uri\Uri
自

1.0

参数

scheme

stringURI 方案。

响应

Uri此方法支持链接。

setUser

设置 URI 用户名

setUser( user) : \Joomla\Uri\Uri
自

1.0

参数

user

stringURI 用户名。

响应

Uri此方法支持链接。

setVar

添加查询变量和值，如果变量已存在则替换值，并返回旧值

setVar( name,  value) :
自

1.0

参数

name

string要设置的查询变量的名称。

value

string查询变量的值。

响应

string查询变量的先前值。

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>
  • \ Joomla
  • \ Uri
  • \ Uri