Class SsoHelper in namespace com\setasign\Konquadrat in Konquadrat API Reference

Index

\com\setasign\Konquadrat
1. Checkin
2. Cleanup
3. Cli
4. Config
5. Controller
6. Datasource
7. Di
8. Di
9. DirectorySettings
10. Exception
11. Field
12. File
13. GraphQL
14. Grid
15. Helper
16. Import
17. Konquadrat
18. LanguageManager
19. MultiLangException
20. Object
21. Permission
22. RouteBuilder
23. SessionContext
24. Smarty
25. SsoHelper
26. TableFactory
27. Task
28. Twig
29. UpdateScripts
30. Workflow

com\setasign\Konquadrat

SsoHelper Class SsoHelper

File: /Konquadrat/src/SsoHelper.php

Class hierarchy

SsoHelper
- Controller\Backend\BackendSsoHelper

Summary

Constants

DEFAULT_AUTH_SOURCE

protected const SsoHelper::DEFAULT_AUTH_SOURCE = 'default-sp'

Properties

$config

protected SsoHelper::$config

Methods

__construct()

public SsoHelper::__construct (

\com\setasign\SetaFramework\Application\ApplicationConfig $config

)

Parameters

$config : \com\setasign\SetaFramework\Application\ApplicationConfig

auth()

public 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()

public SsoHelper::getAttributes (

void

): array

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 SsoHelper::getAuth (

void

): \SimpleSAML\Auth\Simple|\setasign\SetaSso\AuthSource\AuthSourceInterface

isAuthenticated()

public SsoHelper::isAuthenticated (

void

): bool

isEnabled()

public SsoHelper::isEnabled (

void

): bool

localLogout()

public SsoHelper::localLogout (

void

): void

logout()

public 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 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