class SamlSPDrupalLoginController in SAML Service Provider 4.x
Same name and namespace in other branches
- 8.3 modules/saml_sp_drupal_login/src/Controller/SamlSPDrupalLoginController.php \Drupal\saml_sp_drupal_login\Controller\SamlSPDrupalLoginController
- 8.2 modules/saml_sp_drupal_login/src/Controller/SamlSPDrupalLoginController.php \Drupal\saml_sp_drupal_login\Controller\SamlSPDrupalLoginController
- 3.x modules/saml_sp_drupal_login/src/Controller/SamlSPDrupalLoginController.php \Drupal\saml_sp_drupal_login\Controller\SamlSPDrupalLoginController
Provides route responses for the SAML SP module.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\saml_sp_drupal_login\Controller\SamlSPDrupalLoginController
Expanded class hierarchy of SamlSPDrupalLoginController
File
- modules/
saml_sp_drupal_login/ src/ Controller/ SamlSPDrupalLoginController.php, line 16
Namespace
Drupal\saml_sp_drupal_login\ControllerView source
class SamlSPDrupalLoginController extends ControllerBase {
/**
* Initiate a SAML login for the given IdP.
*/
public function initiate(Idp $idp) {
$config = $this
->config('saml_sp_drupal_login.config');
if ($this
->currentUser()
->isAuthenticated()) {
$redirect_path = $config
->get('logged_in_redirect');
if ($this
->config('saml_sp.settings')
->get('debug')) {
_saml_sp__debug('$redirect_path', $redirect_path);
}
if (strpos($redirect_path, '/') === 0) {
$url = URL::fromUserInput($redirect_path);
}
else {
$url = URL::fromRoute($redirect_path);
}
// the user is already logged in, redirect
return new RedirectResponse($url
->toString());
}
// Start the authentication process; invoke
// saml_sp_drupal_login__saml_authenticate() when done.
$callback = 'saml_sp_drupal_login__saml_authenticate';
$forceAuthn = $config
->get('force_authentication') ?? FALSE;
$return = saml_sp_start($idp, $callback, $forceAuthn);
if (!empty($return)) {
// Something was returned, echo it to the screen.
return $return;
}
}
/**
* Tests condition for requesting accounts.
*/
public function access(AccountInterface $account) {
$authenticated = saml_sp_drupal_login_is_authenticated();
return AccessResult::allowedIf($account
->isAnonymous() && $authenticated);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ControllerBase:: |
protected | property | The configuration factory. | |
ControllerBase:: |
protected | property | The current user service. | 1 |
ControllerBase:: |
protected | property | The entity form builder. | |
ControllerBase:: |
protected | property | The entity type manager. | |
ControllerBase:: |
protected | property | The form builder. | 2 |
ControllerBase:: |
protected | property | The key-value storage. | 1 |
ControllerBase:: |
protected | property | The language manager. | 1 |
ControllerBase:: |
protected | property | The module handler. | 2 |
ControllerBase:: |
protected | property | The state service. | |
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
ControllerBase:: |
private | function | Returns the service container. | |
ControllerBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
46 |
ControllerBase:: |
protected | function | Returns the current user. | 1 |
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
ControllerBase:: |
protected | function | Returns the form builder service. | 2 |
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
ControllerBase:: |
protected | function | Returns the module handler. | 2 |
ControllerBase:: |
protected | function | Returns a redirect response object for the specified route. | |
ControllerBase:: |
protected | function | Returns the state storage service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
SamlSPDrupalLoginController:: |
public | function | Tests condition for requesting accounts. | |
SamlSPDrupalLoginController:: |
public | function | Initiate a SAML login for the given IdP. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |