Index
-
\com\setasign\Konquadrat
-
Object
-
Custom
- CallActionTaskObject
- CheckinObject
- CheckinRelationObject
- CheckinSubjectObject
- CheckinSubjectRelationObject
- CheckinSubjectTrait
- CheckinTplObject
- CheckinTplTrait
- ConfigExportObject
- CrashReportObject
- CsvImportFileObject
- CustomExportObject
- DashboardObject
- DashboardTplObject
- DashboardTplTrait
- DataoriginObject
- DataoriginTrait
- DatasourceObject
- DatasourceTplObject
- DatasourceTplTrait
- EditColumnTaskObject
- ExportTplObject
- ExportTplTrait
- GridExportTplObject
- GridExportTplTrait
- GridObject
- GridViewObject
- HashableObject
- HashableTrait
- ImportDefinitionObject
- ImportFileObject
- ImportFileTplObject
- ImportFileTplTrait
- ImportObject
- ImportSchemaObject
- ImportTaskObject
- MobileCheckinAuthDeviceObject
- MobileCheckinAuthObject
- MobileCheckinAuthRelationObject
- NamedDashboardObject
- NamedDataoriginObject
- NamedObjectObject
- NamedObjectTrait
- NoteObject
- NumberRangeObject
- SyncableObjectObject
- SyncableObjectTrait
- TaskTplObject
- TaskTplTrait
- Traits
- TxtExportObject
- TxtExportTplObject
- TxtExportTplTrait
- User
- UserObject
- UserTplObject
- UserTplTrait
- WorkflowObject
- WorkflowTextItemObject
- XlsExportObject
- XlsExportTplObject
- XlsExportTplTrait
- XlsImportFileObject
- XlsxImportFileObject
-
Custom
-
Object
com\setasign\Konquadrat\Object\Custom
UserObject Konquadrat Object "User"
File: /Konquadrat/src/Object/Custom/generated/UserObject.php
Class hierarchy
Uses
Implements
- \Psr\Log\LoggerAwareInterface
- \com\setasign\Konquadrat\Field\FieldContainer\FieldContainerInterface
- \com\setasign\Konquadrat\Object\AbstractObjectInterface
- DataoriginObject
- NamedObjectObject
- UserTplObject
Summary
Methods
- __construct()
- __call()
- __clone()
- __get()
- __isset()
- __set()
- __sleep()
- __wakeup()
- addEventListener()
- callAction()
- checkLogin()
- copyObjectData()
- create()
- createDashboard()
- createResetPasswordLink()
- createResetPasswordLinkAction()
- delete()
- generatePasswordAction()
- get()
- getActive()
- getAs()
- getChanged()
- getChilds()
- getData()
- getDataoriginName()
- getField()
- getFieldContainerName()
- getFields()
- getForgottenEmailText()
- getHasActiveResetPasswordHash()
- getHasNoPassword()
- getInitialData()
- getMagicWithParam()
- getPath()
- getPermissionControl()
- getPermissionResource()
- getReferencingObjects()
- getTabHeader()
- getUniqueName()
- hasAction()
- hasDocument()
- hasField()
- initAndWakeupNamedObject()
- initAndWakeupUserTpl()
- initUserTpl()
- isSettingData()
- login()
- logout()
- reload()
- removeEventListener()
- requireLogin()
- resetField()
- resetStatesAction()
- save()
- saveNamedObjectAction()
- sendAccountWasCreatedAction()
- sendResetPasswordLink()
- sendResetPasswordLinkAction()
- set()
- setData()
- setExpiryDate()
- setGroup()
- setLastSeen()
- setLogger()
- setSsoOnly()
- setUserGroup()
- updateLastSeen()
- wakeupUserTpl()
Constants
ACTION_DELETE
ACTION_READ
ACTION_SET_PERMISSION
ACTION_WRITE
EVENT_AFTER_SAVE
Event is triggered after save
params:
- $this
- array $changes
EVENT_AFTER_SAVE_AND_COMMIT
Event is triggered after save and after the current transaction is committed.
params:
- $this
- array $changes
EVENT_AFTER_SAVE_AND_ROLLBACK
Event is triggered after save and after the current transaction is rolled back.
params:
- $this
- ?array $changes
EVENT_AFTER_SAVE_ERROR
Event is triggered while saving if something went wrong
params:
- $this
- Throwable $exception
EVENT_BEFORE_SAVE
Event is triggered before save
params:
- $this
- bool $force
EVENT_CREATE
Event is triggered on creation of a new object (before the first save)
params:
- $this
NAME
OPTIONS_USER_GROUP
Static Properties
Properties
$logger
$loginIsActive
Cached status whether the login is active
$loginTimeout
$permissionsLogger
$sleep
All properties which should be serialized.
Note: Private properties cannot be serialized!
Methods
__construct()
\com\setasign\Konquadrat\Object\ObjectFinder $objectFinder,
\com\setasign\Konquadrat\Object\ObjectManager $objectManager,
\com\setasign\Konquadrat\Object\TransactionManager $transactionManager,
\com\setasign\Konquadrat\LanguageManager $languageManager,
\com\setasign\Konquadrat\Field\FieldFactory\FieldFactoryInterface $fieldFactory,
\com\setasign\Konquadrat\Object\DocumentResolverInterface $documentResolver,
\com\setasign\Konquadrat\Object\ActionResolverInterface $actionResolver,
\com\setasign\Konquadrat\Permission\ResourceDefinitionManager $resourceDefinitionManager,
\com\setasign\Konquadrat\Object\InitTraitResolverInterface $initTraitResolver,
\com\setasign\Konquadrat\Object\WakeupObjectResolverInterface $wakeupResolver,
array $data,
?\com\setasign\Konquadrat\Object\Scope\ScopeInterface $objectScope = null
Parameters
- $objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
- $objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
- $objectManager : \com\setasign\Konquadrat\Object\ObjectManager
- $transactionManager : \com\setasign\Konquadrat\Object\TransactionManager
- $languageManager : \com\setasign\Konquadrat\LanguageManager
- $fieldFactory : \com\setasign\Konquadrat\Field\FieldFactory\FieldFactoryInterface
- $documentResolver : \com\setasign\Konquadrat\Object\DocumentResolverInterface
- $actionResolver : \com\setasign\Konquadrat\Object\ActionResolverInterface
- $resourceDefinitionManager : \com\setasign\Konquadrat\Permission\ResourceDefinitionManager
- $initTraitResolver : \com\setasign\Konquadrat\Object\InitTraitResolverInterface
- $wakeupResolver : \com\setasign\Konquadrat\Object\WakeupObjectResolverInterface
- $data : array
- $objectScope : ?\com\setasign\Konquadrat\Object\Scope\ScopeInterface
Exceptions
__call()
array $arguments
Give some magic methods:
- getField{$fieldName}() -> Alias for getField($fieldName)
- getChild{$objectType}Objects() -> Alias for getChilds($objectType)
- getReferencing{$objectType}ObjectsBy{$fieldName}Field() -> Alias for getReferencingObjects($objectType, $fieldName)
Parameters
- $name : string
- $arguments : array
__get()
Alias for get($fieldName, true)
Parameters
- $fieldName : string
Exceptions
Throws \com\setasign\Konquadrat\Object\MissingConfigurationException
See
__set()
mixed $value
Alias for set($fieldName, $value)
Parameters
- $fieldName : string
- $value : mixed
See
__wakeup()
Exceptions
Throws \Throwable
addEventListener()
string $name,
callable $callback
Parameters
- $eventName : string
- $name : string
The name of this callback. The name is only unique for this method & object.
- $callback : callable
callAction()
array $additionalArguments = array ( )
Parameters
- $action : string
- $additionalArguments : array
Exceptions
Throws \InvalidArgumentException If the action is unknown.
checkLogin()
Parameters
- $sessionId : string
- $windowId : string
Exceptions
copyObjectData()
null|string|string[] $onlyTypes = null
Copy the data of $object into this object. All fields of AbstractObject will be ignored (including the parent).
Parameters
- $object : \com\setasign\Konquadrat\Object\AbstractObjectInterface
- $onlyTypes : null|string|string[]
createResetPasswordLink()
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig
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
createResetPasswordLinkAction()
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig,
\com\setasign\Konquadrat\SessionContext $sessionContext
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
delete()
Marks the object as deleted and saves the object.
Existing references will not be unlinked, but you could find these objects with ObjectFinder::getReferencingObjects()!
This method will create a transaction if no transaction is active and revert everything if an error is thrown.
Parameters
- $recursive : bool
Delete also all childs.
Return Values
Array with the ids of all deleted objects.
Exceptions
Throws \Throwable
generatePasswordAction()
Exceptions
get()
bool $resolve = true
Get the value of $fieldName.
Parameters
- $fieldName : string
- $resolve : bool
Resolve resolvable fields like reference and json fields.
getAs()
Get the object as document of type $name
Parameters
- $name : string
Exceptions
Throws \InvalidArgumentException If the name is invalid!
getChilds()
Parameters
- $type : null|\com\setasign\Konquadrat\Object\class-string<\com\setasign\Konquadrat\Object\T>|string[]
getData()
Returns the data of the fields of this object.
MultiLangString, MultiLangText and Password fields are ignored.
Parameters
- $resolveMagicFields : bool
getField()
Gets the field instance of $fieldName.
Parameters
- $fieldName : string
Exceptions
Throws \com\setasign\Konquadrat\Object\MissingConfigurationException If the field isn't configured.
getForgottenEmailText()
\com\setasign\Konquadrat\Helper\DateTime $dateTimeHelper,
string $resetPasswordLink
Parameters
- $domainName : \com\setasign\SetaFramework\Bootstrap\DomainName
- $dateTimeHelper : \com\setasign\Konquadrat\Helper\DateTime
- $resetPasswordLink : string
getMagicWithParam()
array $parameters
Parameters
- $fieldName : string
- $parameters : array
getPermissionResource()
getReferencingObjects()
string $field
Parameters
- $type : \com\setasign\Konquadrat\Object\class-string<\com\setasign\Konquadrat\Object\T>
- $field : string
initAndWakeupUserTpl()
\com\setasign\Konquadrat\SessionContext $sessionContext,
\com\setasign\Konquadrat\Object\MessageList $messageList,
\com\setasign\SetaFramework\Log\ApplicationLogHandler $logHandler,
\com\setasign\Konquadrat\Permission\PermissionsInterface $permissions
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
isSettingData()
Will be true when the data from the database will be inserted into the object.
For the most set-methods you will need to react on this.
login()
string $sessionId,
string $windowId,
string $remoteAddress
Parameters
- $password : string|User\IgnorePasswordCheck
- $sessionId : string
- $windowId : string
- $remoteAddress : string
Exceptions
logout()
Exceptions
reload()
Reloads the object.
All changed data will be reset!!
Exceptions
Throws \BadMethodCallException If the object was never saved!
Throws \com\setasign\Konquadrat\Object\UnknownObjectException If the object cannot be found!
removeEventListener()
string $name
Parameters
- $eventName : string
- $name : string
requireLogin()
resetStatesAction()
Exceptions
save()
Save the object.
Parameters
- $force : bool
Save everytime no matter whether there was a change
Exceptions
Throws \com\setasign\Konquadrat\Object\ObjectSaveException If an error occurs during the save process.
sendAccountWasCreatedAction()
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig,
\com\setasign\SetaFramework\View\Helper\AbsoluteUri $absoluteUriHelper
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()
\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
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()
\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
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
set()
Sets the value for the field.
Parameters
- $fieldName : string
- $value : mixed|\com\setasign\Konquadrat\Field\DefaultValue
setData()
bool $ignoreMissingFields = false
Set multiple fields at once.
Parameters
- $data : array
- $ignoreMissingFields : bool
If true unknown fields will just be ignored.
setExpiryDate()
Parameters
- $date : mixed
Exceptions
Throws \com\setasign\SetaFramework\Permissions\PermissionException
setLogger()
Parameters
- $logger : \Psr\Log\LoggerInterface
setSsoOnly()
Parameters
- $ssoOnly
Exceptions
Throws \com\setasign\SetaFramework\Permissions\PermissionException
setUserGroup()
Parameters
- $group : null|string|\com\setasign\Konquadrat\Field\DefaultValue
Exceptions
Throws \com\setasign\SetaFramework\Permissions\PermissionException
