com\setasign\Konquadrat

SessionContext Class SessionContext

File: /Konquadrat/src/SessionContext.php

Class hierarchy

Summary

Properties

$debugCookie

protected string SessionContext::$debugCookie

$objectConfig

$objectConfigIdentifier

$objectFinder

$request

$session

$ssoHelper

$windowId

protected string SessionContext::$windowId = 'default'

Static Methods

extractWindowId()

public static SessionContext::extractWindowId (
\com\setasign\SetaFramework\Request\ServerRequest $request
): string
Parameters
$request : \com\setasign\SetaFramework\Request\ServerRequest
 

Methods

__construct()

public SessionContext::__construct (
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig,
Object\ObjectConfig $objectConfig,
Object\ObjectFinder $objectFinder,
Controller\Backend\BackendSsoHelper $ssoHelper,
?\com\setasign\SetaFramework\Request\ServerRequest $request,
?\com\setasign\SetaFramework\Session\SessionInterface $session
)
Parameters
$applicationConfig : \com\setasign\SetaFramework\Application\ApplicationConfig
 
$objectConfig : Object\ObjectConfig
 
$objectFinder : Object\ObjectFinder
 
$ssoHelper : Controller\Backend\BackendSsoHelper
 
$request : ?\com\setasign\SetaFramework\Request\ServerRequest
 
$session : ?\com\setasign\SetaFramework\Session\SessionInterface
 

getLoggedInUser()

This method returns the logged-in user.

You have to check yourself whether you are logged in with isLoggedIn().

getPermissionControl()

getRequest()

public SessionContext::getRequest (
void
): ?\com\setasign\SetaFramework\Request\ServerRequest

getSession()

public SessionContext::getSession (
void
): ?\com\setasign\SetaFramework\Session\SessionInterface

getWindowId()

public SessionContext::getWindowId (
void
): string

isDebug()

public SessionContext::isDebug (
void
): bool

isLoggedIn()

public SessionContext::isLoggedIn (
void
): bool

Checks whether the client is logged in to the backend.

When this method returns true you can be sure that getSession() and getRequest() will not return null!

Exceptions

Throws Exception

Throws Object\ObjectSaveException

isMobileCheckin()

public SessionContext::isMobileCheckin (
void
): bool

register()

public SessionContext::register (
\com\setasign\SetaFramework\EventManager\EventManager $eventManager,
Object\ObjectFinder $objectFinder,
Object\MessageList $messageList,
Object\History $history,
\com\setasign\SetaFramework\Registry\Registry $registry
): void

This method registers the session context in all konquadrat objects.

Parameters
$eventManager : \com\setasign\SetaFramework\EventManager\EventManager
 
$objectFinder : Object\ObjectFinder
 
$messageList : Object\MessageList
 
$history : Object\History
 
$registry : \com\setasign\SetaFramework\Registry\Registry
 

registerMobileCheckin()

Parameters
$history : Object\History
 

requireLogin()

public SessionContext::requireLogin (
void
): void

Checks whether the client is logged in to the backend.

Exceptions

Throws Object\Custom\User\LoginException

Throws Exception

Throws Object\ObjectSaveException