DefaultBatcher
extends AutoService
in package
uses
IsActiveTrait
AutoService is a base-class for defining a service (in Civi's service-container).
Tags
Table of Contents
Properties
- $active : bool
Methods
- isActive() : bool
- onWalk() : mixed
- Given a MailingJob (`$e->getJob()`), enumerate the recipients as a batch of FlexMailerTasks and visit each batch (`$e->visit($tasks)`).
- setActive() : $this
- findPendingTasks() : CRM_Mailing_Event_BAO_MailingEventQueue
- Search the mailing-event queue for a list of pending delivery tasks.
Properties
$active
private
bool
$active
= TRUE
Methods
isActive()
public
isActive() : bool
Return values
boolonWalk()
Given a MailingJob (`$e->getJob()`), enumerate the recipients as a batch of FlexMailerTasks and visit each batch (`$e->visit($tasks)`).
public
onWalk(WalkBatchesEvent $e) : mixed
Parameters
- $e : WalkBatchesEvent
setActive()
public
setActive(bool $active) : $this
Parameters
- $active : bool
Return values
$thisfindPendingTasks()
Search the mailing-event queue for a list of pending delivery tasks.
private
findPendingTasks(int $jobId) : CRM_Mailing_Event_BAO_MailingEventQueue
Parameters
- $jobId : int
Return values
CRM_Mailing_Event_BAO_MailingEventQueue —A query object whose rows provide ('id', 'contact_id', 'hash') and ('email' or 'phone').