Index

  1. \com\setasign\SetaSite
    1. Controller
      1. BackendV2
        1. AbstractController
        2. Application
        3. BlockManager
        4. Filesystem
        5. History
        6. Page
        7. PageChange
        8. PageEditor
        9. PageLock
        10. User

com\setasign\SetaSite\Controller\BackendV2

User Class Controller Json

File: /SetaSite/src/Controller/BackendV2/User.php

Class hierarchy

Implements

Summary

Methods

Properties

Constants

Constants

EVENT_AFTER_LOGIN

public const User::EVENT_AFTER_LOGIN = 'setasite.backend_user_controller.after_login'

Will be called after the user is logged in.


Type: UserEvent
extraParams:
'session' => Session

EVENT_AFTER_LOGOUT

public const User::EVENT_AFTER_LOGOUT = 'setasite.backend_user_controller.after_logout'

Will be called after the user logged out.


Type: UserEvent
Type: UserEvent

EVENT_BEFORE_LOGIN

public const User::EVENT_BEFORE_LOGIN = 'setasite.backend_user_controller.before_login'

Will be called before the user is logged in but after username and password check.


Type: UserEvent
Cancelable: If the event is canceled, the user will not login
extraParams:
'request' => ServerRequest

EVENT_BEFORE_LOGOUT

public const User::EVENT_BEFORE_LOGOUT = 'setasite.backend_user_controller.before_logout'

Will be called before the user logged out.


Type: UserEvent
extraParams:
'session' => Session

EVENT_CHECK_LOGIN

public const User::EVENT_CHECK_LOGIN = 'setasite.backend_user_controller.check_login'

Will be called after the usual login checks are over.


Type: UserEvent
Cancelable: Can be canceled by throwing a InvalidLoginException.

Properties

$config

protected AbstractController::$config

$data

protected mixed \com\setasign\SetaFramework\Controller\AbstractJsonController::$data

Result data to convert to JSON.

$encodingOptions

protected int \com\setasign\SetaFramework\Controller\AbstractJsonController::$encodingOptions = 79

Default JSON encoding is performed with the following options, which produces RFC4627-compliant JSON, capable of embedding into HTML.

default value of:

JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_SLASHES

$httpFactory

protected \com\setasign\SetaFramework\Http\HttpFactoryInterface \com\setasign\SetaFramework\Controller\AbstractController::$httpFactory

$response

protected ?\Psr\Http\Message\ResponseInterface \com\setasign\SetaFramework\Controller\AbstractController::$response

$sessionContext

protected AbstractController::$sessionContext

$textContentType

protected bool \com\setasign\SetaFramework\Controller\AbstractJsonController::$textContentType = false

If true the response contentType will be 'text/html; charset=utf-8' instead of 'application/json'.

Needed for the IE. The IE will try to download 'application/json' responses from iframes.

$users

protected User::$users

Methods

__construct()

public User::__construct ()
Parameters
$users: \com\setasign\SetaSite\User\Users
 
$sessionContext: \com\setasign\SetaSite\SessionContext
 
$config: \com\setasign\SetaFramework\Application\ApplicationConfig
 
$httpFactory: \com\setasign\SetaFramework\Http\HttpFactoryInterface
 

addCorsHeaders()

public AbstractController::addCorsHeaders (
\Psr\Http\Message\ResponseInterface $response
): \Psr\Http\Message\ResponseInterface
Parameters
$response: \Psr\Http\Message\ResponseInterface
 

errorAction()

public AbstractController::errorAction (
void
): void

getParam()

public \com\setasign\SetaFramework\Controller\AbstractController::getParam (
string $name,
mixed $default = null
): ?mixed

Returns a param if it exists otherwise this will return $default

Parameters
$name: string
 
$default: mixed
 

getParams()

public \com\setasign\SetaFramework\Controller\AbstractController::getParams (
void
): array

Get all existing params

getRequest()

protected AbstractController::getRequest (
void
): \com\setasign\SetaFramework\Request\ServerRequest

getResponse()

public \com\setasign\SetaFramework\Controller\AbstractController::getResponse (
void
): \Psr\Http\Message\ResponseInterface

getSession()

protected AbstractController::getSession (
void
): \com\setasign\SetaFramework\Session\SessionInterface

getUserPropertiesAction()

public User::getUserPropertiesAction (): void

No login required!

Parameters
$userProperties: \com\setasign\SetaSite\Config\UserProperties
 

keepAliveAction()

public User::keepAliveAction (
void
): void

keepSessionAliveAction()

public User::keepSessionAliveAction (
void
): void

No login required!

listAction()

public User::listAction (
void
): void

loginAction()

public User::loginAction (): void
Parameters
$eventManager: \com\setasign\SetaFramework\EventManager\EventManager
 
$loginTryLimiter: \com\setasign\SetaSite\Controller\Backend\LoginTryLimiter
 
$ssoHelper: \com\setasign\SetaSite\Controller\Backend\BackendSsoHelper
 
$moduleManager: \com\setasign\SetaSite\Module\ModuleManager
 
Exceptions

Throws \com\setasign\SetaSite\Exception

Throws \com\setasign\SetaSite\User\InvalidLoginException

Throws \com\setasign\SetaSite\Controller\MultiLangException

Throws \com\setasign\SetaSite\User\UnknownUserException

logoutAction()

public User::logoutAction (): void
Parameters
$eventManager: \com\setasign\SetaFramework\EventManager\EventManager
 
Exceptions

Throws \com\setasign\SetaSite\User\UnknownUserException

preflightAction()

public AbstractController::preflightAction (
void
): void

renderView()

protected AbstractController::renderView (
void
): void
Exceptions

Throws \JsonException

resetResponse()

public \com\setasign\SetaFramework\Controller\AbstractController::resetResponse (
void
): void

saveAction()

public User::saveAction (): void
Parameters
$userProperties: \com\setasign\SetaSite\Config\UserProperties
 
Exceptions

Throws \com\setasign\SetaSite\PropertyContainer\InvalidValueException

Throws \com\setasign\SetaSite\User\UnknownUserException

setParam()

public \com\setasign\SetaFramework\Controller\AbstractController::setParam (
string $name,
mixed $value
): \com\setasign\SetaFramework\Controller\ControllerInterface

Sets a param

Parameters
$name: string
 
$value: mixed
 

setParams()

public \com\setasign\SetaFramework\Controller\AbstractController::setParams (
array $params
): \com\setasign\SetaFramework\Controller\ControllerInterface

Set a array of params

Note: The params will be merged with the existing params!!

Parameters
$params: array
 

setPasswordAction()

public User::setPasswordAction (
void
): void
Exceptions

Throws \com\setasign\SetaSite\User\InvalidLoginException

setSystemLanguageAction()

public User::setSystemLanguageAction (
void
): void
Exceptions

Throws \com\setasign\SetaSite\Exception

ssoAuthAction()

public User::ssoAuthAction (): void

Login into the sso IdP

Parameters
$requestPathPrefix: \com\setasign\SetaFramework\Bootstrap\RequestPathPrefix
 
$ssoHelper: \com\setasign\SetaSite\Controller\Backend\BackendSsoHelper
 

ssoLoginAction()

public User::ssoLoginAction (): void
Parameters
$ssoHelper: \com\setasign\SetaSite\Controller\Backend\BackendSsoHelper
 
$eventManager: \com\setasign\SetaFramework\EventManager\EventManager
 
$moduleManager: \com\setasign\SetaSite\Module\ModuleManager
 
Exceptions

Throws \com\setasign\SetaSite\Exception

Throws \com\setasign\SetaSite\Controller\MultiLangException

Throws \com\setasign\SetaSite\User\UnknownUserException


© 2026 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)