MailingListService
in package
Service for managing mailing list subscriptions.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- Initialize the mailing list service.
- exportCsv() : string
- Export subscribers as CSV content.
- getStats() : array<string|int, mixed>
- Get mailing list statistics for a business.
- handleOrderOptIn() : void
- Handle mailing list opt-in from an order.
- subscribe() : array<string|int, mixed>
- Subscribe an email to a business mailing list.
- unsubscribe() : array<string|int, mixed>
- Unsubscribe an email from a business mailing list.
- escapeCsv() : string
- Escape a value for CSV output.
Properties
$mailingListModel
private
CustomerMailingList
$mailingListModel
Mailing list model
Methods
__construct()
Initialize the mailing list service.
public
__construct() : mixed
exportCsv()
Export subscribers as CSV content.
public
exportCsv(int $businessId) : string
Parameters
- $businessId : int
-
Business ID
Return values
string —CSV content
getStats()
Get mailing list statistics for a business.
public
getStats(int $businessId) : array<string|int, mixed>
Parameters
- $businessId : int
-
Business ID
Return values
array<string|int, mixed>handleOrderOptIn()
Handle mailing list opt-in from an order.
public
handleOrderOptIn(int $businessId, string $email, string $name, int|null $customerId, bool $optIn) : void
Parameters
- $businessId : int
-
Business ID
- $email : string
-
Customer email
- $name : string
-
Customer name
- $customerId : int|null
-
Customer ID
- $optIn : bool
-
Whether the customer opted in
subscribe()
Subscribe an email to a business mailing list.
public
subscribe(int $businessId, string $email[, string|null $name = null ][, int|null $customerId = null ]) : array<string|int, mixed>
Parameters
- $businessId : int
-
Business ID
- $email : string
-
Email address
- $name : string|null = null
-
Subscriber name
- $customerId : int|null = null
-
Customer ID
Return values
array<string|int, mixed> —Result with keys: success, error
unsubscribe()
Unsubscribe an email from a business mailing list.
public
unsubscribe(int $businessId, string $email) : array<string|int, mixed>
Parameters
- $businessId : int
-
Business ID
- $email : string
-
Email address
Return values
array<string|int, mixed> —Result with keys: success, error
escapeCsv()
Escape a value for CSV output.
private
escapeCsv(string $value) : string
Parameters
- $value : string
-
Value to escape