com\setasign\Konquadrat\Controller\Backend

BackendSsoHelper Class BackendSsoHelper

File: /Konquadrat/src/Controller/Backend/BackendSsoHelper.php

Class hierarchy

Summary

Constants

DEFAULT_AUTH_SOURCE


Properties


Methods

__construct()

public \com\setasign\Konquadrat\SsoHelper::__construct (
\com\setasign\SetaFramework\Application\ApplicationConfig $config
)
Parameters
$config : \com\setasign\SetaFramework\Application\ApplicationConfig
 

auth()

public \com\setasign\Konquadrat\SsoHelper::auth (
?string $returnTo = null
): void

Note this method will end the script by using "exit"

Parameters
$returnTo : ?string
 
Exceptions

Throws \setasign\SetaSso\ForceResponseException if using SetaSso

getAttributes()

This function will retrieve the attributes of the current user if the user is authenticated. If the user isn't authenticated, it will return an empty array.

getAuth()

protected BackendSsoHelper::getAuth (
void
): \SimpleSAML\Auth\Simple|\setasign\SetaSso\AuthSource\AuthSourceInterface

getLoginIdentifier()

public BackendSsoHelper::getLoginIdentifier (
void
): string

Returns the actual used login identifier value.

If the user isn't authenticated or if the attribute isn't set this method will return an empty string.

getLoginIdentifierField()

public BackendSsoHelper::getLoginIdentifierField (
void
): string

Returns the actual user field to match against.

getSsoGuiConfig()

public BackendSsoHelper::getSsoGuiConfig (
void
): ?array

isAuthenticated()

isEnabled()

public BackendSsoHelper::isEnabled (
void
): bool

localLogout()

logout()

public \com\setasign\Konquadrat\SsoHelper::logout (
?string $returnTo = null
): void

Note this method will end the script by using "exit"

Parameters
$returnTo : ?string
 
Exceptions

Throws \setasign\SetaSso\ForceResponseException if using SetaSso

requireAuth()

public \com\setasign\Konquadrat\SsoHelper::requireAuth (
?string $returnTo = null
): void

Note this method may end the script by using "exit"

Parameters
$returnTo : ?string
 
Exceptions

Throws \setasign\SetaSso\ForceResponseException if not authentified and using SetaSso