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

类构造函数。

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

返回值

混合类型

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

afterSessionStart(\Joomla\Session\SessionEvent event) :

继承

自版本	3.0.1

参数

事件: SessionEvent触发中的会话事件

返回值

空

启动给定名称的组件。

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

继承

自版本	4.0.0

参数

组件: 字符串要启动的组件。

返回值

ComponentInterface

启动给定名称的模块。

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

继承

自版本	4.0.0

参数

模块: 字符串要启动的模块
应用程序名称: 字符串应用程序名称

返回值

ModuleInterface

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

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

继承

自版本	4.0.0

参数

插件: 字符串插件名称
类型: 字符串插件的类型

返回值

PluginInterface

检查用户会话。

checkSession() :

继承

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

自版本	3.2
抛出	`RuntimeException`

返回值

空

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

checkToken( method = 'post') :

继承

与 getFormToken 结合使用。

自版本	4.0.0

参数

方法: 字符串要在其中查找令牌键的请求方法。

返回值

布尔值如果找到且有效，则为真，否则为假。

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

checkUserRequireReset( option,  view,  layout,  tasks) :

继承

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

抛出	`异常`

参数

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

返回值

空

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

createExtensionNamespaceMap() :

继承

自版本	4.0.0

返回值

空

尝试解密旧的 MFA 配置。

decryptLegacyTFAString( secret,  stringToDecrypt) :

继承

链接
自版本	4.2.0

参数

密钥: 字符串站点的密钥
待解密字符串: 字符串Base64 编码并加密，JSON 编码的信息

返回值

字符串已解密，但 JSON 编码的信息

分派应用程序

dispatch( component = null) :

自版本	3.2

参数

组件: 字符串正在呈现的组件。

返回值

空

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

doExecute() :

自版本	3.2

返回值

空

将系统消息入队。

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

继承

自版本	3.2

参数

消息: 字符串要入队的消息。
类型: 字符串消息类型。默认为消息。

返回值

空

执行应用程序。

execute() :

继承

自版本	3.2

返回值

空

返回应用程序选项字符串 [主组件]。

findOption() :

自版本	4.0.0

返回值

字符串要访问的组件。

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

flushAssets() :

继承

自版本	3.2

返回值

空

获取配置值。

getCfg( varname,  default = null) :

继承已弃用

自版本	3.2
已弃用	3.2 将在 6.0 中删除，请改用 get()。例如：Factory::getApplication()->get($varname, $default);

参数

变量名: 字符串要获取的值的名称。
默认值: 字符串要返回的默认值

返回值

混合类型用户状态。

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

getClientId() :

继承

自版本	3.2

返回值

整数客户端标识符。

检索应用程序配置对象。

getConfig() : \Joomla\Registry\Registry

继承

自版本	4.0.0

返回值

Registry

获取 DI 容器。

getContainer() : \Joomla\DI\Container

继承抽象

自版本	4.0.0
抛出	`ContainerNotFoundException`如果未设置容器，可能会抛出此异常。

返回值

Container

获取事件调度器。

getDispatcher() : \Joomla\Event\DispatcherInterface

继承抽象

自版本	4.0.0
抛出	`UnexpectedValueException`如果未设置调度器，可能会抛出此异常。

返回值

DispatcherInterface

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

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

继承

自版本	1.7.3

返回值

Document文档对象

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

getFormToken( forceNew = false) :

继承

自版本	4.0.0

参数

强制新建: 布尔值如果为真，则强制创建新的令牌

返回值

字符串哈希的变量名

获取应用程序身份。

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);

参数

名称: 字符串要实例化的 CmsApplication 类的名称（可选）。
前缀: 字符串对象的类名前缀。
container: 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

参数

名称: 字符串应用程序/客户端的名称。
选项: 数组<字符串|整数, 混合类型>一个可选的配置设置关联数组。

返回值

AbstractMenu

获取系统消息队列。

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

继承

自版本	3.2

参数

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

返回值

数组<字符串|整数, 混合类型>系统消息队列。

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

getName() :

继承

自版本	3.2

返回值

字符串应用程序的名称。

返回应用程序 Pathway 对象。

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

继承

自版本	3.2

返回值

Pathway

返回对 Router 对象的引用。

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

静态已弃用

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

参数

名称: 字符串应用程序的名称。
选项: 数组<字符串|整数, 混合类型>一个可选的配置设置关联数组。

返回值

Router

获取当前模板的名称。

getTemplate( params = false) : string|\stdClass

自版本	3.2
抛出	`InvalidArgumentException`

参数

参数: 布尔值如果为真，则返回模板参数

返回值

字符串|stdClass如果 params 参数为假，则为模板的名称。如果 params 参数为真，则为模板对象。

获取用户状态。

getUserState( key,  default = null) :

继承

自版本	3.2

参数

键: 字符串状态的路径。
默认值: 混合类型可选的默认值，如果内部值为 null 则返回。

返回值

混合类型用户状态或 null。

获取用户状态变量的值。

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

继承

自版本	3.2

参数

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

返回值

混合类型请求用户状态。

用户是否有“不要再次显示”标记？

hasRejectedMultiFactorAuthenticationSetup() :

继承

自版本	4.2.0

返回值

布尔值

不再使用

hasUserConfiguredTwoFactorAuthentication() :

继承已弃用

自版本	4.0.0
抛出	`异常`
已弃用	4.2 将在 6.0 中删除，将被删除且无替换。

返回值

布尔值

初始化应用程序。

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

自版本	3.2

参数

选项: 数组<字符串|整数, 混合类型>一个可选的配置设置关联数组。

返回值

空

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

isCli() :

继承已弃用

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

自版本	4.0.0
已弃用	4.0 将在 6.0 中删除，将被删除且无替换。

返回值

布尔值

按名称检查客户端接口。

isClient( identifier) :

继承

自版本	3.7.0

参数

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

返回值

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

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

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

返回值

布尔值

清除 jos_messages 表中的旧消息

purgeMessages() :

静态已弃用

自版本	3.2
已弃用	4.3 将在 6.0 中移除通过消息模型清除消息示例：Factory::getApplication()->bootComponent('messages')->getMVCFactory() ->createModel('Messages', 'Administrator')->purge(Factory::getApplication()->getIdentity()->id);

返回值

空

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

返回值

空

设置内部菜单工厂。

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

继承

自版本	4.2.0

参数

menuFactory: MenuFactoryInterface菜单工厂

返回值

空

设置日志记录功能。

setupLogging() :

继承

自版本	4.0.0

返回值

空

设置用户状态变量的值。

setUserState( key,  value) :

继承

自版本	3.2

参数

键: 字符串状态的路径。
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 中移除使用 Dispatcher 方法代替示例：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

应用程序实例。

inherited static

自版本	1.7.3

类型(s)

static

\JDocument 对象的选项数组

继承

自版本	3.2

类型(s)

array<string|int, mixed>

应用程序实例容器。

inherited static

自版本	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

访客和没有 core.login.admin 权限的用户允许的组件列表。

默认情况下，我们允许两个核心组件

com_login 绝对必要，以允许用户登录站点的后端。请勿删除！
com_ajax 处理 AJAX 请求或其他管理回调，无需登录。使用 WebAuthn 进行无密码身份验证时需要此功能。

类型(s)

array<string|int, mixed>