NewsletterController
in package
Define the general newsletter controller interface
Tags
Table of Contents
- $_searchController : SearchPlugin|null
- $dbal : NewsletterDBAL|null
- $newsletter : Newsletter|null
- $processed : array<string|int, mixed>
- Hash map of processed items
- __construct() : mixed
- NewsletterController constructor.
- ProcessPending() : Result
- Process potentially pending newsletters
- ProcessUsers() : Result
- database() : NewsletterDBAL|null
- RequiresNotification() : array<string|int, DateTime>|null
- get the list of required items
- searchController() : SearchPlugin
Properties
$_searchController
protected
SearchPlugin|null
$_searchController
= null
$dbal
protected
NewsletterDBAL|null
$dbal
= null
$newsletter
protected
Newsletter|null
$newsletter
= null
$processed
Hash map of processed items
protected
array<string|int, mixed>
$processed
= []
Methods
__construct()
NewsletterController constructor.
public
__construct(Newsletter $newsletter) : mixed
Parameters
- $newsletter : Newsletter
Return values
mixed —ProcessPending()
Process potentially pending newsletters
public
ProcessPending([bool $live = false ]) : Result
Parameters
- $live : bool = false
Return values
Result —ProcessUsers()
public
ProcessUsers([bool $live = false ]) : Result
Parameters
- $live : bool = false
Return values
Result —database()
protected
database() : NewsletterDBAL|null
Return values
NewsletterDBAL|null —RequiresNotification()
get the list of required items
protected
abstract RequiresNotification(User|Customer $user) : array<string|int, DateTime>|null
Parameters
Return values
array<string|int, DateTime>|null —searchController()
protected
searchController() : SearchPlugin