SubscriptionTask
extends AirlayTask
in package
Table of Contents
- mainAction() : void
- abortWorkWithMessage() : never
- getDataSetTitle() : string
- parseFlagsFromParams() : void
- Parse command line arguments from array. Output default values if --help or -h argument specified.
- requestConfirm() : bool
- generateReport() : ReportInterface
- getFileName() : string
- getPeriodInSecond() : array<string|int, mixed>
- hasPeriodPassed() : bool
- saveReport() : array<string|int, mixed>
- sendNotification() : void
- sendReport() : void
- showInfoAboutGeneratedReport() : void
- showInfoAboutSentEmail() : void
Methods
mainAction()
public
mainAction() : void
Return values
void —abortWorkWithMessage()
protected
abortWorkWithMessage(string $message) : never
Parameters
- $message : string
Return values
never —getDataSetTitle()
protected
getDataSetTitle(array<string|int, mixed>|DataSetEntity $dataSet) : string
Parameters
- $dataSet : array<string|int, mixed>|DataSetEntity
Return values
string —parseFlagsFromParams()
Parse command line arguments from array. Output default values if --help or -h argument specified.
protected
parseFlagsFromParams(Flags $flags[, array<string|int, mixed> $params = [] ]) : void
Parameters
- $flags : Flags
- $params : array<string|int, mixed> = []
Return values
void —requestConfirm()
protected
requestConfirm(string $message) : bool
Parameters
- $message : string
Return values
bool —generateReport()
private
generateReport(int $start, int $end, array<string|int, mixed> $dataSetIds, ObjectId $organizationId, array<string|int, mixed> $report) : ReportInterface
Parameters
- $start : int
- $end : int
- $dataSetIds : array<string|int, mixed>
- $organizationId : ObjectId
- $report : array<string|int, mixed>
Tags
Return values
ReportInterface —getFileName()
private
getFileName(string $extension) : string
Parameters
- $extension : string
Return values
string —getPeriodInSecond()
private
getPeriodInSecond(string $period) : array<string|int, mixed>
Parameters
- $period : string
Tags
Return values
array<string|int, mixed> —hasPeriodPassed()
private
hasPeriodPassed(int $periodEnd, int $lastSending) : bool
Parameters
- $periodEnd : int
- $lastSending : int
Return values
bool —saveReport()
private
saveReport(ReportInterface $report) : array<string|int, mixed>
Parameters
- $report : ReportInterface
Tags
Return values
array<string|int, mixed> —sendNotification()
private
sendNotification(SubscriptionEntity $subscription, array<string|int, UserEntity> $users, array<string|int, mixed> $data) : void
Parameters
- $subscription : SubscriptionEntity
- $users : array<string|int, UserEntity>
- $data : array<string|int, mixed>
Tags
Return values
void —sendReport()
private
sendReport(SubscriptionEntity $subscription, array<string|int, mixed> $period) : void
Parameters
- $subscription : SubscriptionEntity
- $period : array<string|int, mixed>
Tags
Return values
void —showInfoAboutGeneratedReport()
private
showInfoAboutGeneratedReport(SubscriptionEntity $subscription, array<string|int, mixed> $data) : void
Parameters
- $subscription : SubscriptionEntity
- $data : array<string|int, mixed>
Return values
void —showInfoAboutSentEmail()
private
showInfoAboutSentEmail(SubscriptionEntity $subscription, UserEntity $user) : void
Parameters
- $subscription : SubscriptionEntity
- $user : UserEntity