ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
class.ilAuthPlugin.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */
3 
9 abstract class ilAuthPlugin extends ilPlugin implements ilAuthDefinition
10 {
11 
15  public function getComponentName()
16  {
17  return 'Authentication';
18  }
19 
20 
24  public function getComponentType()
25  {
26  return IL_COMP_SERVICE;
27  }
28 
29 
33  public function getSlot()
34  {
35  return 'AuthenticationHook';
36  }
37 
38 
42  public function getSlotId()
43  {
44  return 'authhk';
45  }
46 
47 
51  public final function slotInit()
52  {
53  //
54  }
55 
56 
64  abstract public function isExternalAccountNameRequired($a_auth_id);
65 
66 
76  abstract public function getProvider(ilAuthCredentials $credentials, $a_auth_mode);
77 
78 
84  abstract public function getAuthName($a_auth_id);
85 
86 
94  abstract public function getMultipleAuthModeOptions($a_auth_id);
95 
96 
102  abstract public function isAuthActive($id);
103 
104 
108  abstract public function getAuthIds();
109 }
Description of interface.
getAuthName($a_auth_id)
Interface of auth credentials.
isExternalAccountNameRequired($a_auth_id)
Does your AuthProvider needs "ext_account"? return true, false otherwise.
Authentication plugin.
getProvider(ilAuthCredentials $credentials, $a_auth_mode)
isAuthActive($id)
slotInit()
Special alot Init, currently nothing to do here.
getMultipleAuthModeOptions($a_auth_id)
const IL_COMP_SERVICE