merge in CC-34 to our 1.1.0 release

Author: tw2113

README.txt

@@ -20,14 +20,6 @@ and send targeted emails that engage your customers on every device.
 
 Unleash the power of your business—and drive more revenue—by integrating Constant Contact with WooCommerce today.
 
-== Changelog ==
-
-= 1.1.0 =
-
-* Added: Campaign ID data inclusion for purchased orders originating from your mailing campaigns.
-* Fixed: compatibility issue with phone numbers and PHP 7.3
-* Updated: Wording in our WooCommerce tab.
-
 With Constant Contact you can:
 - Drag and drop products from your store into any email and customize the details.
 - Automatically import WooCommere contacts into your Constant Contact account.
@@ -40,3 +32,11 @@ With Constant Contact you can:
 --- Prospects: Have not made a purchase yet
 - Send automated welcome emails and behavior based trigger emails
 - Find new customers with Facebook and Instagram ads
+
+== Changelog ==
+
+= 1.1.0 =
+
+* Added: Campaign ID data inclusion for purchased orders originating from your mailing campaigns.
+* Fixed: compatibility issue with phone numbers and PHP 7.3
+* Updated: Wording in our WooCommerce tab.

src/View/Checkout/CampaignId.php

@@ -0,0 +1,91 @@
+<?php
+/**
+ * Class to handle filtering fields in the checkout billing form.
+ *
+ * @see     https://docs.woocommerce.com/document/tutorial-customising-checkout-fields-using-actions-and-filters/
+ * @author  Michael Beckwith <[email protected]>
+ * @package WebDevStudios\CCForWoo\View\Checkout
+ * @since   2019-08-22
+ */
+
+namespace WebDevStudios\CCForWoo\View\Checkout;
+
+use WebDevStudios\OopsWP\Utility\Hookable;
+
+/**
+ * Class CampaignId
+ *
+ * @author  Michael Beckwith <[email protected]>
+ * @package WebDevStudios\CCForWoo\View\Checkout
+ * @since   2019-08-22
+ */
+class CampaignId implements Hookable {
+	/**
+	 * The name of the meta field for the customer's preference.
+	 * This constant will be used both in usermeta (for users) and postmeta (for orders).
+	 *
+	 * @var string
+	 * @since 2019-08-22
+	 */
+	const CUSTOMER_CAMPAIGN_ID_KEY = 'campaign_activity_id';
+
+	/**
+	 * Register actions and filters with WordPress.
+	 *
+	 * @author Michael Beckwith <[email protected]>
+	 * @since  2019-08-22
+	 */
+	public function register_hooks() {
+		add_action( 'init', [ $this, 'save_campaign_id' ], 11 );
+		add_action( 'woocommerce_checkout_update_order_meta', [ $this, 'save_user_campaign_id_to_order' ] );
+	}
+
+	/**
+	 * Save the user preference to the order meta.
+	 *
+	 * @param int $order_id The order ID.
+	 *
+	 * @author Michael Beckwith <[email protected]>
+	 * @since  2019-08-22
+	 * @return void
+	 */
+	public function save_user_campaign_id_to_order( $order_id ) {
+		$preference = $this->get_stored_campaign_id();
+
+		if ( empty( $preference ) ) {
+			return;
+		}
+
+		add_post_meta( $order_id, self::CUSTOMER_CAMPAIGN_ID_KEY, $preference, true );
+	}
+
+	/**
+	 * Save the campaign ID for the session.
+	 *
+	 * @throws \Exception DateTime exception.
+	 *
+	 * @author Michael Beckwith <[email protected]>
+	 * @since  2019-08-22
+	 * @return void
+	 */
+	public function save_campaign_id() {
+		$campaign_id = filter_input( INPUT_GET, 'source', FILTER_SANITIZE_STRING );
+
+		if ( ! empty( $campaign_id ) ) {
+			setcookie( 'ctct_woo_campaign_id', $campaign_id, 0, '/' );
+		}
+	}
+
+	/**
+	 * Get the submitted customer newsletter preference.
+	 *
+	 * @author Michael Beckwith <[email protected]>
+	 * @since  2019-08-22
+	 * @return string
+	 */
+	private function get_stored_campaign_id() {
+		return isset( $_COOKIE['ctct_woo_campaign_id'] )
+			? sanitize_text_field( $_COOKIE['ctct_woo_campaign_id'] )
+			: '';
+	}
+}

src/View/ViewRegistrar.php

@@ -10,6 +10,7 @@
 namespace WebDevStudios\CCForWoo\View;
 
 use WebDevStudios\CCForWoo\View\Admin\WooTab;
+use WebDevStudios\CCForWoo\View\Checkout\CampaignId;
 use WebDevStudios\CCForWoo\View\Checkout\NewsletterPreferenceCheckbox;
 use WebDevStudios\OopsWP\Structure\Service;
 
@@ -35,6 +36,7 @@ class ViewRegistrar extends Service {
 	 */
 	protected $forms = [
 		NewsletterPreferenceCheckbox::class,
+		CampaignId::class,
 	];