DefaultWarrantManager
in package
implements
WarrantManagerInterface
uses
QueuedMailerAwareTrait, MailerAwareTrait
Table of Contents
Interfaces
- WarrantManagerInterface
- Warrant Manager Interface
Properties
Methods
- __construct() : mixed
- Constructor.
- approve() : ServiceResult
- Approve.
- cancel() : ServiceResult
- Cancel.
- cancelByEntity() : ServiceResult
- Cancel by entity.
- decline() : ServiceResult
- Decline.
- declineSingleWarrant() : ServiceResult
- Decline single warrant.
- getWarrantPeriod() : WarrantPeriod|null
- Get warrant period.
- request() : ServiceResult
- Request.
- cancelWarrant() : ServiceResult
- Cancel warrant.
- declineWarrant() : ServiceResult
- Decline warrant.
- queueMail() : Mailer
- Returns a mailer instance.
- queueMailJob() : void
- Queues a mail job to be processed later.
- sendMailNow() : Mailer
- Returns a mailer instance.
- stopWarrantDependants() : ServiceResult
- Stop warrant dependants.
Properties
$mailer
protected
Mailer
$mailer
$activeWindowManager
private
ActiveWindowManagerInterface
$activeWindowManager
Methods
__construct()
Constructor.
public
__construct(ActiveWindowManagerInterface $activeWindowManager) : mixed
Parameters
- $activeWindowManager : ActiveWindowManagerInterface
approve()
Approve.
public
approve(mixed $warrant_roster_id, mixed $approver_id) : ServiceResult
Parameters
- $warrant_roster_id : mixed
- $approver_id : mixed
Return values
ServiceResultcancel()
Cancel.
public
cancel(mixed $warrant_id, mixed $reason, mixed $rejecter_id, mixed $expiresOn) : ServiceResult
Parameters
- $warrant_id : mixed
- $reason : mixed
- $rejecter_id : mixed
- $expiresOn : mixed
Return values
ServiceResultcancelByEntity()
Cancel by entity.
public
cancelByEntity(mixed $entityType, mixed $entityId, mixed $reason, mixed $rejecter_id, mixed $expiresOn) : ServiceResult
Parameters
- $entityType : mixed
- $entityId : mixed
- $reason : mixed
- $rejecter_id : mixed
- $expiresOn : mixed
Return values
ServiceResultdecline()
Decline.
public
decline(mixed $warrant_roster_id, mixed $rejecter_id, mixed $reason) : ServiceResult
Parameters
- $warrant_roster_id : mixed
- $rejecter_id : mixed
- $reason : mixed
Return values
ServiceResultdeclineSingleWarrant()
Decline single warrant.
public
declineSingleWarrant(mixed $warrant_id, mixed $reason, mixed $rejecter_id) : ServiceResult
Parameters
- $warrant_id : mixed
- $reason : mixed
- $rejecter_id : mixed
Return values
ServiceResultgetWarrantPeriod()
Get warrant period.
public
getWarrantPeriod(DateTime $startOn, DateTime|null $endOn) : WarrantPeriod|null
Parameters
- $startOn : DateTime
- $endOn : DateTime|null
Return values
WarrantPeriod|nullrequest()
Request.
public
request(mixed $request_name, mixed $desc, mixed $warrantRequests) : ServiceResult
Parameters
- $request_name : mixed
- $desc : mixed
- $warrantRequests : mixed
Return values
ServiceResultcancelWarrant()
Cancel warrant.
protected
cancelWarrant(mixed $warrantTable, mixed $warrant, mixed $expiresOn, mixed $rejecter_id, mixed $reason) : ServiceResult
Parameters
- $warrantTable : mixed
- $warrant : mixed
- $expiresOn : mixed
- $rejecter_id : mixed
- $reason : mixed
Return values
ServiceResultdeclineWarrant()
Decline warrant.
protected
declineWarrant(mixed $warrantTable, mixed $warrant, mixed $rejecter_id, mixed $reason) : ServiceResult
Parameters
- $warrantTable : mixed
- $warrant : mixed
- $rejecter_id : mixed
- $reason : mixed
Return values
ServiceResultqueueMail()
Returns a mailer instance.
protected
queueMail(string $name, mixed $action, mixed $to, mixed $vars) : Mailer
Parameters
- $name : string
-
Mailer's name.
- $action : mixed
- $to : mixed
- $vars : mixed
Tags
Return values
MailerqueueMailJob()
Queues a mail job to be processed later.
protected
queueMailJob(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
-
Data to be passed to the mailer.
sendMailNow()
Returns a mailer instance.
protected
sendMailNow(array<string|int, mixed> $data) : Mailer
Parameters
- $data : array<string|int, mixed>
Tags
Return values
MailerstopWarrantDependants()
Stop warrant dependants.
protected
stopWarrantDependants(mixed $warrant, mixed $rejecter_id) : ServiceResult
Parameters
- $warrant : mixed
- $rejecter_id : mixed