GroupSubscriptionProcessor uses trait:short
Table of Contents
Properties
- $doubleOptin : bool
- Toggle behavior of confirming subscriptions via email.
- $method : string
- String to indicate who added/removed the group.
- $tracking : string
- IP address or other tracking info about who performed this group subscription.
Methods
- getDoubleOptin() : bool
- getEnabledGroups() : array<string|int, mixed>
- getSubscriptionHistoryMethods() : array<string|int, mixed>
- setDoubleOptin() : mixed
- write() : mixed
- writeRecord() : array<string|int, mixed>
- Function to process groups
- getContactPrimaryEmail() : string|null
- Function to get contact primary email
- saveGroupStatus() : void
- Add or update groupContact status
- triggerDoubleOptin() : void
- Function to trigger double optin process
Properties
$doubleOptin
Toggle behavior of confirming subscriptions via email.
protected
bool
$doubleOptin
= TRUE
$method
String to indicate who added/removed the group.
protected
string
$method
= 'API'
Tags
$tracking
IP address or other tracking info about who performed this group subscription.
protected
string
$tracking
= ''
Methods
getDoubleOptin()
public
getDoubleOptin() : bool
Return values
boolgetEnabledGroups()
public
static getEnabledGroups() : array<string|int, mixed>
Return values
array<string|int, mixed>getSubscriptionHistoryMethods()
public
static getSubscriptionHistoryMethods() : array<string|int, mixed>
Return values
array<string|int, mixed>setDoubleOptin()
public
setDoubleOptin(bool $doubleOptin) : mixed
Parameters
- $doubleOptin : bool
write()
protected
write(array<string|int, mixed> $items) : mixed
Parameters
- $items : array<string|int, mixed>
Tags
writeRecord()
Function to process groups
protected
writeRecord(array<string|int, mixed> $submittedData) : array<string|int, mixed>
Parameters
- $submittedData : array<string|int, mixed>
Return values
array<string|int, mixed>getContactPrimaryEmail()
Function to get contact primary email
private
static getContactPrimaryEmail(int $contactId) : string|null
Parameters
- $contactId : int
Return values
string|nullsaveGroupStatus()
Add or update groupContact status
private
static saveGroupStatus(int $contactId, string $groupName, string $status, string $method, string|null $tracking) : void
Parameters
- $contactId : int
- $groupName : string
- $status : string
- $method : string
- $tracking : string|null
triggerDoubleOptin()
Function to trigger double optin process
private
static triggerDoubleOptin(int $contactId, string $groupName, string $email) : void
Parameters
- $contactId : int
- $groupName : string
- $email : string