Index

  1. \com\setasign\Konquadrat
    1. Object
      1. Custom
        1. Traits
          1. CallActionTask
          2. CheckinRelation
          3. CheckinTpl
          4. ConfigExport
          5. CrashReport
          6. Dashboard
          7. DashboardTpl
          8. DatasourceTpl
          9. EditColumnTask
          10. ExportTpl
          11. Grid
          12. Import
          13. ImportDefinition
          14. ImportFileTpl
          15. ImportTask
          16. Mail
          17. MobileCheckinAuth
          18. MobileCheckinAuthDevice
          19. NamedDashboard
          20. NamedDataorigin
          21. NamedObject
          22. NumberRange
          23. TaskTpl
          24. TxtExportTpl
          25. UserTpl
          26. Workflow
          27. WorkflowTextItem
          28. XlsExportTpl

com\setasign\Konquadrat\Object\Custom\Traits

UserTpl Trait UserTpl

File: /Konquadrat/src/Object/Custom/traits/UserTpl.php

Used in

Summary

Static Properties

Methods

Properties

Constants

Constants

ACTION_SET_PERMISSION

public const UserTpl::ACTION_SET_PERMISSION = 'setPermission'

Static Properties

$ACTION_SET_PERMISSION

static public string UserTpl::$ACTION_SET_PERMISSION = 'setPermission'

Properties

$loginIsActive

protected ?bool UserTpl::$loginIsActive

Cached status whether the login is active

$loginTimeout

protected int UserTpl::$loginTimeout

$messageList

protected \com\setasign\Konquadrat\Object\MessageList UserTpl::$messageList

$permissionControl

protected ?\com\setasign\Konquadrat\Permission\PermissionControl UserTpl::$permissionControl

$permissions

protected \com\setasign\Konquadrat\Permission\PermissionsInterface UserTpl::$permissions

$permissionsLogger

protected ?\Psr\Log\LoggerInterface UserTpl::$permissionsLogger

$sessionContext

protected \com\setasign\Konquadrat\SessionContext UserTpl::$sessionContext

Methods

checkLogin()

public UserTpl::checkLogin (
string $sessionId,
string $windowId
): bool
Parameters
$sessionId : string
 
$windowId : string
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

createDashboard()

public UserTpl::createDashboard (
void
): void
Exceptions

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

createResetPasswordLink()

public UserTpl::createResetPasswordLink (
\com\setasign\SetaFramework\View\Helper\AbsoluteUri $absoluteUriHelper,
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig
): string

This method creates a new reset password hash and saves the object

Parameters
$absoluteUriHelper : \com\setasign\SetaFramework\View\Helper\AbsoluteUri
 
$applicationConfig : \com\setasign\SetaFramework\Application\ApplicationConfig
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

createResetPasswordLinkAction()

public UserTpl::createResetPasswordLinkAction (
\com\setasign\SetaFramework\View\Helper\AbsoluteUri $absoluteUriHelper,
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig,
\com\setasign\Konquadrat\SessionContext $sessionContext
): ?\com\setasign\Konquadrat\Object\Action\ActionResponse
Parameters
$absoluteUriHelper : \com\setasign\SetaFramework\View\Helper\AbsoluteUri
 
$applicationConfig : \com\setasign\SetaFramework\Application\ApplicationConfig
 
$sessionContext : \com\setasign\Konquadrat\SessionContext
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

Throws \com\setasign\SetaFramework\Permissions\PermissionException

generatePasswordAction()

public UserTpl::generatePasswordAction (
void
): ?\com\setasign\Konquadrat\Object\Action\ActionResponse
Exceptions

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

getActive()

public UserTpl::getActive (
void
): bool
Exceptions

Throws \Exception

getDataoriginName()

public UserTpl::getDataoriginName (
void
): string

getForgottenEmailText()

protected UserTpl::getForgottenEmailText (
\com\setasign\SetaFramework\Bootstrap\DomainName $domainName,
\com\setasign\Konquadrat\Helper\DateTime $dateTimeHelper,
string $resetPasswordLink
): ?string
Parameters
$domainName : \com\setasign\SetaFramework\Bootstrap\DomainName
 
$dateTimeHelper : \com\setasign\Konquadrat\Helper\DateTime
 
$resetPasswordLink : string
 

getHasActiveResetPasswordHash()

public UserTpl::getHasActiveResetPasswordHash (
void
): bool

getHasNoPassword()

public UserTpl::getHasNoPassword (
void
): bool

getPermissionControl()

public UserTpl::getPermissionControl (
void
): \com\setasign\Konquadrat\Permission\PermissionControl

getTabHeader()

public UserTpl::getTabHeader (
void
): string

getUniqueName()

public UserTpl::getUniqueName (
void
): string

initAndWakeupUserTpl()

public UserTpl::initAndWakeupUserTpl (
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig,
\com\setasign\Konquadrat\SessionContext $sessionContext,
\com\setasign\Konquadrat\Object\MessageList $messageList,
\com\setasign\SetaFramework\Log\ApplicationLogHandler $logHandler,
\com\setasign\Konquadrat\Permission\PermissionsInterface $permissions
): void
Parameters
$applicationConfig : \com\setasign\SetaFramework\Application\ApplicationConfig
 
$sessionContext : \com\setasign\Konquadrat\SessionContext
 
$messageList : \com\setasign\Konquadrat\Object\MessageList
 
$logHandler : \com\setasign\SetaFramework\Log\ApplicationLogHandler
 
$permissions : \com\setasign\Konquadrat\Permission\PermissionsInterface
 

initUserTpl()

public UserTpl::initUserTpl (
void
): void

login()

public UserTpl::login (
string|\com\setasign\Konquadrat\Object\Custom\User\IgnorePasswordCheck $password,
string $sessionId,
string $windowId,
string $remoteAddress
): static
Parameters
$password : string|\com\setasign\Konquadrat\Object\Custom\User\IgnorePasswordCheck
 
$sessionId : string
 
$windowId : string
 
$remoteAddress : string
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

logout()

public UserTpl::logout (
void
): static
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

requireLogin()

public UserTpl::requireLogin (
string $sessionId,
string $windowId
): void
Parameters
$sessionId : string
 
$windowId : string
 
Exceptions

Throws \com\setasign\Konquadrat\Object\Custom\User\LoginException

resetStatesAction()

public UserTpl::resetStatesAction (
void
): ?\com\setasign\Konquadrat\Object\Action\ActionResponse
Exceptions

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

sendAccountWasCreatedAction()

public UserTpl::sendAccountWasCreatedAction (
\Symfony\Component\Mailer\MailerInterface $mailer,
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig,
\com\setasign\SetaFramework\View\Helper\AbsoluteUri $absoluteUriHelper
): ?\com\setasign\Konquadrat\Object\Action\ActionResponse
Parameters
$mailer : \Symfony\Component\Mailer\MailerInterface
 
$applicationConfig : \com\setasign\SetaFramework\Application\ApplicationConfig
 
$absoluteUriHelper : \com\setasign\SetaFramework\View\Helper\AbsoluteUri
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \Symfony\Component\Mailer\Exception\TransportExceptionInterface

sendResetPasswordLink()

public UserTpl::sendResetPasswordLink (
\Symfony\Component\Mailer\MailerInterface $mailer,
\com\setasign\SetaFramework\Bootstrap\DomainName $domainName,
\com\setasign\SetaFramework\View\Helper\AbsoluteUri $absoluteUriHelper,
\com\setasign\Konquadrat\Helper\DateTime $dateTimeHelper,
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig
): void
Parameters
$mailer : \Symfony\Component\Mailer\MailerInterface
 
$domainName : \com\setasign\SetaFramework\Bootstrap\DomainName
 
$absoluteUriHelper : \com\setasign\SetaFramework\View\Helper\AbsoluteUri
 
$dateTimeHelper : \com\setasign\Konquadrat\Helper\DateTime
 
$applicationConfig : \com\setasign\SetaFramework\Application\ApplicationConfig
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

Throws \Symfony\Component\Mailer\Exception\TransportExceptionInterface

sendResetPasswordLinkAction()

public UserTpl::sendResetPasswordLinkAction (
\Symfony\Component\Mailer\MailerInterface $mailer,
\com\setasign\SetaFramework\Bootstrap\DomainName $domainName,
\com\setasign\SetaFramework\View\Helper\AbsoluteUri $absoluteUriHelper,
\com\setasign\Konquadrat\Helper\DateTime $dateTimeHelper,
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig
): ?\com\setasign\Konquadrat\Object\Action\ActionResponse
Parameters
$mailer : \Symfony\Component\Mailer\MailerInterface
 
$domainName : \com\setasign\SetaFramework\Bootstrap\DomainName
 
$absoluteUriHelper : \com\setasign\SetaFramework\View\Helper\AbsoluteUri
 
$dateTimeHelper : \com\setasign\Konquadrat\Helper\DateTime
 
$applicationConfig : \com\setasign\SetaFramework\Application\ApplicationConfig
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

Throws \Symfony\Component\Mailer\Exception\TransportExceptionInterface

setExpiryDate()

public UserTpl::setExpiryDate (
mixed $date
): void
Parameters
$date : mixed
 
Exceptions

Throws \com\setasign\SetaFramework\Permissions\PermissionException

setGroup()

public UserTpl::setGroup (
$group
): void
Parameters
$group
 

setLastSeen()

public UserTpl::setLastSeen (
$lastSeen
): static

This method will prevent changing the last seen flag by yourself.

Parameters
$lastSeen
 

setSsoOnly()

public UserTpl::setSsoOnly (
$ssoOnly
): void
Parameters
$ssoOnly
 
Exceptions

Throws \com\setasign\SetaFramework\Permissions\PermissionException

setUserGroup()

public UserTpl::setUserGroup (): static
Parameters
$group : null|string|\com\setasign\Konquadrat\Field\DefaultValue
 
Exceptions

Throws \com\setasign\SetaFramework\Permissions\PermissionException

updateLastSeen()

public UserTpl::updateLastSeen (
void
): void
Exceptions

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

wakeupUserTpl()

public UserTpl::wakeupUserTpl (
void
): void

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