Joomla! 框架 3.x API » \Joomla\Application\WebApplication

类构造函数。

__construct(\Joomla\Application\Controller\ControllerResolverInterface controllerResolver, \Joomla\Router\RouterInterface router, \Joomla\Input\Input|null input = null, \Joomla\Registry\Registry|null config = null, \Joomla\Application\Web\WebClient|null client = null, \Psr\Http\Message\ResponseInterface|null response = null) :

自	2.0.0

参数

controllerResolver: ControllerResolverInterface应用程序的控制器解析器
router: RouterInterface应用程序的路由器
input: Input|null一个可选参数，用于为应用程序的输入对象提供依赖注入。如果参数是 Input 对象，该对象将成为应用程序的输入对象，否则将创建一个默认输入对象。
config: Registry|null一个可选参数，用于为应用程序的配置对象提供依赖注入。如果参数是 Registry 对象，该对象将成为应用程序的配置对象，否则将创建一个默认配置对象。
client: WebClient|null一个可选参数，用于为应用程序的客户端对象提供依赖注入。如果参数是 Web\WebClient 对象，该对象将成为应用程序的客户端对象，否则将创建一个默认客户端对象。
response: ResponseInterface|null一个可选参数，用于为应用程序的响应对象提供依赖注入。如果参数是 ResponseInterface 对象，该对象将成为应用程序的响应对象，否则将创建一个默认响应对象。

Response

混合

用于访问应用程序属性的魔术方法。

__get( name) : \Joomla\Input\Input|null

继承已弃用

自	2.0.0
已弃用	3.0 这是对已弃用读访问的 B/C 代理

参数

name: string属性的名称。

Response

Input|null如果属性名称有效，则为值，否则为 null。

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

allowCache( allow = null) :

继承

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

自	1.0.0

参数

allow: bool允许浏览器缓存为 true。

Response

bool

将内容追加到正文内容

appendBody( content) :

继承

自	1.0.0

参数

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

Response

$this

用于检查当前客户端连接状态以确保其处于活动状态的方法。我们将其包装起来，以将 \connection_status() 函数与我们的代码库隔离，以进行测试。

checkConnectionAlive() :

继承

参见	connection_status()
自	1.0.0

Response

bool如果连接有效且正常，则为 true。

用于检查是否已发送标头的方法。

checkHeadersSent() :

继承

参见	headers_sent()
自	1.0.0

Response

bool如果标头已发送，则为 true。

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

checkToken( method = 'post') :

继承

自	2.0.0

参数

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

Response

bool

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

clearHeaders() :

继承

自	1.0.0

Response

$this

用于关闭应用程序的方法。

close( code) :

继承

自	1.0.0

参数

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

Response

void

检查浏览器的接受编码，并在可能的情况下在将数据发送到客户端之前压缩数据。

compress() :

继承

自	1.0.0

Response

void

用于从服务器环境变量检测请求 URI 的方法。

detectRequestUri() :

继承

自	1.0.0

Response

string请求的 URI

如果已设置调度程序，则调度应用程序事件。

dispatchEvent( eventName, \Joomla\Event\EventInterface|null event = null) : \Joomla\Event\EventInterface|null

继承

自	2.0.0

参数

eventName: string要调度的事件。
event: EventInterface|null事件对象。

Response

EventInterface|null已调度的事件，如果未设置调度程序，则为 null

用于运行应用程序例程的方法。

doExecute() :

自	2.0.0

Response

void

执行应用程序。

execute() :

继承

自	1.0.0

Response

void

返回对象的属性，如果未设置该属性，则返回默认值。

get( key,  default = null) :

继承

自	1.0.0

参数

key: string属性的名称。
default: mixed如果未设置，则为默认值（可选）。

Response

mixed配置的值。

返回正文内容

getBody() :

继承

自	1.0.0

Response

string响应正文作为字符串。

获取事件调度程序。

getDispatcher() : \Joomla\Event\DispatcherInterface

继承

自	1.2.0
抛出	`UnexpectedValueException`如果未设置调度程序，可能会抛出。

Response

DispatcherInterface

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

getFormToken( forceNew = false) :

继承

自	2.0.0

参数

forceNew: bool如果为 true，则强制创建新的令牌

Response

string哈希的变量名称

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

getHeaders() : mixed||string|int

继承

自	1.0.0

Response

array<string|int, mixed>

检查给定值是否可以成功映射到有效的 http 状态值

getHttpStatusValue(string|int value) :

继承

自	1.8.0

参数

value: string|int作为 int 或字符串给定的状态

Response

string

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

getInput() : \Joomla\Input\Input

继承抽象

自	2.0.0

Response

Input

获取日志记录器。

getLogger() : \Psr\Log\LoggerInterface

继承

自	1.0.0

Response

LoggerInterface

获取 PSR-7 响应对象。

getResponse() : \Psr\Http\Message\ResponseInterface

继承

自	2.0.0

Response

ResponseInterface

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

getSession() : \Joomla\Session\SessionInterface

继承

自	2.0.0

Response

SessionInterface会话对象

用于向客户端发送标头的方法。

header( string,  replace = true,  code = null) :

继承

参见	header()
自	1.0.0

参数

string: string标头字符串。
replace: bool可选的 replace 参数指示标头是否应替换以前的类似标头，或添加第二个相同类型的标头。
code: int将 HTTP 响应代码强制为指定的值。请注意，此参数仅在字符串不为空时有效。

Response

void

自定义初始化方法。

initialise() :

继承

在 AbstractApplication::__construct 方法的末尾调用。这用于开发人员为其应用程序类注入初始化代码。

自	1.0.0

Response

void

测试字符串是否仅包含 7 位 ASCII 字节。

isAscii( str) :

继承静态

您可以使用它来有条件地检查字符串是否需要作为 UTF-8 处理，如果它只是 ASCII，则可能会通过使用本机 PHP 等效项来提供性能优势，例如；

自	1.4.0

参数

str: string要测试的字符串。

Response

bool如果字符串全部为 ASCII，则为 true

检查状态是否为重定向状态

isRedirectState( state) :

继承

自	1.8.0

参数

state: intHTTP 状态代码。

Response

bool

确定我们是否使用安全 (SSL) 连接。

isSslConnection() :

继承

自	1.0.0

Response

bool如果使用 SSL，则为 true，否则为 false。

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

isValidHttpStatus( code) :

继承

自	1.8.1

参数

code: int潜在的状态代码

Response

bool

用于加载应用程序的系统 URI 字符串的方法。

loadSystemUris( requestUri = null) :

继承

自	1.0.0

参数

requestUri: string一个可选的请求 URI，用于代替从服务器环境变量中检测到的 URI。

Response

void

将内容追加到正文内容

prependBody( content) :

继承

自	1.0.0

参数

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

Response

$this

重定向到另一个 URL。

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

继承

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

抛出	`InvalidArgumentException`
自	1.0.0

参数

url: string要重定向到的 URL。只能是 http/https URL
status: int|bool要提供的 HTTP 状态代码。默认情况下假设为 303。

Response

void

用于将应用程序响应发送到客户端的方法。所有标头将在主要应用程序输出数据之前发送。

respond() :

继承

自	1.0.0

Response

void

发送响应标头。

sendHeaders() :

继承

自	1.0.0

Response

$this

修改对象属性，如果属性不存在，则创建属性。

set( key,  value = null) :

继承

自	1.0.0

参数

key: string属性的名称。
value: mixed要设置的属性的值（可选）。

Response

mixed属性的先前值

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

setBody( content) :

继承

自	1.0.0

参数

content: string设置为响应主体的内容。

Response

$this

设置应用程序的配置。

setConfiguration(\Joomla\Registry\Registry config) :

继承

自	1.0.0

参数

config: Registry包含配置的注册表对象。

Response

$this

设置要使用的调度器。

setDispatcher(\Joomla\Event\DispatcherInterface dispatcher) :

继承

自	1.2.0

参数

dispatcher: DispatcherInterface要使用的调度器。

Response

$this

用于设置响应头的函数。

setHeader( name,  value,  replace = false) :

继承

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

自	1.0.0

参数

name: string要设置的标头的名称。
value: string要设置的标头的值。
replace: bool如果要替换所有具有相同名称的标头，则为true。

Response

$this

设置PSR-7响应对象。

setResponse(\Psr\Http\Message\ResponseInterface response) :

继承

自	2.0.0

参数

response: ResponseInterface响应对象

Response

void

设置应用程序要使用的会话，如果需要。

setSession(\Joomla\Session\SessionInterface session) :

继承

自	2.0.0

参数

session: SessionInterface会话对象。

Response

$this

继承

应用程序输入对象

类型

Input

事件调度器

继承

自	1.2.0

类型

DispatcherInterface|null

应用程序配置对象。

继承

自	1.0.0

类型

Registry

应用程序输入对象。

继承

自	1.0.0

类型

Input

字符编码字符串。

继承

自	1.0.0

类型

string

响应的MIME类型。

继承

自	1.0.0

类型

string

HTTP协议版本。

继承

自	1.9.0

类型

string

用于响应头的正文修改日期。

继承

自	1.0.0

类型

DateTime

应用程序客户端对象。

继承

自	1.0.0

类型

WebClient

应用程序响应对象。

继承

自	1.0.0

类型

ResponseInterface

是否启用了缓存？

继承

自	2.0.0

类型

bool

整数HTTP响应代码到标头中完整HTTP状态的映射。

继承

自	1.6.0
link

类型

array<string|int, mixed>

应用程序会话对象。

继承

自	2.0.0

类型

SessionInterface

应用程序的控制器解析器。

自	2.0.0

类型

ControllerResolverInterface

应用程序的路由器。

自	2.0.0

类型

RouterInterface