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

类构造函数。

__construct(\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) :

自	1.0.0

参数

输入: Input|null一个可选参数，为应用程序的输入对象提供依赖注入。如果参数是 Input 对象，则该对象将成为应用程序的输入对象，否则将创建默认的输入对象。
配置: Registry|null一个可选参数，为应用程序的配置对象提供依赖注入。如果参数是 Registry 对象，则该对象将成为应用程序的配置对象，否则将创建默认的配置对象。
客户端: WebClient|null一个可选参数，为应用程序的客户端对象提供依赖注入。如果参数是 Web\WebClient 对象，则该对象将成为应用程序的客户端对象，否则将创建默认的客户端对象。
响应: ResponseInterface|null一个可选参数，为应用程序的响应对象提供依赖注入。如果参数是 ResponseInterface 对象，则该对象将成为应用程序的响应对象，否则将创建默认的响应对象。

响应

混合

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

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

已弃用

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

参数

名称: string属性的名称。

响应

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

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

allowCache( allow = null) :

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

自	1.0.0

参数

允许: bool如果允许浏览器缓存，则为 true。

响应

布尔值

将内容追加到正文内容

appendBody( content) :

自	1.0.0

参数

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

响应

this

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

checkConnectionAlive() :

参见	connection_status()
自	1.0.0

响应

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

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

checkHeadersSent() :

参见	headers_sent()
自	1.0.0

响应

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

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

clearHeaders() :

自	1.0.0

响应

this

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

close( code) :

继承

自	1.0.0

参数

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

响应

无效

检查浏览器的 Accept-Encoding，如果可能，在发送到客户端之前压缩数据。

compress() :

自	1.0.0

响应

无效

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

detectRequestUri() :

自	1.0.0

响应

string请求的 URI

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

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

继承

自	2.0.0

参数

事件名称: string要调度的事件。
事件: EventInterface|null事件对象。

响应

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

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

doExecute() :

继承抽象

最有可能的是，您需要实例化一个控制器并执行它，或者直接执行某种任务。

自	1.0.0

响应

混合

执行应用程序。

execute() :

自	1.0.0

响应

无效

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

get( key,  default = null) :

继承

自	1.0.0

参数

键: string属性的名称。
默认: mixed默认值（可选），如果没有设置则使用该值。

响应

mixed配置的值。

返回正文内容

getBody() :

自	1.0.0

响应

string响应正文作为字符串。

获取事件调度程序。

getDispatcher() : \Joomla\Event\DispatcherInterface

继承

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

响应

调度程序接口

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

getHeaders() : mixed||string|int

自	1.0.0

响应

array<string|int, mixed>

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

getHttpStatusValue(string|int value) :

自	1.8.0

参数

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

响应

字符串

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

getInput() : \Joomla\Input\Input

自	2.0.0

响应

输入

获取记录器。

getLogger() : \Psr\Log\LoggerInterface

继承

自	1.0.0

响应

记录器接口

获取 PSR-7 响应对象。

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

自	2.0.0

响应

响应接口

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

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

参见	header()
自	1.0.0

参数

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

响应

无效

自定义初始化方法。

initialise() :

继承

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

自	1.0.0

响应

无效

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

isAscii( str) :

静态

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

自	1.4.0

参数

字符串: string要测试的字符串。

响应

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

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

isRedirectState( state) :

自	1.8.0

参数

状态: intHTTP 状态代码。

响应

布尔值

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

isSslConnection() :

自	1.0.0

响应

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

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

isValidHttpStatus( code) :

自	1.8.1

参数

代码: int潜在的状态代码

响应

布尔值

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

loadSystemUris( requestUri = null) :

自	1.0.0

参数

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

响应

无效

将内容追加到正文内容

prependBody( content) :

自	1.0.0

参数

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

响应

this

重定向到另一个 URL。

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

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

抛出	`无效参数异常`
自	1.0.0

参数

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

响应

无效

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

respond() :

自	1.0.0

响应

无效

发送响应标头。

sendHeaders() :

自	1.0.0

响应

this

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

set( key,  value = null) :

继承

自	1.0.0

参数

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

响应

mixed属性的先前值

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

setBody( content) :

自	1.0.0

参数

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

响应

this

设置应用程序的配置。

setConfiguration(\Joomla\Registry\Registry config) :

继承

自	1.0.0

参数

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

响应

this

设置要使用的调度程序。

setDispatcher(\Joomla\Event\DispatcherInterface dispatcher) :

继承

自	1.2.0

参数

调度程序: DispatcherInterface要使用的调度程序。

响应

this

用于设置响应标头的方法。

setHeader( name,  value,  replace = false) :

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

自	1.0.0

参数

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

响应

this

设置 PSR-7 响应对象。

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

自	2.0.0

参数

响应: ResponseInterface响应对象

响应

无效

应用程序输入对象

类型

输入

事件调度程序

继承

自	1.2.0

类型

DispatcherInterface|null

应用程序配置对象。

继承

自	1.0.0

类型

注册表

应用程序输入对象。

自	1.0.0

类型

输入

字符编码字符串。

自	1.0.0

类型

字符串

响应 MIME 类型。

自	1.0.0

类型

字符串

HTTP 协议版本。

自	1.9.0

类型

字符串

响应头部的正文修改日期。

自	1.0.0

类型

DateTime

应用程序客户端对象。

自	1.0.0

类型

WebClient

应用程序响应对象。

自	1.0.0

类型

响应接口

是否启用缓存？

自	2.0.0

类型

布尔值

一个整数 HTTP 响应代码到完整 HTTP 状态的映射，用于标头。

自	1.6.0
link

类型

array<string|int, mixed>

自	1.0.0
只读属性 Input	应用程序输入对象
包	Joomla 框架