From 3dcbc41adf576047c80ad5e12d9a1bde0d1ae357 Mon Sep 17 00:00:00 2001
From: Maciej Zgadzaj <maciej.zgadzaj@gmail.com>
Date: Fri, 25 Jan 2013 11:18:18 -0500
Subject: [PATCH] Issue #1305242 by maciej.zgadzaj: Added ajaxified Remove coupon buttons in Coupons checkout pane

---
 commerce_coupon.info                               |    3 +-
 commerce_coupon.module                             |    8 ++
 includes/commerce_coupon.checkout_pane.inc         |   68 ++++++++++++++++----
 includes/views/commerce_coupon.views.inc           |    8 ++
 .../views/commerce_coupon_ui.views_default.inc     |    4 +
 ...commerce_coupon_handler_field_coupon_remove.inc |   65 +++++++++++++++++++
 6 files changed, 141 insertions(+), 15 deletions(-)
 create mode 100644 includes/views/handlers/commerce_coupon_handler_field_coupon_remove.inc

diff --git a/commerce_coupon.info b/commerce_coupon.info
index a2f94b5..3cafd49 100644
--- a/commerce_coupon.info
+++ b/commerce_coupon.info
@@ -17,4 +17,5 @@ files[] = classes/commerce_coupon_type.inc
 ; Views Handler
 files[] = includes/views/handlers/commerce_coupon_handler_field_coupon_granted_amount.inc
 files[] = includes/views/handlers/commerce_coupon_handler_field_coupon_operations.inc
-files[] = includes/views/handlers/commerce_coupon_handler_field_times_used.inc
\ No newline at end of file
+files[] = includes/views/handlers/commerce_coupon_handler_field_coupon_remove.inc
+files[] = includes/views/handlers/commerce_coupon_handler_field_times_used.inc
diff --git a/commerce_coupon.module b/commerce_coupon.module
index 5adb5f8..92b8ed5 100644
--- a/commerce_coupon.module
+++ b/commerce_coupon.module
@@ -144,6 +144,14 @@ function commerce_coupon_permission() {
 }
 
 /**
+ * Implements hook_form_FORM_ID_alter().
+ */
+function commerce_coupon_form_commerce_checkout_form_checkout_alter(&$form, &$form_state) {
+  $form['#prefix'] = '<div id="commerce-checkout-form-ajax-wrapper">';
+  $form['#suffix'] = '</div>';
+}
+
+/**
  * Generates a new unique coupon code.
  *
  * @param $length
diff --git a/includes/commerce_coupon.checkout_pane.inc b/includes/commerce_coupon.checkout_pane.inc
index b915639..29a2811 100644
--- a/includes/commerce_coupon.checkout_pane.inc
+++ b/includes/commerce_coupon.checkout_pane.inc
@@ -33,7 +33,7 @@ function commerce_coupon_pane_checkout_form($form, &$form_state, $checkout_pane,
       '#limit_validation_errors' => array(),
       '#ajax' => array(
         'callback' => 'commerce_coupon_add_coupon_callback',
-        'wrapper' => 'commerce-checkout-coupon-ajax-wrapper',
+        'wrapper' => 'commerce-checkout-form-ajax-wrapper form',
       ),
     );
   }
@@ -50,13 +50,20 @@ function commerce_coupon_pane_checkout_form($form, &$form_state, $checkout_pane,
     }
   }
 
-  if (isset($form_state['triggering_element']) && $form_state['triggering_element']['#name'] == 'coupon_add') {
+  // Add coupon button was used.
+  // We are using ['input']['_triggering_element_name'] here and in the next check
+  // instead of normal ['triggering_element'] because in case of submit buttons
+  // added by Views' field handler (commerce_coupon_handler_field_coupon_remove.inc)
+  // the triggering element is incorrect - it's always set to "coupon_add".
+  if (isset($form_state['input']['_triggering_element_name']) && $form_state['input']['_triggering_element_name'] == 'coupon_add') {
     if (!empty($form_state['values']['commerce_coupon']['coupon_add'])) {
       list($view_id, $display_id) = explode('|', variable_get('commerce_coupon_review_pane_view', 'commerce_coupon_review_pane|default'));
       if (!empty($view_id) && !empty($display_id)) {
         global $_commerce_coupon_validation_error_message;
         $code = $form_state['input']['commerce_coupon']['coupon_code'];
         if (!empty($code) && commerce_coupon_code_is_valid($code, $order)) {
+
+          // Add coupon to the order.
           $coupon = commerce_coupon_load_by_code($code);
           commerce_coupon_redeem_coupon($coupon, $order);
 
@@ -64,13 +71,15 @@ function commerce_coupon_pane_checkout_form($form, &$form_state, $checkout_pane,
           // causing an error when user uses main "Continue to next step" submit.
           $pane_form['coupon_code']['#value'] = '';
 
+          // Make sure the "Shopping cart content" summary is re-rendered.
+          // This will happen in commerce_coupon_ajax_render_alter().
           if (isset($order->order_id) && is_numeric($order->order_id)) {
-            // This is to get the summary of the form rerendered.
-            $alter_coupon_commands = &drupal_static('alter_coupon_commands');
-            $coupon_current_order = &drupal_static('coupon_current_order');
-            $alter_coupon_commands = TRUE;
-            $coupon_current_order = $order->order_id;
+            $commerce_coupon_alter_commands = &drupal_static('commerce_coupon_alter_commands');
+            $commerce_coupon_alter_commands = TRUE;
+            $commerce_coupon_current_order = &drupal_static('commerce_coupon_current_order');
+            $commerce_coupon_current_order = $order->order_id;
           }
+
           // Force shopping cart refresh to recalculate all prices there,
           // which is not done automatically in case of percentage coupons.
           commerce_cart_order_refresh($order);
@@ -89,6 +98,30 @@ function commerce_coupon_pane_checkout_form($form, &$form_state, $checkout_pane,
     }
   }
 
+  // One of Remove coupon from cart buttons was used.
+  if (isset($form_state['input']['_triggering_element_name']) && strpos($form_state['input']['_triggering_element_name'], 'commerce_coupon_remove_') !== FALSE) {
+
+    // Remove coupon from the order.
+    $coupon_id = str_replace('commerce_coupon_remove_', '', $form_state['input']['_triggering_element_name']);
+    $coupon = commerce_coupon_load($coupon_id);
+    commerce_coupon_remove_coupon_from_order($order, $coupon);
+    commerce_order_save($order);
+
+    // Make sure the "Shopping cart content" summary is re-rendered.
+    // This will happen in commerce_coupon_ajax_render_alter().
+    if (isset($order->order_id) && is_numeric($order->order_id)) {
+      $commerce_coupon_alter_commands = &drupal_static('commerce_coupon_alter_commands');
+      $commerce_coupon_alter_commands = TRUE;
+      $commerce_coupon_current_order = &drupal_static('commerce_coupon_current_order');
+      $commerce_coupon_current_order = $order->order_id;
+    }
+
+    // Force shopping cart refresh to recalculate all prices there,
+    // which is not done automatically in case of percentage coupons.
+    commerce_cart_order_refresh($order);
+    $pane_form['redeemed_coupons']['#markup'] = commerce_embed_view($view_id, $display_id, array($order->order_id));
+  }
+
   // Display any new status messages added by this pane within the pane's area.
   if (drupal_get_messages(NULL, FALSE)) {
     $pane_form['status_messages'] = array(
@@ -102,6 +135,15 @@ function commerce_coupon_pane_checkout_form($form, &$form_state, $checkout_pane,
 }
 
 /**
+ * #after_build callback for Views' remove coupons field handler form.
+ */
+function commerce_coupon_pane_checkout_views_form_after_build($form) {
+  // Get rid of the "Save" button in Coupons pane view.
+  unset($form['actions']);
+  return $form;
+}
+
+/**
  * Check whether the coupon code is valid.
  */
 function commerce_coupon_pane_checkout_form_validate($form, &$form_state, $checkout_pane, $order) {
@@ -147,10 +189,10 @@ function commerce_coupon_pane_checkout_form_submit($form, &$form_state, $checkou
 }
 
 /**
- * Callback for the ajax button coupon_add.
+ * Callback for the ajax buttons coupon_add and coupon_remove.
  */
 function commerce_coupon_add_coupon_callback($form, &$form_state) {
-  return $form['commerce_coupon'];
+  return $form;
 }
 
 /**
@@ -159,14 +201,12 @@ function commerce_coupon_add_coupon_callback($form, &$form_state) {
  * This is to get the summary of the cart to rerender on the add coupon button.
  */
 function commerce_coupon_ajax_render_alter(&$commands) {
-  $alter_coupon_commands = &drupal_static('alter_coupon_commands');
-  $coupon_current_order = &drupal_static('coupon_current_order');
-
-  if ($alter_coupon_commands) {
+  if ($commerce_coupon_alter_commands = &drupal_static('commerce_coupon_alter_commands')) {
     list($view_id, $display_id) = explode('|', variable_get('commerce_cart_contents_pane_view', 'commerce_cart_summary|default'));
+    $commerce_coupon_current_order = &drupal_static('commerce_coupon_current_order');
     $contents = array();
     $contents['cart_contents_view'] = array(
-      '#markup' => commerce_embed_view($view_id, $display_id, array($coupon_current_order)),
+      '#markup' => commerce_embed_view($view_id, $display_id, array($commerce_coupon_current_order)),
     );
     $contents = drupal_render($contents);
     $commands[] = ajax_command_replace('.view-commerce-cart-summary', $contents);
diff --git a/includes/views/commerce_coupon.views.inc b/includes/views/commerce_coupon.views.inc
index 01c9878..edb8f39 100644
--- a/includes/views/commerce_coupon.views.inc
+++ b/includes/views/commerce_coupon.views.inc
@@ -24,6 +24,14 @@ function commerce_coupon_views_data_alter(&$data) {
         'handler' => 'commerce_coupon_handler_field_coupon_granted_amount',
       ),
     );
+    // Adds a button to delete a coupon from shopping cart.
+    $data['commerce_coupon']['edit_remove'] = array(
+      'field' => array(
+        'title' => t('Remove button'),
+        'help' => t('Adds a button to remove a coupon from the shopping cart.'),
+        'handler' => 'commerce_coupon_handler_field_coupon_remove',
+      ),
+    );
     // Expose the number of times the coupon has been used.
     $data['commerce_coupon']['times_used'] = array(
       'title' => t('Times used'),
diff --git a/includes/views/commerce_coupon_ui.views_default.inc b/includes/views/commerce_coupon_ui.views_default.inc
index 5f670c2..6b68c2f 100644
--- a/includes/views/commerce_coupon_ui.views_default.inc
+++ b/includes/views/commerce_coupon_ui.views_default.inc
@@ -224,6 +224,10 @@ function commerce_coupon_ui_views_default_views() {
   $handler->display->display_options['fields']['granted_amount']['id'] = 'granted_amount';
   $handler->display->display_options['fields']['granted_amount']['table'] = 'commerce_coupon';
   $handler->display->display_options['fields']['granted_amount']['field'] = 'granted_amount';
+  /* Field: Commerce Coupon: Remove button */
+  $handler->display->display_options['fields']['edit_remove']['id'] = 'edit_remove';
+  $handler->display->display_options['fields']['edit_remove']['table'] = 'commerce_coupon';
+  $handler->display->display_options['fields']['edit_remove']['field'] = 'edit_remove';
   /* Contextual filter: Commerce Order: Order ID */
   $handler->display->display_options['arguments']['order_id']['id'] = 'order_id';
   $handler->display->display_options['arguments']['order_id']['table'] = 'commerce_order';
diff --git a/includes/views/handlers/commerce_coupon_handler_field_coupon_remove.inc b/includes/views/handlers/commerce_coupon_handler_field_coupon_remove.inc
new file mode 100644
index 0000000..bbbaa54
--- /dev/null
+++ b/includes/views/handlers/commerce_coupon_handler_field_coupon_remove.inc
@@ -0,0 +1,65 @@
+<?php
+
+/**
+ * Field for removing a commerce log item and line item.
+ */
+class commerce_coupon_handler_field_coupon_remove extends views_handler_field {
+  function construct() {
+    parent::construct();
+
+    $this->additional_fields['coupon_id'] = 'coupon_id';
+
+    // Set real_field in order to make it generate a field_alias.
+    $this->real_field = 'coupon_id';
+  }
+
+  function query() {
+    $this->ensure_my_table();
+    $this->add_additional_fields();
+  }
+
+  function render($values) {
+    return '<!--form-item-' . $this->options['id'] . '--' . $this->view->row_index . '-->';
+  }
+
+  /**
+   * Returns the form which replaces the placeholder from render().
+   */
+  function views_form(&$form, &$form_state) {
+
+    // Afted adding coupon "Remove" buttons, an extra "Save" submit button
+    // is being added to the form automatically, which we don't really want.
+    $form['#after_build'][] = 'commerce_coupon_pane_checkout_views_form_after_build';
+
+    // The view is empty, abort.
+    if (empty($this->view->result)) {
+      return;
+    }
+
+    $form[$this->options['id']] = array(
+      '#tree' => TRUE,
+    );
+
+    // At this point, the query has already been run, so we can access the results
+    // in order to get the base key value (for example, nid for nodes).
+    foreach ($this->view->result as $row_id => $row) {
+      $coupon_id = $this->get_value($row, 'coupon_id');
+
+      $form[$this->options['id']][$row_id]['submit'] = array(
+        '#type' => 'submit',
+        '#value' => t('Remove'),
+        '#name' => 'commerce_coupon_remove_' . $coupon_id,
+        '#id' => 'commerce_coupon_remove_' . $coupon_id,
+        '#attributes' => array('class' => array('use-ajax-submit', 'remove-coupon')),
+        '#ajax' => array(
+          'callback' => 'commerce_coupon_add_coupon_callback',
+          'wrapper' => 'commerce-checkout-form-ajax-wrapper form',
+        ),
+      );
+    }
+  }
+
+  function views_form_submit($form, &$form_state) {
+    dpm('views_form_submit');
+  }
+}
-- 
1.7.2.5

