DefaultActiveWindowManager
in package
implements
ActiveWindowManagerInterface
Table of Contents
Interfaces
- ActiveWindowManagerInterface
- Active Window Manager Interface
Methods
- __construct() : mixed
- Constructor.
- start() : bool
- Starts an active window for an entity - Make sure to create a transaction before calling this service
- stop() : bool
- Stops an active window for an entity - Make sure to create a transaction before calling this service
Methods
__construct()
Constructor.
public
__construct() : mixed
start()
Starts an active window for an entity - Make sure to create a transaction before calling this service
public
start(string $entityType, int $entityId, int $memberId, DateTime $startOn[, DateTime|null $expiresOn = null ][, int|null $termYears = null ][, int|null $grantRoleId = null ][, bool $closeExisting = true ][, int|null $branchId = null ]) : bool
Parameters
- $entityType : string
- $entityId : int
- $memberId : int
- $startOn : DateTime
- $expiresOn : DateTime|null = null
- $termYears : int|null = null
- $grantRoleId : int|null = null
- $closeExisting : bool = true
-
Auto-close overlapping existing windows
- $branchId : int|null = null
-
Branch context for role assignments
Return values
boolstop()
Stops an active window for an entity - Make sure to create a transaction before calling this service
public
stop(string $entityType, int $entityId, int $memberId, string $status, string $reason, DateTime $expiresOn) : bool
Parameters
- $entityType : string
- $entityId : int
- $memberId : int
- $status : string
- $reason : string
- $expiresOn : DateTime