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

类构造函数。

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

自	3.2

参数

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

响应

混合

在会话启动后，我们需要使用一些默认值填充它。

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如果找到且有效，则为 true，否则为 false。

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

checkUserRequireReset( option,  view,  layout,  tasks) :

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

抛出	`异常`

参数

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

响应

空值

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

createExtensionNamespaceMap() :

继承

自	4.0.0

响应

空值

将系统消息入队。

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

自	3.2

参数

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

响应

空值

执行应用程序。

execute() :

自	3.2

响应

空值

刷新媒体版本以刷新可版本化的资源

flushAssets() :

继承

自	3.2

响应

空值

获取配置值。

getCfg( varname,  default = null) :

已弃用

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

参数

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

响应

mixed用户状态。

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

getClientId() :

自	3.2

响应

int客户端标识符。

检索应用程序配置对象。

getConfig() : \Joomla\Registry\Registry

继承

自	4.0.0

响应

注册表

获取 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

参数

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

响应

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应用程序的名称。

返回应用程序 Pathway 对象。

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

自	3.2

参数

参数: bool一个可选的配置设置关联数组

响应

string|stdClass如果 params 参数为 false，则为模板名称。如果 params 参数为 true，则为模板对象。

获取用户状态。

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请求用户状态。

不再使用

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如果此应用程序是给定类型的客户端接口，则为 true。

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

isHttpsForced( clientId = null) :

自	3.7.3

参数

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

响应

bool如果对客户端强制使用，则为 true，否则为 false。

不再使用

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扩展类型
extensionName: string扩展名称
extensionPath: string扩展的路径

响应

ComponentInterface|ModuleInterface|PluginInterface

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

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

继承

自	4.0.0

参数

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

响应

$this

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

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

继承

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

自	1.7.3

参数

language: 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

inherited deprecated

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

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

参数

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

响应

WebApplication此方法是可链式的。

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

loadSystemUris( requestUri = null) :

继承

自	1.7.3

参数

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

响应

空值

登录身份验证功能。

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

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

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

自	3.2

参数

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

响应

bool|Exception成功时为 True，失败或配置了静默处理时为 False，或身份验证错误时为 \Exception 对象。

注销身份验证功能。

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

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

自	3.2

参数

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

响应

bool成功时为 True

重定向到另一个 URL。

redirect( url,  status = 303) :

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

自	3.2

参数

url: string要重定向到的 URL。只能是 http/https URL
status: 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事件名称。
handler: callable处理程序，函数或事件对象的实例。

响应

$this

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

render() :

自	3.2

响应

空值

路由应用程序。

route() :

已弃用

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

自	3.2
已弃用	4.0 将在 6.0 中删除在扩展类中实现路由功能，这里将被删除，不再有替换

响应

空值

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

sanityCheckSystemVariables() :

自	3.9

响应

空值

设置内部菜单工厂。

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

自	4.2.0

参数

menuFactory: MenuFactoryInterface菜单工厂

响应

空值

设置日志记录功能。

setupLogging() :

自	4.0.0

响应

空值

设置用户状态变量的值。

setUserState( key,  value) :

自	3.2

参数

钥匙: string状态的路径。
value: mixed变量的值。

响应

mixed以前的状态（如果存在）。否则为 Null。

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

toString( compress = false) :

自	3.2

参数

compress: bool如果为 True，则压缩数据

响应

string

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

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

inherited deprecated

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

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

自	4.0.0
抛出	`InvalidArgumentException`
已弃用	4.0 将在 6.0 中删除使用 Dispatcher 方法代替例如：Factory::getApplication()->getDispatcher()->dispatch($eventName, $event);

参数

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

响应

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

应用程序标识对象。

继承

自	4.0.0

类型

用户

应用程序组件标题。

继承

自	4.3.0

类型

string

项目关联

inherited deprecated

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

类型

int

应用程序文档对象。

继承

自	1.7.3

类型

Document

应用程序语言对象。

继承

自	1.7.3

类型

Language

应用程序实例。

inherited static

自	1.7.3

类型

static

\JDocument 对象的选项数组

自	3.2

类型

array<string|int, mixed>

应用程序实例容器。

static

自	3.2

类型

array<string|int, CmsApplication>

应用程序的范围。

自	3.2

类型

string

客户端标识符。

自	4.0.0

类型

int

应用程序消息队列。

自	4.0.0

类型

array<string|int, mixed>

应用程序的名称。

自	4.0.0

类型

string

分析器实例

自	3.2

类型

Profiler

当前活动的模板

自	3.2

类型

object

路径对象

自	4.0.0

类型

路径

身份验证插件类型

自	4.0.0

类型

string

菜单实例容器。

自	4.2.0

类型

array<string|int, AbstractMenu>

菜单工厂

自	4.2.0

类型

MenuFactoryInterface