mailster-add-subscriber-to-list.php
1 month ago
mailster-add-tag-to-subscriber.php
1 month ago
mailster-add-update-subscriber.php
1 month ago
mailster-delete-subscriber.php
1 month ago
mailster-get-subscriber-by-email.php
1 month ago
mailster-remove-subscriber-from-list.php
1 month ago
mailster-remove-tag-from-subscriber.php
1 month ago
mailster-unsubscribe-subscriber.php
1 month ago
mailster-unsubscribe-subscriber.php
114 lines
| 1 | <?php |
| 2 | /** |
| 3 | * MailsterUnsubscribeSubscriber. |
| 4 | * php version 5.6 |
| 5 | * |
| 6 | * @category MailsterUnsubscribeSubscriber |
| 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\Actions; |
| 15 | |
| 16 | use Exception; |
| 17 | use SureTriggers\Integrations\AutomateAction; |
| 18 | use SureTriggers\Traits\SingletonLoader; |
| 19 | |
| 20 | /** |
| 21 | * MailsterUnsubscribeSubscriber |
| 22 | * |
| 23 | * @category MailsterUnsubscribeSubscriber |
| 24 | * @package SureTriggers |
| 25 | * @author BSF <username@example.com> |
| 26 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPLv3 |
| 27 | * @link https://www.brainstormforce.com/ |
| 28 | * @since 1.0.0 |
| 29 | */ |
| 30 | class MailsterUnsubscribeSubscriber extends AutomateAction { |
| 31 | |
| 32 | /** |
| 33 | * Integration type. |
| 34 | * |
| 35 | * @var string |
| 36 | */ |
| 37 | public $integration = 'Mailster'; |
| 38 | |
| 39 | /** |
| 40 | * Action name. |
| 41 | * |
| 42 | * @var string |
| 43 | */ |
| 44 | public $action = 'mailster_unsubscribe_subscriber'; |
| 45 | |
| 46 | use SingletonLoader; |
| 47 | |
| 48 | /** |
| 49 | * Register a action. |
| 50 | * |
| 51 | * @param array $actions actions. |
| 52 | * @return array |
| 53 | */ |
| 54 | public function register( $actions ) { |
| 55 | |
| 56 | $actions[ $this->integration ][ $this->action ] = [ |
| 57 | 'label' => __( 'Unsubscribe Subscriber', 'suretriggers' ), |
| 58 | 'action' => $this->action, |
| 59 | 'function' => [ $this, 'action_listener' ], |
| 60 | ]; |
| 61 | return $actions; |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * Action listener. |
| 66 | * |
| 67 | * Uses `mailster( 'subscribers' )->unsubscribe()` (classes/subscribers.class.php) |
| 68 | * which fires `mailster_unsubscribe` on completion. |
| 69 | * |
| 70 | * @param int $user_id user_id. |
| 71 | * @param int $automation_id automation_id. |
| 72 | * @param array $fields fields. |
| 73 | * @param array $selected_options selectedOptions. |
| 74 | * @return array|void |
| 75 | * @throws Exception Exception. |
| 76 | */ |
| 77 | public function _action_listener( $user_id, $automation_id, $fields, $selected_options ) { |
| 78 | if ( ! function_exists( 'mailster' ) ) { |
| 79 | return [ |
| 80 | 'status' => 'error', |
| 81 | 'message' => __( 'Mailster plugin functions not found.', 'suretriggers' ), |
| 82 | ]; |
| 83 | } |
| 84 | |
| 85 | $email = isset( $selected_options['email'] ) ? sanitize_email( (string) $selected_options['email'] ) : ''; |
| 86 | |
| 87 | if ( empty( $email ) || ! is_email( $email ) ) { |
| 88 | return [ |
| 89 | 'status' => 'error', |
| 90 | 'message' => __( 'Email address is invalid.', 'suretriggers' ), |
| 91 | ]; |
| 92 | } |
| 93 | |
| 94 | $subscriber = mailster( 'subscribers' )->get_by_mail( $email ); |
| 95 | |
| 96 | if ( ! is_object( $subscriber ) || empty( $subscriber->ID ) ) { |
| 97 | return [ |
| 98 | 'status' => 'error', |
| 99 | 'message' => __( 'Subscriber not found with this email.', 'suretriggers' ), |
| 100 | ]; |
| 101 | } |
| 102 | |
| 103 | mailster( 'subscribers' )->unsubscribe( absint( $subscriber->ID ) ); |
| 104 | |
| 105 | return [ |
| 106 | 'subscriber_id' => absint( $subscriber->ID ), |
| 107 | 'email' => $email, |
| 108 | ]; |
| 109 | } |
| 110 | |
| 111 | } |
| 112 | |
| 113 | MailsterUnsubscribeSubscriber::get_instance(); |
| 114 |