mailster-subscriber-unsubscribed.php — OttoKit: All-in-One Automation Platform 1.1.35

suretriggers / src / Integrations / Mailster / triggers / mailster-subscriber-unsubscribed.php

suretriggers / src / Integrations / Mailster / triggers Last commit date

mailster-subscriber-unsubscribed.php

115 lines

1	<?php
2	/**
3	* MailsterSubscriberUnsubscribed trigger.
4	* php version 5.6
5	*
6	* @category MailsterSubscriberUnsubscribed
7	* @package SureTriggers
8	* @author BSF <username@example.com>
9	* @license https://www.gnu.org/licenses/gpl-3.0.html GPLv3
10	* @link https://www.brainstormforce.com/
11	* @since 1.0.0
12	*/
13
14	namespace SureTriggers\Integrations\Mailster\Triggers;
15
16	use SureTriggers\Controllers\AutomationController;
17	use SureTriggers\Traits\SingletonLoader;
18
19	/**
20	* MailsterSubscriberUnsubscribed
21	*
22	* @category MailsterSubscriberUnsubscribed
23	* @package SureTriggers
24	* @author BSF <username@example.com>
25	* @license https://www.gnu.org/licenses/gpl-3.0.html GPLv3
26	* @link https://www.brainstormforce.com/
27	* @since 1.0.0
28	*/
29	class MailsterSubscriberUnsubscribed {
30
31	/**
32	* Integration type.
33	*
34	* @var string
35	*/
36	public $integration = 'Mailster';
37
38	/**
39	* Trigger name.
40	*
41	* @var string
42	*/
43	public $trigger = 'mailster_subscriber_unsubscribed';
44
45	use SingletonLoader;
46
47	/**
48	* Constructor
49	*
50	* @since 1.0.0
51	*/
52	public function __construct() {
53	add_filter( 'sure_trigger_register_trigger', [ $this, 'register' ] );
54	}
55
56	/**
57	* Register a trigger.
58	*
59	* @param array $triggers triggers.
60	* @return array
61	*/
62	public function register( $triggers ) {
63	$triggers[ $this->integration ][ $this->trigger ] = [
64	'label' => __( 'Subscriber Unsubscribed', 'suretriggers' ),
65	'action' => $this->trigger,
66	'common_action' => 'mailster_unsubscribe',
67	'function' => [ $this, 'trigger_listener' ],
68	'priority' => 10,
69	'accepted_args' => 4,
70	];
71
72	return $triggers;
73	}
74
75	/**
76	* Trigger listener.
77	*
78	* Fires from Mailster's `mailster_unsubscribe` action
79	* (classes/subscribers.class.php) when a subscriber unsubscribes,
80	* optionally in the context of a specific campaign.
81	*
82	* @param int $subscriber_id Subscriber ID.
83	* @param int\|null $campaign_id Campaign ID the unsubscribe originated from, if any.
84	* @param int\|null $status Status the subscriber was set to.
85	* @param int\|null $index Link index, if unsubscribed via a tracked link.
86	* @return void
87	*/
88	public function trigger_listener( $subscriber_id, $campaign_id = null, $status = null, $index = null ) {
89	if ( empty( $subscriber_id ) \|\| ! function_exists( 'mailster' ) ) {
90	return;
91	}
92
93	$subscriber = mailster( 'subscribers' )->get( absint( $subscriber_id ) );
94
95	$campaign_id = is_numeric( $campaign_id ) ? absint( $campaign_id ) : 0;
96
97	$context = [
98	'subscriber_id' => absint( $subscriber_id ),
99	'email' => is_object( $subscriber ) && isset( $subscriber->email ) ? sanitize_email( (string) $subscriber->email ) : '',
100	'campaign_id' => $campaign_id,
101	'campaign_title' => $campaign_id ? get_the_title( $campaign_id ) : '',
102	'status' => is_numeric( $status ) ? absint( $status ) : 2,
103	];
104
105	AutomationController::sure_trigger_handle_trigger(
106	[
107	'trigger' => $this->trigger,
108	'context' => $context,
109	]
110	);
111	}
112	}
113
114	MailsterSubscriberUnsubscribed::get_instance();
115