Index

  1. \com\setasign\Konquadrat
    1. Controller
      1. Backend
        1. Admin
        2. BackendJsonController
        3. BackendSsoHelper
        4. ChangedDetailsException
        5. Checkin
        6. Config
        7. ConfigInstaller
        8. Cors
        9. Datasource
        10. Details
        11. DisplayObjectAs
        12. ExportAlreadyExistsException
        13. Grid
        14. History
        15. Import
        16. LoginTryLimiter
        17. Namebadge
        18. ObjectIsReferencedException
        19. ObjectSync
        20. Objects
        21. Task
        22. User
        23. V2
        24. Workflow
        25. Xml

com\setasign\Konquadrat\Controller\Backend

User Class User

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

Class hierarchy

Implements

  • \com\setasign\SetaFramework\Controller\ControllerInterface

Summary

Methods

Properties

Properties

$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

$messageList

protected BackendJsonController::$messageList

$response

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

$sessionContext

protected BackendJsonController::$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.


Methods

__construct()

public BackendJsonController::__construct (
\com\setasign\Konquadrat\SessionContext $sessionContext,
\com\setasign\Konquadrat\Object\MessageList $messageList,
\com\setasign\SetaFramework\Http\HttpFactoryInterface $httpFactory
)
Parameters
$sessionContext : \com\setasign\Konquadrat\SessionContext
 
$messageList : \com\setasign\Konquadrat\Object\MessageList
 
$httpFactory : \com\setasign\SetaFramework\Http\HttpFactoryInterface
 

checkPermissionAction()

public User::checkPermissionAction (): void
Parameters
$resourceDefinitionManager : \com\setasign\Konquadrat\Permission\ResourceDefinitionManager
 
Exceptions

Throws \com\setasign\SetaFramework\Permissions\PermissionException

findUserByPasswordResetHash()

protected User::findUserByPasswordResetHash (): \com\setasign\Konquadrat\Object\Custom\UserTplObject
Parameters
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$hash : string
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

forgottenPasswordAction()

public User::forgottenPasswordAction (): void
Parameters
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 
$loginTryLimiter : LoginTryLimiter
 
$history : \com\setasign\Konquadrat\Object\History
 
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

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

getPermissionControl()

protected BackendJsonController::getPermissionControl (
void
): \com\setasign\Konquadrat\Permission\PermissionControl

getRequest()

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

getResponse()

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

getSession()

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

keepAliveAction()

public User::keepAliveAction (
void
): void

keepSessionAliveAction()

public User::keepSessionAliveAction (
void
): void

loginAction()

public User::loginAction (
BackendSsoHelper $ssoHelper,
\com\setasign\Konquadrat\LanguageManager $languageManager,
\com\setasign\Konquadrat\Object\ObjectConfig $objectConfig,
\com\setasign\Konquadrat\Object\ObjectFinder $objectFinder,
\com\setasign\Konquadrat\Object\History $history,
LoginTryLimiter $loginTryLimiter,
\com\setasign\SetaFramework\Log\ApplicationLogHandler $logHandler
): void
Parameters
$ssoHelper : BackendSsoHelper
 
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$history : \com\setasign\Konquadrat\Object\History
 
$loginTryLimiter : LoginTryLimiter
 
$logHandler : \com\setasign\SetaFramework\Log\ApplicationLogHandler
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \Throwable

logoutAction()

public User::logoutAction (): void
Parameters
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
Exceptions

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

Throws \com\setasign\Konquadrat\Object\UnknownObjectException

renderView()

protected \com\setasign\SetaFramework\Controller\AbstractJsonController::renderView (
void
): void
Exceptions

Throws \JsonException

resetPasswordAction()

public User::resetPasswordAction (): void
Parameters
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$history : \com\setasign\Konquadrat\Object\History
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

resetPasswordCheckHashAction()

public User::resetPasswordCheckHashAction (): void
Parameters
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

resetResponse()

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

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
Parameters
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

Throws \com\setasign\Konquadrat\Object\UnknownObjectException

Throws \com\setasign\SetaFramework\Permissions\PermissionException

setSystemLanguageAction()

public User::setSystemLanguageAction (
\com\setasign\SetaFramework\Request\ServerRequest $request,
\com\setasign\Konquadrat\LanguageManager $languageManager
): void
Parameters
$request : \com\setasign\SetaFramework\Request\ServerRequest
 
$languageManager : \com\setasign\Konquadrat\LanguageManager
 

ssoAuthAction()

public User::ssoAuthAction (
\com\setasign\Konquadrat\Konquadrat $konquadrat,
\com\setasign\SetaFramework\Application\ApplicationConfig $config,
BackendSsoHelper $ssoHelper
): void

Login into the sso IdP

Parameters
$konquadrat : \com\setasign\Konquadrat\Konquadrat
 
$config : \com\setasign\SetaFramework\Application\ApplicationConfig
 
$ssoHelper : BackendSsoHelper
 

ssoLoginAction()

public User::ssoLoginAction (
BackendSsoHelper $ssoHelper,
\com\setasign\Konquadrat\LanguageManager $languageManager,
\com\setasign\Konquadrat\Object\ObjectConfig $objectConfig,
\com\setasign\Konquadrat\Object\ObjectFinder $objectFinder,
\com\setasign\Konquadrat\Object\History $history,
\com\setasign\SetaFramework\Log\ApplicationLogHandler $logHandler
): void

Login into konquadrat per SSO

Parameters
$ssoHelper : BackendSsoHelper
 
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$history : \com\setasign\Konquadrat\Object\History
 
$logHandler : \com\setasign\SetaFramework\Log\ApplicationLogHandler
 
Exceptions

Throws \Throwable


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