Index

  1. \com\setasign\Konquadrat
    1. Object
      1. Custom
        1. CallActionTaskObject
        2. CheckinObject
        3. CheckinRelationObject
        4. CheckinSubjectObject
        5. CheckinSubjectRelationObject
        6. CheckinSubjectTrait
        7. CheckinTplObject
        8. CheckinTplTrait
        9. ConfigExportObject
        10. CrashReportObject
        11. CsvImportFileObject
        12. CustomExportObject
        13. DashboardObject
        14. DashboardTplObject
        15. DashboardTplTrait
        16. DataoriginObject
        17. DataoriginTrait
        18. DatasourceObject
        19. DatasourceTplObject
        20. DatasourceTplTrait
        21. EditColumnTaskObject
        22. ExportTplObject
        23. ExportTplTrait
        24. GridExportTplObject
        25. GridExportTplTrait
        26. GridObject
        27. GridViewObject
        28. HashableObject
        29. HashableTrait
        30. ImportDefinitionObject
        31. ImportFileObject
        32. ImportFileTplObject
        33. ImportFileTplTrait
        34. ImportObject
        35. ImportSchemaObject
        36. ImportTaskObject
        37. Mail
        38. MobileCheckinAuthDeviceObject
        39. MobileCheckinAuthObject
        40. MobileCheckinAuthRelationObject
        41. NamedDashboardObject
        42. NamedDataoriginObject
        43. NamedObjectObject
        44. NamedObjectTrait
        45. NoteObject
        46. NumberRangeObject
        47. SyncableObjectObject
        48. SyncableObjectTrait
        49. TaskTplObject
        50. TaskTplTrait
        51. Traits
        52. TxtExportObject
        53. TxtExportTplObject
        54. TxtExportTplTrait
        55. User
        56. UserObject
        57. UserTplObject
        58. UserTplTrait
        59. WorkflowObject
        60. WorkflowTextItemObject
        61. XlsExportObject
        62. XlsExportTplObject
        63. XlsExportTplTrait
        64. XlsImportFileObject
        65. XlsxImportFileObject

com\setasign\Konquadrat\Object\Custom

UserTplTrait Konquadrat Helper Trait for objectTemplate "UserTpl"

File: /Konquadrat/src/Object/Custom/generated/UserTplTrait.php

Used in

Uses

Summary

Static Properties

Methods

Properties

Constants

Constants

ACTION_SET_PERMISSION

public const Traits\UserTpl::ACTION_SET_PERMISSION = 'setPermission'

Static Properties

$ACTION_SET_PERMISSION

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

Properties

$loginIsActive

protected ?bool Traits\UserTpl::$loginIsActive

Cached status whether the login is active

$loginTimeout

protected int Traits\UserTpl::$loginTimeout

$messageList

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

$permissionControl

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

$permissions

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

$permissionsLogger

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

$sessionContext

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

Methods

checkLogin()

public Traits\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 Traits\UserTpl::createDashboard (
void
): void
Exceptions

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

createResetPasswordLink()

public Traits\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 Traits\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 Traits\UserTpl::generatePasswordAction (
void
): ?\com\setasign\Konquadrat\Object\Action\ActionResponse
Exceptions

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

getActive()

public Traits\UserTpl::getActive (
void
): bool
Exceptions

Throws \Exception

getDataoriginName()

public Traits\UserTpl::getDataoriginName (
void
): string

getForgottenEmailText()

protected Traits\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 Traits\UserTpl::getHasActiveResetPasswordHash (
void
): bool

getHasNoPassword()

public Traits\UserTpl::getHasNoPassword (
void
): bool

getPermissionControl()

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

getTabHeader()

public Traits\UserTpl::getTabHeader (
void
): string

getUniqueName()

public Traits\UserTpl::getUniqueName (
void
): string

initAndWakeupNamedObject()

public Traits\NamedObject::initAndWakeupNamedObject (
void
): void

initAndWakeupUserTpl()

public Traits\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 Traits\UserTpl::initUserTpl (
void
): void

login()

public Traits\UserTpl::login (
string|User\IgnorePasswordCheck $password,
string $sessionId,
string $windowId,
string $remoteAddress
): static
Parameters
$password : string|User\IgnorePasswordCheck
 
$sessionId : string
 
$windowId : string
 
$remoteAddress : string
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

logout()

public Traits\UserTpl::logout (
void
): static
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

requireLogin()

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

Throws User\LoginException

resetStatesAction()

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

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

saveNamedObjectAction()

public Traits\NamedObject::saveNamedObjectAction (
void
): ?\com\setasign\Konquadrat\Object\Action\ActionResponse

sendAccountWasCreatedAction()

public Traits\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 Traits\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 Traits\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 Traits\UserTpl::setExpiryDate (
mixed $date
): void
Parameters
$date : mixed
 
Exceptions

Throws \com\setasign\SetaFramework\Permissions\PermissionException

setGroup()

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

setLastSeen()

public Traits\UserTpl::setLastSeen (
$lastSeen
): static

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

Parameters
$lastSeen
 

setSsoOnly()

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

Throws \com\setasign\SetaFramework\Permissions\PermissionException

setUserGroup()

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

Throws \com\setasign\SetaFramework\Permissions\PermissionException

updateLastSeen()

public Traits\UserTpl::updateLastSeen (
void
): void
Exceptions

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

wakeupUserTpl()

public Traits\UserTpl::wakeupUserTpl (
void
): void

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