abstract-email-notification.php
4 years ago
ajax-handler.php
3 weeks ago
backward-compatibility.php
6 years ago
class-donation-receipt-email.php
4 years ago
class-donor-note-email.php
6 years ago
class-donor-register-email.php
4 years ago
class-email-access-email.php
1 week ago
class-email-notification-table.php
3 years ago
class-email-notification-util.php
6 years ago
class-email-notifications.php
5 months ago
class-email-setting-field.php
3 years ago
class-failed-donation-email.php
5 months ago
class-new-donation-email.php
6 years ago
class-new-donor-register-email.php
4 years ago
class-new-offline-donation-email.php
9 months ago
class-offline-donation-instruction-email.php
6 years ago
filters.php
4 years ago
class-offline-donation-instruction-email.php
301 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Offline Donation Instruction Email |
| 4 | * |
| 5 | * This class handles all email notification settings. |
| 6 | * |
| 7 | * @package Give |
| 8 | * @subpackage Classes/Emails |
| 9 | * @copyright Copyright (c) 2016, GiveWP |
| 10 | * @license https://opensource.org/licenses/gpl-license GNU Public License |
| 11 | * @since 2.0 |
| 12 | */ |
| 13 | |
| 14 | // Exit if access directly. |
| 15 | if ( ! defined( 'ABSPATH' ) ) { |
| 16 | exit; |
| 17 | } |
| 18 | |
| 19 | if ( ! class_exists( 'Give_Offline_Donation_Instruction_Email' ) ) : |
| 20 | |
| 21 | /** |
| 22 | * Give_Offline_Donation_Instruction_Email |
| 23 | * |
| 24 | * @abstract |
| 25 | * @since 2.0 |
| 26 | */ |
| 27 | class Give_Offline_Donation_Instruction_Email extends Give_Email_Notification { |
| 28 | /* @var Give_Payment $payment */ |
| 29 | public $payment; |
| 30 | |
| 31 | /** |
| 32 | * Create a class instance. |
| 33 | * |
| 34 | * @access public |
| 35 | * @since 2.0 |
| 36 | */ |
| 37 | public function init() { |
| 38 | // Initialize empty payment. |
| 39 | $this->payment = new Give_Payment( 0 ); |
| 40 | |
| 41 | $this->load( |
| 42 | array( |
| 43 | 'id' => 'offline-donation-instruction', |
| 44 | 'label' => __( 'Offline Donation Instructions', 'give' ), |
| 45 | 'description' => __( 'Sent to the donor when they submit an offline donation.', 'give' ), |
| 46 | 'notification_status' => give_is_gateway_active( 'offline' ) ? 'enabled' : 'disabled', |
| 47 | 'form_metabox_setting' => true, |
| 48 | 'notification_status_editable' => false, |
| 49 | 'preview_email_tag_values' => array( |
| 50 | 'payment_method' => esc_html__( 'Offline', 'give' ), |
| 51 | ), |
| 52 | 'default_email_subject' => esc_attr__( '{donation} - Offline Donation Instructions', 'give' ), |
| 53 | 'default_email_message' => give_get_default_offline_donation_email_content(), |
| 54 | 'default_email_header' => __( 'Offline Donation Instructions', 'give' ), |
| 55 | 'notices' => array( |
| 56 | 'non-notification-status-editable' => sprintf( |
| 57 | '%1$s <a href="%2$s">%3$s »</a>', |
| 58 | __( 'This notification is automatically toggled based on whether the gateway is enabled or not.', 'give' ), |
| 59 | esc_url( admin_url( 'edit.php?post_type=give_forms&page=give-settings&tab=gateways§ion=offline-donations' ) ), |
| 60 | __( 'Edit Setting', 'give' ) |
| 61 | ), |
| 62 | ), |
| 63 | ) |
| 64 | ); |
| 65 | |
| 66 | add_action( 'give_insert_payment', array( $this, 'setup_email_notification' ) ); |
| 67 | add_action( 'give_save_settings_give_settings', array( $this, 'set_notification_status' ), 10, 2 ); |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * Get email message |
| 72 | * |
| 73 | * @since 2.0 |
| 74 | * |
| 75 | * @param int $form_id |
| 76 | * |
| 77 | * @return string |
| 78 | */ |
| 79 | public function get_email_message( $form_id = null ) { |
| 80 | $message = Give_Email_Notification_Util::get_value( |
| 81 | $this, |
| 82 | Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'email_message', |
| 83 | $form_id, |
| 84 | $this->config['default_email_message'] |
| 85 | ); |
| 86 | |
| 87 | /** |
| 88 | * Filter the email message. |
| 89 | * |
| 90 | * @since 2.0 |
| 91 | */ |
| 92 | $message = apply_filters( |
| 93 | "give_{$this->config['id']}_get_email_message", |
| 94 | $message, |
| 95 | $this, |
| 96 | $form_id |
| 97 | ); |
| 98 | |
| 99 | return $message; |
| 100 | } |
| 101 | |
| 102 | /** |
| 103 | * Get email message |
| 104 | * |
| 105 | * @since 2.0 |
| 106 | * |
| 107 | * @param int $form_id |
| 108 | * |
| 109 | * @return string |
| 110 | */ |
| 111 | public function get_email_subject( $form_id = null ) { |
| 112 | $subject = wp_strip_all_tags( |
| 113 | Give_Email_Notification_Util::get_value( |
| 114 | $this, |
| 115 | Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'email_subject', |
| 116 | $form_id, |
| 117 | $this->config['default_email_subject'] |
| 118 | ) |
| 119 | ); |
| 120 | |
| 121 | /** |
| 122 | * Filter the email subject. |
| 123 | * |
| 124 | * @since 2.0 |
| 125 | */ |
| 126 | $subject = apply_filters( |
| 127 | "give_{$this->config['id']}_get_email_subject", |
| 128 | $subject, |
| 129 | $this, |
| 130 | $form_id |
| 131 | ); |
| 132 | |
| 133 | return $subject; |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Get attachments. |
| 138 | * |
| 139 | * @since 2.0 |
| 140 | * |
| 141 | * @param int $form_id |
| 142 | * @return array |
| 143 | */ |
| 144 | public function get_email_attachments( $form_id = null ) { |
| 145 | /** |
| 146 | * Filter the attachments. |
| 147 | * Note: This filter will deprecate soon. |
| 148 | * |
| 149 | * @since 1.0 |
| 150 | */ |
| 151 | $attachment = apply_filters( |
| 152 | 'give_offline_donation_attachments', |
| 153 | array(), |
| 154 | $this->payment->ID, |
| 155 | $this->payment->payment_meta |
| 156 | ); |
| 157 | |
| 158 | /** |
| 159 | * Filter the email attachment. |
| 160 | * |
| 161 | * @since 2.0 |
| 162 | */ |
| 163 | $attachment = apply_filters( |
| 164 | "give_{$this->config['id']}_get_email_attachment", |
| 165 | $attachment, |
| 166 | $this, |
| 167 | $form_id |
| 168 | ); |
| 169 | |
| 170 | return $attachment; |
| 171 | } |
| 172 | |
| 173 | |
| 174 | /** |
| 175 | * Set email data. |
| 176 | * |
| 177 | * @since 2.0 |
| 178 | */ |
| 179 | public function setup_email_data() { |
| 180 | // Set recipient email. |
| 181 | $this->recipient_email = $this->payment->email; |
| 182 | |
| 183 | /** |
| 184 | * Filters the from name. |
| 185 | * |
| 186 | * @since 1.7 |
| 187 | */ |
| 188 | $from_name = apply_filters( |
| 189 | 'give_donation_from_name', |
| 190 | Give()->emails->get_from_name(), |
| 191 | $this->payment->ID, |
| 192 | $this->payment->payment_meta |
| 193 | ); |
| 194 | |
| 195 | /** |
| 196 | * Filters the from email. |
| 197 | * |
| 198 | * @since 1.7 |
| 199 | */ |
| 200 | $from_email = apply_filters( |
| 201 | 'give_donation_from_address', |
| 202 | Give()->emails->get_from_address(), |
| 203 | $this->payment->ID, |
| 204 | $this->payment->payment_meta |
| 205 | ); |
| 206 | |
| 207 | Give()->emails->__set( 'from_name', $from_name ); |
| 208 | Give()->emails->__set( 'from_email', $from_email ); |
| 209 | Give()->emails->__set( 'headers', apply_filters( 'give_receipt_headers', Give()->emails->get_headers(), $this->payment->ID, $this->payment->payment_meta ) ); |
| 210 | } |
| 211 | |
| 212 | /** |
| 213 | * Setup email notification. |
| 214 | * |
| 215 | * @since 2.0 |
| 216 | * @access public |
| 217 | * |
| 218 | * @param int $payment_id |
| 219 | */ |
| 220 | public function setup_email_notification( $payment_id ) { |
| 221 | $this->payment = new Give_Payment( $payment_id ); |
| 222 | |
| 223 | if ( ! $this->payment->ID ) { |
| 224 | wp_die( |
| 225 | esc_html__( 'Cheatin’ uh?', 'give' ), |
| 226 | esc_html__( 'Error', 'give' ), |
| 227 | array( |
| 228 | 'response' => 400, |
| 229 | ) |
| 230 | ); |
| 231 | } |
| 232 | |
| 233 | // Exit if not donation was not with offline donation. |
| 234 | if ( 'offline' !== $this->payment->gateway ) { |
| 235 | return; |
| 236 | } |
| 237 | |
| 238 | // Set email data. |
| 239 | $this->setup_email_data(); |
| 240 | |
| 241 | // Send email. |
| 242 | $this->send_email_notification( |
| 243 | array( |
| 244 | 'payment_id' => $this->payment->ID, |
| 245 | ) |
| 246 | ); |
| 247 | } |
| 248 | |
| 249 | /** |
| 250 | * Set notification status |
| 251 | * |
| 252 | * @since 2.0 |
| 253 | * @access public |
| 254 | * |
| 255 | * @param $update_options |
| 256 | * @param $option_name |
| 257 | */ |
| 258 | public function set_notification_status( $update_options, $option_name ) { |
| 259 | // Get updated settings. |
| 260 | $update_options = give_get_settings(); |
| 261 | |
| 262 | $notification_status = isset( $update_options['gateways']['offline'] ) ? 'enabled' : 'disabled'; |
| 263 | |
| 264 | if ( |
| 265 | empty( $update_options[ "{$this->config['id']}_notification" ] ) |
| 266 | || $notification_status !== $update_options[ "{$this->config['id']}_notification" ] |
| 267 | ) { |
| 268 | $update_options[ "{$this->config['id']}_notification" ] = $notification_status; |
| 269 | update_option( $option_name, $update_options, false ); |
| 270 | } |
| 271 | } |
| 272 | |
| 273 | |
| 274 | /** |
| 275 | * Register email settings to form metabox. |
| 276 | * |
| 277 | * @since 2.0 |
| 278 | * @access public |
| 279 | * |
| 280 | * @param array $settings |
| 281 | * @param int $form_id |
| 282 | * |
| 283 | * @return array |
| 284 | */ |
| 285 | public function add_metabox_setting_field( $settings, $form_id ) { |
| 286 | if ( in_array( 'offline', array_keys( give_get_enabled_payment_gateways( $form_id ) ) ) ) { |
| 287 | $settings[] = array( |
| 288 | 'id' => $this->config['id'], |
| 289 | 'title' => $this->config['label'], |
| 290 | 'fields' => $this->get_setting_fields( $form_id ), |
| 291 | ); |
| 292 | } |
| 293 | |
| 294 | return $settings; |
| 295 | } |
| 296 | } |
| 297 | |
| 298 | endif; // End class_exists check |
| 299 | |
| 300 | return Give_Offline_Donation_Instruction_Email::get_instance(); |
| 301 |