|
| | suppressAllModules (CMSApplication $app=null) |
| |
| | getRecords (User $user=null, bool $includeBackupCodes=false) |
| |
| | loadCaptiveRenderOptions (?MfaTable $record) |
| |
| | getPageTitle () |
| |
| | translateMethodName (string $name) |
| |
| | getMethodImage (string $name) |
| |
| | onAfterModuleList (Event $event) |
| |
| | __construct ($config=array(), MVCFactoryInterface $factory=null) |
| |
| | getTable ($name='', $prefix='', $options=array()) |
| |
| | isCheckedOut ($item) |
| |
| | getDbo () |
| |
| | setDbo (DatabaseInterface $db=null) |
| |
| | __get ($name) |
| |
| | __construct ($config=array()) |
| |
| | getName () |
| |
| | __construct ($properties=null) |
| |
| | __toString () |
| |
| | def ($property, $default=null) |
| |
| | get ($property, $default=null) |
| |
| | getProperties ($public=true) |
| |
| | getError ($i=null, $toString=true) |
| |
| | getErrors () |
| |
| | set ($property, $value=null) |
| |
| | setProperties ($properties) |
| |
| | setError ($error) |
| |
| | getState ($property=null, $default=null) |
| |
| | setState ($property, $value=null) |
| |
| | setDispatcher (DispatcherInterface $dispatcher) |
| |
| | setCurrentUser (User $currentUser) |
| |
| | setCacheControllerFactory (CacheControllerFactoryInterface $factory) |
| |
| | setDatabase (DatabaseInterface $db) |
| |
Captive Multi-factor Authentication page's model
- Depuis
- 4.2.0
◆ filterModules()
| filterModules |
( |
array & |
$modules | ) |
|
|
private |
This is the Method which actually filters the sites modules based on the allowed module positions specified by the user.
- Paramètres
-
| array | $modules | The list of the site's modules. Passed by reference. |
- Renvoie
- void The by-reference value is modified instead.
- Depuis
- 4.2.0
- Exceptions
-
Références $module, et $modules.
◆ getActiveMethodNames()
Return all the active MFA Methods' names
- Renvoie
- array
- Depuis
- 4.2.0
◆ getAllowedModulePositions()
| getAllowedModulePositions |
( |
| ) |
|
|
private |
◆ getMethodImage()
| getMethodImage |
( |
string |
$name | ) |
|
Translate a MFA Method's name into the relative URL if its logo image
- Paramètres
-
| string | $name | The internal MFA Method name |
- Renvoie
- string
- Depuis
- 4.2.0
Références $name, et null.
◆ getPageTitle()
Returns the title to display in the Captive login page, or an empty string if no title is to be displayed.
- Renvoie
- string
- Depuis
- 4.2.0
Références Text\_(), et ComponentHelper\getParams().
◆ getRecords()
| getRecords |
( |
User |
$user = null, |
|
|
bool |
$includeBackupCodes = false |
|
) |
| |
Get the MFA records for the user which correspond to active plugins
- Paramètres
-
| User | null | $user | The user for which to fetch records. Skip to use the current user. |
| bool | $includeBackupCodes | Should I include the backup codes record? |
- Renvoie
- array
- Exceptions
-
- Depuis
- 4.2.0
Références $method, $user, class, Factory\getApplication(), et Factory\getContainer().
◆ loadCaptiveRenderOptions()
| loadCaptiveRenderOptions |
( |
?MfaTable |
$record | ) |
|
Load the Captive login page render options for a specific MFA record
- Paramètres
-
| MfaTable | $record | The MFA record to process |
- Renvoie
- CaptiveRenderOptions The rendering options
- Depuis
- 4.2.0
Références $result, $results, Text\_(), et Factory\getApplication().
◆ onAfterModuleList()
| onAfterModuleList |
( |
Event |
$event | ) |
|
Process the modules list on Joomla! 4.
Joomla! 4.x is passing an Event object. The first argument of the event object is the array of modules. After filtering it we have to overwrite the event argument (NOT just return the new list of modules). If a future version of Joomla! uses immutable events we'll have to use Reflection to do that or Joomla! would have to fix the way this event is handled, taking its return into account. For now, we just abuse the mutable event properties - a feature of the event objects we discussed in the Joomla! 4 Working Group back in August 2015.
- Paramètres
-
| Event | $event | The Joomla! event object |
- Renvoie
- void
- Exceptions
-
- Depuis
- 4.2.0
Références $modules, AbstractEvent\getArgument(), et Event\setArgument().
◆ suppressAllModules()
Prevents Joomla from displaying any modules.
This is implemented with a trick. If you use jdoc tags to load modules the JDocumentRendererHtmlModules uses JModuleHelper::getModules() to load the list of modules to render. This goes through JModuleHelper::load() which triggers the onAfterModuleList event after cleaning up the module list from duplicates. By resetting the list to an empty array we force Joomla to not display any modules.
Similar code paths are followed by any canonical code which tries to load modules. So even if your template does not use jdoc tags this code will still work as expected.
- Paramètres
-
| CMSApplication | null | $app | The CMS application to manipulate |
- Renvoie
- void
- Exceptions
-
- Depuis
- 4.2.0
Références $app, $this, et Factory\getApplication().
◆ translateMethodName()
| translateMethodName |
( |
string |
$name | ) |
|
Translate a MFA Method's name into its human-readable, display name
- Paramètres
-
| string | $name | The internal MFA Method name |
- Renvoie
- string
- Depuis
- 4.2.0
Références $name, Text\_(), et null.
◆ $activeMFAMethodNames
| $activeMFAMethodNames = null |
|
protected |
La documentation de cette classe a été générée à partir du fichier suivant :
Graphe d'héritage de CaptiveModel:
