Joomla! API

下载
启动

SessionAwareWebApplicationInterface

扩展 WebApplicationInterface

应用程序子接口，定义了一个支持会话的 Web 应用程序类

自

2.0.0
包

Joomla 框架

方法

allowCache

设置/获取响应的可缓存状态。

allowCache( allow = null) :
继承

如果设置了 $allow，则设置响应的可缓存状态。始终返回当前状态。

自

2.0.0

参数

allow

bool允许浏览器缓存。

响应

bool

appendBody

将内容追加到正文内容

appendBody( content) :
继承
自

2.0.0

参数

content

string要追加到响应正文的内容。

响应

$this

checkToken

检查请求中是否存在表单令牌。

checkToken( method = 'post') :
自

2.0.0

参数

方法

string要查找令牌键的请求方法。

响应

bool

clearHeaders

清除任何已设置的响应标头的方法。

clearHeaders() :
继承
自

2.0.0

响应

$this

close

关闭应用程序的方法。

close( code) :
继承
自

2.0.0

参数

code

int退出代码（可选；默认为 0）。

响应

void

execute

执行应用程序。

execute() :
继承
自

2.0.0

响应

void

getBody

返回正文内容

getBody() :
继承
自

2.0.0

响应

mixed响应正文作为字符串。

getFormToken

确定用于反欺骗变量名称的哈希值的方法

getFormToken( forceNew = false) :
自

2.0.0

参数

forceNew

bool如果为真，则强制创建一个新的令牌

响应

string哈希的变量名称

getHeaders

获取将响应发送到客户端时要发送的响应标头数组的方法。

getHeaders() : mixed||string|int
继承
自

2.0.0

响应

array<string|int, mixed>

getInput

获取应用程序输入对象的方法。

getInput() : \Joomla\Input\Input
继承
自

2.0.0

响应

输入

getResponse

获取 PSR-7 响应对象。

getResponse() : \Psr\Http\Message\ResponseInterface
继承
自

2.0.0

响应

ResponseInterface

getSession

获取应用程序会话对象的方法。

getSession() : \Joomla\Session\SessionInterface
自

2.0.0

响应

SessionInterface会话对象

isSslConnection

确定我们是否正在使用安全（SSL）连接。

isSslConnection() :
继承
自

2.0.0

响应

bool如果使用 SSL，则为真，否则为假。

isValidHttpStatus

检查值是否为有效的 HTTP 状态代码

isValidHttpStatus( code) :
继承
自

2.0.0

参数

code

int潜在的状态代码

响应

bool

prependBody

将内容添加到正文内容前面

prependBody( content) :
继承
自

2.0.0

参数

content

string要添加到响应正文前面的内容。

响应

$this

redirect

重定向到另一个 URL。

redirect( url, int|bool status = 303) :
继承

如果标头尚未发送，则重定向将通过标头中指向新位置的“301 Moved Permanently”或“303 See Other”代码来完成。如果标头已发送，则将通过 JavaScript 语句来完成。

自

2.0.0
抛出

InvalidArgumentException

参数

url

string要重定向到的 URL。只能是 http/https URL

status

int|bool要提供的 HTTP 状态代码。默认情况下假设为 303。

响应

void

sendHeaders

发送响应标头。

sendHeaders() :
继承
自

2.0.0

响应

$this

setBody

设置正文内容。如果正文内容已定义，这将替换它。

setBody( content) :
继承
自

2.0.0

参数

content

string要设置为响应正文的内容。

响应

$this

setHeader

设置响应标头的方法。

setHeader( name,  value,  replace = false) :
继承

如果设置了 replace 标志，则所有具有给定名称的标头都将被新的标头替换。标头存储在内部数组中，以便在将站点发送到浏览器时发送。

自

2.0.0

参数

name

string要设置的标头的名称。

value

string要设置的标头的值。

replace

bool如果要替换任何具有相同名称的标头，则为真。

响应

$this

setResponse

设置 PSR-7 响应对象。

setResponse(\Psr\Http\Message\ResponseInterface response) :
继承
自

2.0.0

参数

response

ResponseInterface响应对象

响应

void

setSession

根据需要设置应用程序要使用的会话。

setSession(\Joomla\Session\SessionInterface session) :
自

2.0.0

参数

session

SessionInterface会话对象。

响应

$this

  • \ Joomla
  • \ Application
  • \ SessionAwareWebApplicationInterface