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

Index

\com\setasign\SetaSite
1. Block
2. BlockManager
3. Cli
4. Config
5. Controller
6. Di
7. Events
8. Exception
9. FileSystem
10. Helper
11. HttpErrorException
12. Module
13. Page
14. PropertyContainer
15. ResourceProviderInterface
16. RouteBuilder
17. SessionContext
18. SetaSite
19. SsoHelper
20. TableFactory
21. Twig
22. User
23. ViewHelper

com\setasign\SetaSite

SsoHelper

File: /SetaSite/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

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

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

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