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-new-offline-donation-email.php
335 lines
| 1 | <?php |
| 2 | /** |
| 3 | * New Offline Donation 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_New_Offline_Donation_Email' ) ) : |
| 20 | |
| 21 | /** |
| 22 | * Give_New_Offline_Donation_Email |
| 23 | * |
| 24 | * @abstract |
| 25 | * @since 2.0 |
| 26 | */ |
| 27 | class Give_New_Offline_Donation_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' => 'new-offline-donation', |
| 44 | 'label' => __( 'New Offline Donation', 'give' ), |
| 45 | 'description' => __( 'Sent to designated recipient(s) for a new (pending) offline donation.', 'give' ), |
| 46 | 'has_recipient_field' => true, |
| 47 | 'notification_status' => give_is_gateway_active( 'offline' ) ? 'enabled' : 'disabled', |
| 48 | 'notification_status_editable' => false, |
| 49 | 'preview_email_tags_values' => array( |
| 50 | 'payment_method' => esc_html__( 'Offline', 'give' ), |
| 51 | ), |
| 52 | 'default_email_subject' => $this->get_default_email_subject(), |
| 53 | 'default_email_message' => ( false !== give_get_option( 'new-offline-donation_email_message' ) ) ? give_get_option( 'new-offline-donation_email_message' ) : $this->get_default_email_message(), |
| 54 | 'default_email_header' => __( 'New Offline Donation!', '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 default email subject. |
| 72 | * |
| 73 | * @since 2.0 |
| 74 | * @access public |
| 75 | * @return string |
| 76 | */ |
| 77 | public function get_default_email_subject() { |
| 78 | /** |
| 79 | * Filter the default subject. |
| 80 | * Note: This filter will deprecate soon. |
| 81 | * |
| 82 | * @since 1.0 |
| 83 | */ |
| 84 | $subject = apply_filters( |
| 85 | 'give_offline_admin_donation_notification_subject', |
| 86 | __( 'New Pending Donation', 'give' ) |
| 87 | ); |
| 88 | |
| 89 | /** |
| 90 | * Filter the default subject |
| 91 | * |
| 92 | * @since 2.0 |
| 93 | */ |
| 94 | return apply_filters( |
| 95 | "give_{$this->config['id']}_get_default_email_subject", |
| 96 | $subject, |
| 97 | $this |
| 98 | ); |
| 99 | } |
| 100 | |
| 101 | |
| 102 | /** |
| 103 | * Get default email message. |
| 104 | * |
| 105 | * @since 2.0 |
| 106 | * @access public |
| 107 | * |
| 108 | * @return string |
| 109 | */ |
| 110 | public function get_default_email_message() { |
| 111 | $message = __( 'Dear Admin,', 'give' ) . "\n\n"; |
| 112 | $message .= __( 'An offline donation has been made on your website:', 'give' ) . ' ' . get_bloginfo( 'name' ) . ' '; |
| 113 | $message .= __( 'Hooray! The donation is in a pending status and is awaiting payment. Donation instructions have been emailed to the donor. Once you receive payment, be sure to mark the donation as complete using the link below.', 'give' ) . "\n\n"; |
| 114 | |
| 115 | $message .= '<strong>' . __( 'Donor:', 'give' ) . '</strong> {fullname}' . "\n"; |
| 116 | $message .= '<strong>' . __( 'Amount:', 'give' ) . '</strong> {amount}' . "\n\n"; |
| 117 | |
| 118 | $message .= sprintf( |
| 119 | '<a href="%1$s">%2$s</a>', |
| 120 | admin_url( 'edit.php?post_type=give_forms&page=give-payment-history&view=view-payment-details&id=' . $this->payment->ID ), |
| 121 | __( 'Click Here to View and/or Update Donation Details', 'give' ) |
| 122 | ) . "\n\n"; |
| 123 | |
| 124 | /** |
| 125 | * Filter the donation receipt email message |
| 126 | * Note: This filter will deprecate soon. |
| 127 | * |
| 128 | * @since 1.0 |
| 129 | * |
| 130 | * @param string $message |
| 131 | */ |
| 132 | $message = apply_filters( |
| 133 | 'give_default_new_offline_donation_email', |
| 134 | $message, |
| 135 | $this->payment->ID |
| 136 | ); |
| 137 | |
| 138 | /** |
| 139 | * Filter the default message |
| 140 | * |
| 141 | * @since 2.0 |
| 142 | */ |
| 143 | return apply_filters( |
| 144 | "give_{$this->config['id']}_get_default_email_message", |
| 145 | $message, |
| 146 | $this |
| 147 | ); |
| 148 | } |
| 149 | |
| 150 | |
| 151 | /** |
| 152 | * Get message |
| 153 | * |
| 154 | * @since 2.0 |
| 155 | * |
| 156 | * @param int $form_id |
| 157 | * |
| 158 | * @return string |
| 159 | */ |
| 160 | public function get_email_message( $form_id = null ) { |
| 161 | $message = Give_Email_Notification_Util::get_value( |
| 162 | $this, |
| 163 | Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'email_message', |
| 164 | $form_id, |
| 165 | $this->config['default_email_message'] |
| 166 | ); |
| 167 | |
| 168 | /** |
| 169 | * Filter the email message. |
| 170 | * Note: This filter will deprecate soon. |
| 171 | * |
| 172 | * @since 1.0 |
| 173 | */ |
| 174 | $message = apply_filters( |
| 175 | 'give_offline_admin_donation_notification', |
| 176 | $message, |
| 177 | $this->payment->ID |
| 178 | ); |
| 179 | |
| 180 | /** |
| 181 | * Filter the email message |
| 182 | * |
| 183 | * @since 2.0 |
| 184 | */ |
| 185 | return apply_filters( |
| 186 | "give_{$this->config['id']}_get_email_message", |
| 187 | $message, |
| 188 | $this, |
| 189 | $form_id |
| 190 | ); |
| 191 | } |
| 192 | |
| 193 | |
| 194 | /** |
| 195 | * Get attachments. |
| 196 | * |
| 197 | * @since 2.0 |
| 198 | * |
| 199 | * @param int $form_id |
| 200 | * |
| 201 | * @return array |
| 202 | */ |
| 203 | public function get_email_attachments( $form_id = null ) { |
| 204 | /** |
| 205 | * Filter the attachments. |
| 206 | * Note: This filter will deprecate soon. |
| 207 | * |
| 208 | * @since 1.0 |
| 209 | */ |
| 210 | $attachment = apply_filters( |
| 211 | 'give_offline_admin_donation_notification_attachments', |
| 212 | array(), |
| 213 | $this->payment->ID |
| 214 | ); |
| 215 | |
| 216 | /** |
| 217 | * Filter the attachments. |
| 218 | * |
| 219 | * @since 2.0 |
| 220 | */ |
| 221 | return apply_filters( |
| 222 | "give_{$this->config['id']}_get_email_attachments", |
| 223 | $attachment, |
| 224 | $this |
| 225 | ); |
| 226 | } |
| 227 | |
| 228 | |
| 229 | /** |
| 230 | * Set email data. |
| 231 | * |
| 232 | * @since 2.0 |
| 233 | */ |
| 234 | public function setup_email_data() { |
| 235 | // Set header. |
| 236 | Give()->emails->__set( |
| 237 | 'headers', |
| 238 | apply_filters( |
| 239 | 'give_offline_admin_donation_notification_headers', |
| 240 | Give()->emails->get_headers(), |
| 241 | $this->payment->ID |
| 242 | ) |
| 243 | ); |
| 244 | } |
| 245 | |
| 246 | /** |
| 247 | * Setup email notification. |
| 248 | * |
| 249 | * @since 2.0 |
| 250 | * @access public |
| 251 | * |
| 252 | * @param int $payment_id |
| 253 | */ |
| 254 | public function setup_email_notification( $payment_id ) { |
| 255 | $this->payment = new Give_Payment( $payment_id ); |
| 256 | |
| 257 | if ( ! $this->payment->ID ) { |
| 258 | wp_die( |
| 259 | esc_html__( 'Cheatin’ uh?', 'give' ), |
| 260 | esc_html__( 'Error', 'give' ), |
| 261 | array( |
| 262 | 'response' => 400, |
| 263 | ) |
| 264 | ); |
| 265 | } |
| 266 | |
| 267 | // Exit if not donation was not with offline donation. |
| 268 | if ( 'offline' !== $this->payment->gateway ) { |
| 269 | return; |
| 270 | } |
| 271 | |
| 272 | // Set email data. |
| 273 | $this->setup_email_data(); |
| 274 | |
| 275 | // Send email. |
| 276 | $this->send_email_notification( |
| 277 | array( |
| 278 | 'payment_id' => $this->payment->ID, |
| 279 | ) |
| 280 | ); |
| 281 | } |
| 282 | |
| 283 | /** |
| 284 | * Set notification status |
| 285 | * |
| 286 | * @since 2.0 |
| 287 | * @access public |
| 288 | * |
| 289 | * @param $update_options |
| 290 | * @param $option_name |
| 291 | */ |
| 292 | public function set_notification_status( $update_options, $option_name ) { |
| 293 | // Get updated settings. |
| 294 | $update_options = give_get_settings(); |
| 295 | |
| 296 | $notification_status = isset( $update_options['gateways']['offline'] ) ? 'enabled' : 'disabled'; |
| 297 | |
| 298 | if ( |
| 299 | empty( $update_options[ "{$this->config['id']}_notification" ] ) |
| 300 | || $notification_status !== $update_options[ "{$this->config['id']}_notification" ] |
| 301 | ) { |
| 302 | $update_options[ "{$this->config['id']}_notification" ] = $notification_status; |
| 303 | update_option( $option_name, $update_options, false ); |
| 304 | } |
| 305 | } |
| 306 | |
| 307 | /** |
| 308 | * Register email settings to form metabox. |
| 309 | * |
| 310 | * @since 2.0 |
| 311 | * @access public |
| 312 | * |
| 313 | * @param array $settings |
| 314 | * @param int $form_id |
| 315 | * |
| 316 | * @return array |
| 317 | */ |
| 318 | public function add_metabox_setting_field( $settings, $form_id ) { |
| 319 | |
| 320 | if ( in_array( 'offline', array_keys( give_get_enabled_payment_gateways( $form_id ) ) ) ) { |
| 321 | $settings[] = array( |
| 322 | 'id' => $this->config['id'], |
| 323 | 'title' => $this->config['label'], |
| 324 | 'fields' => $this->get_setting_fields( $form_id ), |
| 325 | ); |
| 326 | } |
| 327 | |
| 328 | return $settings; |
| 329 | } |
| 330 | } |
| 331 | |
| 332 | endif; // End class_exists check |
| 333 | |
| 334 | return Give_New_Offline_Donation_Email::get_instance(); |
| 335 |