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

类构造函数。

__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正在触发的会话事件

响应

空

检查用户是否可以访问应用程序

authorise( itemid) :

自	3.2
抛出	`Exception`当您无权查看首页菜单项时

参数

项目 ID: int要检查授权的项目 ID

响应

空

引导具有给定名称的组件。

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

响应

空

尝试解密旧版 MFA 配置。

decryptLegacyTFAString( secret,  stringToDecrypt) :

继承

链接
自	4.2.0

参数

密钥: string站点的密钥
要解密的字符串: stringBase64 编码和加密的 JSON 编码信息

响应

string已解密但 JSON 编码的信息

调度应用程序

dispatch( component = null) :

自	3.2

参数

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

响应

空

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

doExecute() :

自	3.2

响应

空

将系统消息入队。

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

继承

自	3.2

参数

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

响应

空

执行应用程序。

execute() :

继承

自	3.2

响应

空

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

flushAssets() :

继承

自	3.2

响应

空

获取 CacheControllerFactoryInterface。

getCacheControllerFactory() : \Joomla\CMS\Cache\CacheControllerFactoryInterface

继承

自	4.2.0

响应

CacheControllerFactoryInterface

获取配置值。

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`如果未设置容器，则可能会抛出。

响应

容器

返回检测浏览器选项的当前状态。

getDetectBrowser() :

自	3.2

响应

布尔值

获取事件调度器。

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如果为真，则强制创建一个新令牌

响应

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语言对象

返回语言过滤器的当前状态。

getLanguageFilter() :

自	3.2

响应

布尔值

获取日志记录器。

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

获取应用程序参数

getParams( option = null) : \Joomla\Registry\Registry

自	3.2

参数

选项: string组件选项

响应

Registry参数对象

返回对 Pathway 对象的引用。

getPathway( name = 'site', mixed||string|int options = []) : \Joomla\CMS\Pathway\Pathway

自	3.2

参数

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

响应

Pathway一个 Pathway 对象

返回对 Router 对象的引用。

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

静态已弃用

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

参数

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

响应

路由器

获取当前模板的名称。

getTemplate( params = false) : string|\stdClass

自	3.2
抛出	`InvalidArgumentException`

参数

参数: bool如果要返回模板参数，则为真

响应

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

获取用户状态。

getUserState( key,  default = null) :

继承

自	3.2

参数

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

响应

mixed用户状态或 null。

获取用户状态变量的值。

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

继承

自	3.2

参数

密钥: string用户状态变量的键。
请求: string请求中传递的变量名称。
默认: string如果未找到变量，则为变量的默认值。可选。
类型: string变量的过滤器。可选。有关有效值，请参阅 \Joomla\CMS\Filter\InputFilter::clean()。

响应

mixed请求用户状态。

用户是否设置了“不再显示”标志？

hasRejectedMultiFactorAuthenticationSetup() :

继承

自	4.2.0

响应

布尔值

不再使用

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

处理重定向到多因素身份验证限制登录或设置页面。

isHandlingMultiFactorAuthentication() :

继承

抛出	`异常`
自	4.2.0

响应

bool如果我们当前正在处理多因素身份验证限制页面，则为真。

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

isHttpsForced( clientId = null) :

继承

自	3.7.3

参数

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

响应

bool如果对客户端强制执行，则为真，否则为假。

这是否与多因素身份验证功能相关的页面？

isMultiFactorAuthenticationPage( onlyCaptive = false) :

继承

自	4.2.0

参数

onlyCaptive: bool我是否只应检查 MFA 限制页面？

响应

布尔值

当前用户是否需要完成 MFA 身份验证才能访问站点？

isMultiFactorAuthenticationPending() :

继承

抛出	`异常`
自	4.2.0

响应

布尔值

不再使用

isTwoFactorAuthenticationRequired() :

继承已弃用

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

响应

布尔值

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

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

继承

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

自	1.7.3

参数

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

继承已弃用

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

自	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 = []) :

自	3.2

参数

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

响应

bool成功时为真。

注销身份验证函数。

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

继承

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

自	3.2

参数

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

响应

bool成功时为真

自动将用户的旧版 MFA 记录迁移到新的限制 MFA 格式。

migrateFromLegacyMFA() :

继承

自	4.2.0

响应

空

检查是否需要重定向到多因素身份验证限制页面。

needsMultiFactorAuthenticationRedirection() :

继承

自	4.2.0

响应

布尔值

重定向到另一个 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

响应

空

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

sanityCheckSystemVariables() :

继承

自	3.9

响应

空

设置要使用的缓存控制器工厂。

setCacheControllerFactory(\Joomla\CMS\Cache\CacheControllerFactoryInterface cacheControllerFactory = null) :

继承

自	4.2.0

参数

cacheControllerFactory: CacheControllerFactoryInterface要使用的缓存控制器工厂。

响应

空

设置检测浏览器选项的当前状态。

setDetectBrowser( state = false) :

自	3.2

参数

state: bool检测浏览器选项的新状态

响应

bool先前状态

设置语言过滤器的当前状态。

setLanguageFilter( state = false) :

自	3.2

参数

state: bool语言过滤器的新的状态

响应

bool先前状态

设置内部菜单工厂。

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

继承

自	4.2.0

参数

menuFactory: MenuFactoryInterface菜单工厂

响应

空

覆盖将使用的默认模板

setTemplate(\stdClass|string template,  styleParams = null) :

自	3.2

参数

template: stdClass|string模板名称或定义
styleParams: mixed模板样式参数

响应

空

设置日志记录功能。

setupLogging() :

继承

自	4.0.0

响应

空

设置用户状态变量的值。

setUserState( key,  value) :

继承

自	3.2

参数

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

响应

mixed先前状态（如果存在）。否则为 null。

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

toString( compress = false) :

继承

自	3.2

参数

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

响应

string

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

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

继承已弃用

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

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

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

参数

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

响应

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

应用程序身份对象。

继承

自	4.0.0

类型(s)

用户

应用程序组件标题。

继承

自	4.3.0

类型(s)

string

项目关联

继承已弃用

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

类型(s)

int

应用程序文档对象。

继承

自	1.7.3

类型(s)

Document

应用程序语言对象。

继承

自	1.7.3

类型(s)

Language

应用程序实例。

继承静态

自	1.7.3

类型(s)

static

\JDocument 对象的选项数组

继承

自	3.2

类型(s)

array<string|int, mixed>

应用程序实例容器。

继承静态

自	3.2

类型(s)

array<string|int, CmsApplication>

应用程序的范围。

继承

自	3.2

类型(s)

string

客户端标识符。

继承

自	4.0.0

类型(s)

int

应用程序消息队列。

继承

自	4.0.0

类型(s)

array<string|int, mixed>

应用程序的名称。

继承

自	4.0.0

类型(s)

string

探查器实例

继承

自	3.2

类型(s)

Profiler

当前活动模板

继承

自	3.2

类型(s)

object

路径对象

继承

自	4.0.0

类型(s)

Pathway

身份验证插件类型

继承

自	4.0.0

类型(s)

string

菜单实例容器。

继承

自	4.2.0

类型(s)

array<string|int, AbstractMenu>

菜单工厂

继承

自	4.2.0

类型(s)

MenuFactoryInterface

CacheControllerFactoryInterface

继承

自	4.2.0

类型(s)

CacheControllerFactoryInterface

按语言过滤的选项

自	4.0.0

类型(s)

布尔值

通过浏览器检测语言的选项

自	4.0.0

类型(s)

布尔值

已注册的 URL 参数。

自	4.3.0

类型(s)

object

SiteApplication

方法

__construct

参数

响应

afterSessionStart

参数

响应

authorise

参数

响应

bootComponent

参数

响应

bootModule

参数

响应

bootPlugin

参数

响应

checkSession

响应

checkToken

参数

响应

checkUserRequireReset

参数

响应

createExtensionNamespaceMap

响应

解密旧版 TFA 字符串

参数

响应

dispatch

参数

响应

doExecute

响应

enqueueMessage

参数

响应

execute

响应

flushAssets

响应

getCacheControllerFactory

响应

getCfg

参数

响应

getClientId

响应

getConfig

响应

getContainer

响应

getDetectBrowser

响应

getDispatcher

响应

getDocument

响应

getFormToken

参数

响应

getIdentity

响应

getInstance

参数

响应

getLanguage

响应

getLanguageFilter

响应

getLogger

响应

getMenu

参数

响应

getMessageQueue