Joomla! CMS 5.1.x API » \Joomla\CMS\Application\ApiApplication

类构造函数。

__construct(\Joomla\Input\Json input = null, \Joomla\Registry\Registry config = null, \Joomla\Application\Web\WebClient client = null, \Joomla\DI\Container container = null) :

自从	4.0.0

参数

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

响应

混合

将内容类型与存储的格式之间的映射添加到映射中。请注意，格式类型不能被覆盖。

addFormatMap( contentHeader,  format) :

自从	4.0.0

参数

内容头: string内容头
格式: string内容类型格式

响应

空

会话开始后，我们需要用一些默认值填充它。

afterSessionStart(\Joomla\Session\SessionEvent event) :

继承

自从	3.0.1

参数

事件: SessionEvent正在触发的会话事件

响应

空

启动具有指定名称的组件。

bootComponent( component) : \Joomla\CMS\Extension\ComponentInterface

继承

自从	4.0.0

参数

组件: string要启动的组件。

响应

ComponentInterface

启动具有指定名称的模块。

bootModule( module,  applicationName) : \Joomla\CMS\Extension\ModuleInterface

继承

自从	4.0.0

参数

模块: string要启动的模块
应用程序名称: string应用程序名称

响应

ModuleInterface

启动具有指定名称和类型的插件。

bootPlugin( plugin,  type) : \Joomla\CMS\Extension\PluginInterface

继承

自从	4.0.0

参数

插件: string插件名称
类型: string插件类型

响应

PluginInterface

检查用户会话。

checkSession() :

继承

如果会话记录不存在，则初始化它。如果会话是新的，则创建会话变量

自从	3.2
抛出	`RuntimeException`

响应

空

检查请求中的表单令牌。

checkToken( method = 'post') :

继承

与 getFormToken 结合使用。

自从	4.0.0

参数

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

响应

bool如果找到且有效，则为真，否则为假。

检查用户是否需要重置密码。

checkUserRequireReset( option,  view,  layout,  tasks) :

继承

如果用户需要重置密码，则会重定向到管理密码重置的页面。

抛出	`异常`

参数

选项: string管理密码重置的选项
视图: string管理密码重置的视图
布局: string管理密码重置的视图的布局
任务: string允许的任务

响应

空

允许应用程序加载自定义或默认身份。

createExtensionNamespaceMap() :

继承

自从	4.0.0

响应

空

分派应用程序

dispatch( component = null) :

自从	4.0.0

参数

组件: string正在呈现的组件。

响应

空

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

doExecute() :

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

自从	4.0.0

响应

空

将系统消息入队。

enqueueMessage( msg,  type = self::MSG_INFO) :

继承

自从	3.2

参数

消息: string要入队的消息。
类型: string消息类型。默认值为 message。

响应

空

执行应用程序。

execute() :

继承

自从	3.2

响应

空

刷新媒体版本以刷新可版本化资产

flushAssets() :

继承

自从	3.2

响应

空

返回应用程序路由器对象。

getApiRouter() : \Joomla\CMS\Router\ApiRouter

已弃用

自从	4.0.0
已弃用	4.3 将在 6.0 中删除注入路由器或从依赖注入容器中加载它例如：Factory::getContainer()->get(ApiRouter::class);

响应

ApiRouter

获取配置值。

getCfg( varname,  default = null) :

继承已弃用

自从	3.2
已弃用	3.2 将在 6.0 中删除使用 get() 而不是例如：Factory::getApplication()->get($varname, $default);

参数

varname: string要获取的值的名称。
默认: string要返回的默认值

响应

mixed用户状态。

获取当前运行应用程序的客户端 ID。

getClientId() :

继承

自从	3.2

响应

int客户端标识符。

检索应用程序配置对象。

getConfig() : \Joomla\Registry\Registry

继承

自从	4.0.0

响应

Registry

获取 DI 容器。

getContainer() : \Joomla\DI\Container

继承抽象

自从	4.0.0
抛出	`ContainerNotFoundException`如果未设置容器，则可能会抛出该异常。

响应

容器

获取事件分派器。

getDispatcher() : \Joomla\Event\DispatcherInterface

继承抽象

自从	4.0.0
抛出	`UnexpectedValueException`如果未设置分派器，则可能会抛出该异常。

响应

DispatcherInterface

获取应用程序文档对象的方法。

getDocument() : \Joomla\CMS\Document\Document

继承

自从	1.7.3

响应

Document文档对象

确定防欺骗变量名称的哈希值的方法

getFormToken( forceNew = false) :

继承

自从	4.0.0

参数

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

响应

string哈希的变量名称

获取应用程序身份。

getIdentity() : \Joomla\CMS\User\User

继承

自从	4.0.0

响应

用户

返回对全局 CmsApplication 对象的引用，仅在它不存在时创建它。

getInstance( name = null,  prefix = 'JApplication', \Joomla\DI\Container container = null) : \Joomla\CMS\Application\CmsApplication

继承静态已弃用

此方法必须调用为：$web = CmsApplication::getInstance();

自从	3.2
抛出	`RuntimeException`
已弃用	4.0 将在 6.0 中删除使用 DI 容器中的应用程序服务代替例如：Factory::getContainer()->get($name);

参数

名称: string要实例化的 CmsApplication 类的名称（可选）。
前缀: string对象的类名前缀。
容器: Container|null一个可选的依赖注入容器，注入到应用程序中。

响应

CmsApplication

获取应用程序语言对象的方法。

getLanguage() : \Joomla\CMS\Language\Language

继承

自从	1.7.3

响应

Language语言对象

获取记录器。

getLogger() : \Psr\Log\LoggerInterface

继承抽象

自从	4.0.0

响应

LoggerInterface

返回应用程序 \JMenu 对象。

getMenu( name = null, mixed||string|int options = []) : \Joomla\CMS\Menu\AbstractMenu

继承

自从	3.2

参数

名称: string应用程序/客户端的名称。
选项: array<string|int, mixed>一个可选的关联配置设置数组。

响应

AbstractMenu

获取系统消息队列。

getMessageQueue( clear = false) : mixed||string|int

继承

自从	3.2

参数

清除: bool清除当前附加到应用程序对象的邮件

响应

array<string|int, mixed>系统消息队列。

获取当前运行应用程序的名称。

getName() :

继承

自从	3.2

响应

string应用程序的名称。

返回应用程序路径对象。

getPathway() : \Joomla\CMS\Pathway\Pathway

继承

自从	3.2

响应

路径

返回应用程序路由器对象。

getRouter( name = null, mixed||string|int options = []) : \Joomla\CMS\Router\Router

继承静态已弃用

自从	3.2
已弃用	4.3 将在 6.0 中删除注入路由器或从依赖注入容器中加载它例如：Factory::getContainer()->get($name);

参数

名称: string应用程序的名称。
选项: array<string|int, mixed>一个可选的关联配置设置数组。

响应

路由器

获取当前模板的名称。

getTemplate( params = false) : string|\stdClass

自从	4.0.0

参数

参数: bool返回模板参数为真

响应

string|stdClass

获取用户状态。

getUserState( key,  default = null) :

继承

自从	3.2

参数

键: string状态的路径。
默认: mixed可选的默认值，如果内部值为 null，则返回该值。

响应

mixed用户状态或 null。

获取用户状态变量的值。

getUserStateFromRequest( key,  request,  default = null,  type = 'none') :

继承

自从	3.2

参数

键: string用户状态变量的键。
请求: string请求中传递的变量的名称。
默认: string如果未找到变量的默认值。可选。
类型: string变量的过滤器。可选。@see \Joomla\CMS\Filter\InputFilter::clean() 获取有效值。

响应

mixed请求用户状态。

处理预检请求。

handlePreflight( method, \Joomla\CMS\Router\ApiRouter router) :

自从	4.0.0

参数

方法: stringREST 动词
路由器: ApiRouterAPI 路由对象

响应

空

不再使用

hasUserConfiguredTwoFactorAuthentication() :

继承已弃用

自从	4.0.0
抛出	`异常`
已弃用	4.2 将在 6.0 中删除将在没有替换的情况下删除

响应

布尔

初始化应用程序。

initialiseApp(mixed||string|int options = []) :

继承

自从	3.2

参数

选项: array<string|int, mixed>一个可选的关联配置设置数组。

响应

空

应用程序实例是 CLI 还是基于 Web 的应用程序的标志。

isCli() :

继承已弃用

辅助函数，您应该使用本机 PHP 函数来检测它是否是 CLI 应用程序。

自从	4.0.0
已弃用	4.0 将在 6.0 中删除将在没有替换的情况下删除

响应

布尔

检查客户端接口的名称。

isClient( identifier) :

继承

自从	3.7.0

参数

标识符: string应用程序接口的字符串标识符

响应

bool如果此应用程序属于给定类型的客户端接口，则为真。

检查客户端配置中是否强制使用 HTTPS。

isHttpsForced( clientId = null) :

继承

自从	3.7.3

参数

clientId: int一个可选的客户端 ID（默认为当前应用程序客户端）。

响应

bool如果为客户端强制使用，则为真，否则为假。

不再使用

isTwoFactorAuthenticationRequired() :

继承已弃用

自从	4.0.0
抛出	`异常`
已弃用	4.2 将在 6.0 中删除将在没有替换的情况下删除

响应

布尔

允许应用程序加载自定义或默认文档。

loadDocument(\Joomla\CMS\Document\Document document = null) : \Joomla\CMS\Application\WebApplication

继承

创建此对象的逻辑和选项对于默认情况来说足够通用，但在许多应用程序中，根据更具体的需要重写此方法并根据需要创建文档是有意义的。

自从	1.7.3

参数

文档: Document|null一个可选的文档对象。如果省略，将创建工厂文档。

响应

WebApplication此方法是可链接的。

加载扩展。

loadExtension( type,  extensionName,  extensionPath) : \Joomla\CMS\Extension\ComponentInterface|\Joomla\CMS\Extension\ModuleInterface|\Joomla\CMS\Extension\PluginInterface

继承

自从	4.0.0

参数

类型: string扩展类型
扩展名称: string扩展名称
扩展路径: string扩展的路径

响应

ComponentInterface|ModuleInterface|PluginInterface

允许应用程序加载自定义或默认身份。

loadIdentity(\Joomla\CMS\User\User identity = null) :

继承

自从	4.0.0

参数

身份: User一个可选的身份对象。如果省略，将创建一个空的用户对象。

响应

$this

允许应用程序加载自定义或默认语言。

loadLanguage(\Joomla\CMS\Language\Language language = null) : \Joomla\CMS\Application\WebApplication

继承

创建此对象的逻辑和选项对于默认情况来说足够通用，但在许多应用程序中，根据更具体的需要重写此方法并根据需要创建语言是有意义的。

自从	1.7.3

参数

语言: Language|null一个可选的语言对象。如果省略，将创建工厂语言。

响应

WebApplication此方法是可链接的。

加载应用程序的库语言文件

loadLibraryLanguage() :

继承

自从	3.6.3

响应

空

从文件系统创建 CMS 插件。

loadPluginFromFilesystem( plugin,  type) : \Joomla\CMS\Plugin\CMSPlugin

继承

自从	4.0.0

参数

插件: string插件
类型: string类型

响应

CMSPlugin

允许应用程序加载自定义或默认会话。

loadSession(\Joomla\CMS\Session\Session session = null) : \Joomla\CMS\Application\WebApplication

继承已弃用

创建此对象的逻辑和选项对于默认情况来说足够通用，但在许多应用程序中，根据更具体的需要重写此方法并根据需要创建会话是有意义的。

自从	1.7.3
已弃用	4.3 将在 6.0 中删除，会话应作为服务注入。

参数

会话: Session|null一个可选的会话对象。如果省略，将创建会话。

响应

WebApplication此方法是可链接的。

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

loadSystemUris( requestUri = null) :

继承

自从	1.7.3

参数

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

响应

空

登录身份验证函数。

login(mixed||string|int credentials, mixed||string|int options = []) : bool|\Exception

继承

用户名和编码密码将传递给 onUserLogin 事件，该事件负责用户验证。成功的验证会使用用户的详细信息更新当前会话记录。

用户名和编码密码作为凭据（以及其他可能性）发送到每个观察者（身份验证插件）以进行用户验证。成功的验证将使用用户详细信息更新当前会话。

自从	3.2

参数

凭据: array<string|int, mixed>Array('username' => string, 'password' => string)
选项: array<string|int, mixed>Array('remember' => boolean)

响应

bool|Exception成功时为真，如果失败或配置了静默处理，则为假，或者在身份验证错误时为 \Exception 对象。

注销身份验证函数。

logout( userid = null, mixed||string|int options = []) :

继承

将当前用户信息传递给 onUserLogout 事件，并将当前会话记录恢复为“匿名”参数。如果任何身份验证插件未成功完成注销例程，则整个方法失败。任何引发的错误都应在插件中完成，因为这提供了提供更多信息的能力，说明例程可能失败的原因。

自从	3.2

参数

用户 ID: int要加载的用户 - 可以是整数或字符串 - 如果是字符串，则会自动转换为 ID
选项: array<string|int, mixed>Array('clientid' => 客户端 ID 数组)

响应

bool成功时为真

重定向到另一个 URL。

redirect( url,  status = 303) :

继承

如果尚未发送标题，则重定向将使用标题中的“301 永久移动”或“303 另见”代码来完成，该代码指向新位置。如果标题已发送，则将使用 JavaScript 语句来完成。

自从	3.2

参数

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

响应

空

向特定事件组注册处理程序。

registerEvent( event, 
Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768
|Array handler) :

继承

自从	4.0.0

参数

事件: string事件名称。
处理程序: callable处理程序，一个函数或一个事件对象的实例。

响应

$this

渲染是将文档缓冲区推送到模板占位符、从文档中检索数据并将其推送到应用程序响应缓冲区的过程。

render() :

自从	4.0.0
注意	应覆盖渲染以摆脱主题文件。

响应

空

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

respond(mixed||string|int options = []) :

自从	4.0.0

参数

选项: array<string|int, mixed>一个可选的参数，用于启用 CORS。（临时）

响应

空

路由应用程序。

route() :

路由是检查请求环境以确定哪个组件应接收请求的过程。然后，在分派应用程序时处理请求对象中设置的组件可选参数。

自从	4.0.0

响应

空

确保几个核心系统输入变量不是数组。

sanityCheckSystemVariables() :

继承

自从	3.9

响应

空

设置内部菜单工厂。

setMenuFactory(\Joomla\CMS\Menu\MenuFactoryInterface menuFactory) :

继承

自从	4.2.0

参数

菜单工厂: MenuFactoryInterface菜单工厂

响应

空

设置日志记录功能。

setupLogging() :

继承

自从	4.0.0

响应

空

设置用户状态变量的值。

setUserState( key,  value) :

继承

自从	3.2

参数

键: string状态的路径。
价值: mixed变量的值。

响应

mixed如果存在，则为先前的状态。否则为 null。

在返回字符串之前发送所有标题

toString( compress = false) :

继承

自从	3.2

参数

压缩: bool如果为真，则压缩数据

响应

字符串

调用与事件组关联的所有处理程序。

triggerEvent( eventName, array|\Joomla\Event\Event args = []) : mixed||string|int

继承已弃用

这是一个遗留方法，它实现了旧式（Joomla! 3.x）插件调用。最好直接通过 Dispatcher 处理返回的 EventInterface 对象，而不是通过此方法。此方法已弃用，将在 Joomla! 5.x 中删除。

此方法只返回事件的“结果”参数

自从	4.0.0
抛出	`InvalidArgumentException`
已弃用	4.0 将在 6.0 中删除，请改用 Dispatcher 方法，示例：Factory::getApplication()->getDispatcher()->dispatch($eventName, $event);

参数

事件名称: string事件名称。
参数: array<string|int, mixed>|Event一个参数数组或一个 Event 对象（可选）。

响应

array<string|int, mixed>来自每个函数调用的结果数组。请注意，如果未设置调度程序，这将是一个空数组。

应用程序身份对象。

继承

自从	4.0.0

类型

用户

应用程序组件标题。

继承

自从	4.3.0

类型

字符串

项目关联

继承已弃用

自从	4.3.0
已弃用	4.4.0 将在 6.0 中删除，因为此属性不再使用

类型

int

应用程序文档对象。

继承

自从	1.7.3

类型

文档

应用程序语言对象。

继承

自从	1.7.3

类型

语言

应用程序实例。

inherited static

自从	1.7.3

类型

静态

\JDocument 对象的选项数组

继承

自从	3.2

类型

array<string|int, mixed>

应用程序实例容器。

inherited static

自从	3.2

类型

array<string|int, CmsApplication>

应用程序的范围。

继承

自从	3.2

类型

字符串

客户端标识符。

继承

自从	4.0.0

类型

int

应用程序消息队列。

继承

自从	4.0.0

类型

array<string|int, mixed>

应用程序的名称。

继承

自从	4.0.0

类型

字符串

探查器实例

继承

自从	3.2

类型

探查器

当前活动模板

继承

自从	3.2

类型

对象

路径对象

继承

自从	4.0.0

类型

路径

身份验证插件类型

自从	4.0.0

类型

字符串

菜单实例容器。

继承

自从	4.2.0

类型

array<string|int, AbstractMenu>

菜单工厂

继承

自从	4.2.0

类型

MenuFactoryInterface

将扩展类型映射到它们的

自从	4.0.0

类型

array<string|int, mixed>