ILIAS  release_8 Revision v8.24
interface.ilAuthDefinition.php
Go to the documentation of this file.
1<?php
2
19declare(strict_types=1);
20
25{
29 public function getProvider(ilAuthCredentials $credentials, string $a_auth_id): ilAuthProviderInterface;
30
31
39 public function getAuthIds(): array;
40
41
48 public function getAuthIdByName(string $a_auth_name): int;
49
54 public function getAuthName(int $a_auth_id): string;
55
59 public function isAuthActive(int $a_auth_id): bool;
60
65 public function supportsMultiCheck(int $a_auth_id): bool;
66
71 public function isExternalAccountNameRequired(int $a_auth_id): bool;
72
76 public function isPasswordModificationAllowed(int $a_auth_id): bool;
77
85 public function getLocalPasswordValidationType(int $a_auth_id): int;
86
93 public function getMultipleAuthModeOptions(int $a_auth_id): array;
94}
Interface of auth credentials.
isExternalAccountNameRequired(int $a_auth_id)
Check if an external account name is required for this authentication method Normally this should ret...
getAuthIds()
Get authentication id.
getLocalPasswordValidationType(int $a_auth_id)
Get local password validation type One of ilAuthUtils::LOCAL_PWV_FULL ilAuthUtils::LOCAL_PWV_NO ilAut...
supportsMultiCheck(int $a_auth_id)
Check whther authentication supports sequenced authentication.
getMultipleAuthModeOptions(int $a_auth_id)
Get an array of options for "multiple auth mode" selection array( AUTH_ID => array( 'txt' => NAME) )
isAuthActive(int $a_auth_id)
Check if auth mode is active.
getAuthName(int $a_auth_id)
Get auth name by auth id.
getProvider(ilAuthCredentials $credentials, string $a_auth_id)
Get auth provider instance.
getAuthIdByName(string $a_auth_name)
Get the auth id by an auth mode name.
isPasswordModificationAllowed(int $a_auth_id)
Check if authentication method allows password modifications.
Standard interface for auth provider implementations.