AuthenticationHelper

身份验证助手类

抽象

3.6.3

Joomla CMS

方法

getLoginButtons

获取要添加到登录模块中的其他登录按钮。这些按钮可用于 Joomla 之外的身份验证方法,例如 WebAuthn、使用社交媒体提供商登录、使用第三方提供商登录,甚至使用第三方单点登录 (SSO) 服务登录。

getLoginButtons( formId) : mixed||string|int
静态

按钮定义由插件中的 onUserLoginButtons 事件处理程序返回。默认情况下,只考虑系统和用户插件。前者是因为它们始终加载。后者在这个方法中被明确加载。

onUserLoginButtons 事件处理程序必须符合以下方法定义

public function onUserLoginButtons(string $formId): array

onUserLoginButtons 事件处理程序必须返回一个包含 0 个或多个按钮定义的简单数组。

每个按钮定义都是一个包含以下键的哈希数组

  • label 作为按钮标签和标题使用的翻译字符串。必填。
  • id 按钮的 HTML ID。必填。
  • tooltip (可选) 作为按钮图像 alt 标签使用的翻译字符串
  • onclick (可选) onclick 属性,用于触发 JavaScript 事件。不建议使用。
  • data-* (可选) 要按原样传递的数据属性。使用这些和 JavaScript 来处理按钮。
  • icon (可选) 标签前显示的可选图标的 CSS 类;优先于 'image'
  • image (可选) 标签前显示的可选图标的图像路径
  • class (可选) 要添加到按钮的 CSS 类

您可以在 system/webauthn 插件中找到 onUserLoginButtons 插件事件的实际实现。

您可以在 modules/mod_login 模块中找到使用此方法输出的实际实现。

强烈建议实现登录模块或组件中登录表单的第三方开发者调用此方法并使用其结果来显示其他登录按钮。不这样做意味着您与 Joomla 4 不完全兼容。

4.0.0

参数

formId

string 登录表单容器的 HTML ID。使用它来过滤何时何地显示您的其他登录按钮。

响应

array<string|int, mixed> 按钮定义。

getTwoFactorMethods

不再使用

getTwoFactorMethods() : mixed||string|int
static 已弃用

3.6.3

已弃用

4.2 将在 6.0 中删除 将被移除,没有替代方案

响应

array<string|int, mixed> 始终为空