👌 IMPROVE: Updated logging functionality

robertdevore · robertdevore · commit 102f8b64aa79 · 2024-11-13T04:05:53.000-05:00
diff --git a/admin/class-clwc-admin.php b/admin/class-clwc-admin.php
@@ -65,8 +65,13 @@ public function __construct( $plugin_name, $version ) {
      * @since  1.0.0
      * @return void
      */
-    public function enqueue_styles() {
-        //wp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/clwc-admin.css', array(), $this->version, 'all' );
+    public function enqueue_styles( $hook_suffix ) {
+        // Only enqueue on your specific admin page.
+        if ( 'woocommerce_page_clwc-customer-loyalty' !== $hook_suffix ) {
+            return;
+        }
+
+        wp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/clwc-admin.css', [], $this->version, 'all' );
     }
 
     /**
@@ -97,7 +102,6 @@ public function enqueue_scripts( $hook_suffix ) {
         ] );
     }
 
-
 }
 
 /**
diff --git a/admin/clwc-earning-loyalty-points.php b/admin/clwc-earning-loyalty-points.php
@@ -19,54 +19,58 @@
 /**
  * Add loyalty points on successful customer registration.
  *
- * @param int $user_id The ID of the registered user.
+ * Awards loyalty points to the user upon registration if the loyalty points
+ * system is activated in the plugin settings.
  *
  * @since 1.0.0
+ * @param int $user_id The ID of the registered user.
  * @return void
  */
 function clwc_customer_registration( $user_id ) {
-    error_log( 'Running clwc_customer_registration for user ID: ' . $user_id );
-    
-    if ( clwc_loyalty_points_activate() && 0 != clwc_earning_points_customer_registration() ) {
+    $settings = get_option( 'clwc_loyalty_points_settings', [] );
+    $registration_points = (int) ($settings['customer_registration'] ?? 0);
+
+    if ( clwc_loyalty_points_activate() && $registration_points ) {
         $user_info  = get_userdata( $user_id );
         $user_email = $user_info ? $user_info->user_email : '';
         $user_name  = $user_info ? $user_info->display_name : '';
-        
+
         $old_points = (int) get_user_meta( $user_id, 'clwc_loyalty_points', true ) ?: 0;
-        $new_points = $old_points + clwc_earning_points_customer_registration();
-        
+        $new_points = $old_points + $registration_points;
+
         update_user_meta( $user_id, 'clwc_loyalty_points', $new_points, $old_points );
 
         $details = sprintf(
             esc_html__( 'Customer awarded %d loyalty points for registering an account.', 'customer-loyalty-for-woocommerce' ),
-            clwc_earning_points_customer_registration()
+            $registration_points
         );
 
-        $log_result = clwc_insert_loyalty_log_entry( $user_id, $user_name, $user_email, $new_points, $details );
-        error_log( 'Loyalty log entry result: ' . print_r( $log_result, true ) );
-    } else {
-        error_log( 'Loyalty points not activated or registration points not set.' );
+        clwc_insert_loyalty_log_entry( $user_id, $user_name, $user_email, $new_points, $details );
     }
 }
 add_action( 'user_register', 'clwc_customer_registration', 10, 1 );
 
 /**
  * Add loyalty points on order completion.
  *
- * @param int $order_id WooCommerce order ID.
+ * Awards loyalty points to the user when an order is completed if the loyalty points
+ * system is activated in the plugin settings.
  *
  * @since 1.0.0
+ * @param int $order_id WooCommerce order ID.
  * @return void
  */
 function clwc_customer_first_order( $order_id ) {
-    if ( clwc_loyalty_points_activate() && 0 != clwc_earning_points_order_complete() ) {
-        $order = wc_get_order( $order_id );
+    $settings              = get_option( 'clwc_loyalty_points_settings', [] );
+    $order_complete_points = (int) ($settings['order_complete'] ?? 0);
+
+    if ( clwc_loyalty_points_activate() && $order_complete_points ) {
+        $order   = wc_get_order( $order_id );
         $user_id = $order->get_user_id();
 
         if ( $user_id ) {
-            $old_points    = (int) get_user_meta( $user_id, 'clwc_loyalty_points', true ) ?: 0;
-            $earned_points = clwc_earning_points_order_complete();
-            $new_points    = $old_points + $earned_points;
+            $old_points = (int) get_user_meta( $user_id, 'clwc_loyalty_points', true ) ?: 0;
+            $new_points = $old_points + $order_complete_points;
 
             update_user_meta( $user_id, 'clwc_loyalty_points', $new_points, $old_points );
 
@@ -76,9 +80,9 @@ function clwc_customer_first_order( $order_id ) {
 
             $details = sprintf(
                 esc_html__( 'Customer awarded %d loyalty points for completing an order.', 'customer-loyalty-for-woocommerce' ),
-                $earned_points
+                $order_complete_points
             );
-            clwc_insert_loyalty_log_entry( $user_id, $user_name, $user_email, $earned_points, $details );
+            clwc_insert_loyalty_log_entry( $user_id, $user_name, $user_email, $order_complete_points, $details );
         }
     }
 }
@@ -87,13 +91,19 @@ function clwc_customer_first_order( $order_id ) {
 /**
  * Add loyalty points for every dollar spent.
  *
- * @param int $order_id WooCommerce order ID.
+ * Awards loyalty points to the user based on the total amount spent, if the loyalty points
+ * system is activated and set up in the plugin settings.
  *
+ * @param int $order_id WooCommerce order ID.
+ * 
  * @since 1.0.0
  * @return void
  */
 function clwc_customer_money_spent( $order_id ) {
-    if ( clwc_loyalty_points_activate() && 0 != clwc_earning_points_money_spent() ) {
+    $settings          = get_option( 'clwc_loyalty_points_settings', [] );
+    $points_per_dollar = (int) ($settings['money_spent'] ?? 0);
+
+    if ( clwc_loyalty_points_activate() && $points_per_dollar ) {
         $order   = wc_get_order( $order_id );
         $user_id = $order->get_user_id();
 
@@ -102,10 +112,9 @@ function clwc_customer_money_spent( $order_id ) {
                 ? $order->get_subtotal()
                 : $order->get_total();
 
-            $old_points        = (int) get_user_meta( $user_id, 'clwc_loyalty_points', true ) ?: 0;
-            $points_per_dollar = clwc_earning_points_money_spent();
-            $earned_points     = round( $order_total * $points_per_dollar );
-            $new_points        = $old_points + $earned_points;
+            $old_points    = (int) get_user_meta( $user_id, 'clwc_loyalty_points', true ) ?: 0;
+            $earned_points = round( $order_total * $points_per_dollar );
+            $new_points    = $old_points + $earned_points;
 
             update_user_meta( $user_id, 'clwc_loyalty_points', $new_points, $old_points );
 
diff --git a/admin/clwc-woocommerce-settings.php b/admin/clwc-woocommerce-settings.php
@@ -17,110 +17,71 @@
 }
 
 /**
- * Run specific tasks on payment complete in WooCommerce
+ * Run specific tasks on payment completion in WooCommerce.
+ *
+ * This function checks if the rewards card is active and, if so, increments 
+ * the user's punches or issues a coupon if required punches are met.
+ *
+ * @param int $order_id WooCommerce order ID.
  * 
  * @since  1.0.0
- * @return string
+ * @return void
  */
 function clwc_payment_complete( $order_id ) {
-    // Get order details.
     $order = wc_get_order( $order_id );
-
-    // Get user from order.
     $user  = $order->get_user();
 
-    // Bail if the rewards card is not activated.
-    if ( 'on' !== clwc_rewards_card_activate() ) {
-        return false;
+    // Retrieve rewards card settings.
+    $settings = get_option( 'clwc_rewards_card_settings', [] );
+
+    if ( '1' !== $settings['activate_rewards_card'] ) {
+        return;
     }
 
-    // Run code if user is attached to the order.
     if ( $user ) {
+        $required_punches = (int) ($settings['required_punches'] ?? 10);
+        $coupon_amount    = (float) ($settings['coupon_amount'] ?? 5.00);
+        $discount_type    = $settings['coupon_type'] ?? 'fixed_cart';
 
-        // Card punches.
-        $card_punches = get_user_meta( $user->ID, 'clwc_rewards_card_punches', true );
-        $old_punches  = get_user_meta( $user->ID, 'clwc_rewards_card_punches', true );
-
-        // Set a default of zero.
-        if ( '' == $card_punches ) {
-            $card_punches = 0;
-        }
-
-        // Rewards earned.
-        $rewards_earned = get_user_meta( $user->ID, 'clwc_rewards_earned', true );
-        $old_rewards    = get_user_meta( $user->ID, 'clwc_rewards_earned', true );
-
-        // Set a default of zero.
-        if ( '' == $rewards_earned ) {
-            $rewards_earned = 0;
-        }
-
-        $card_check = clwc_rewards_card_required_punches() - 1;
+        $card_punches = (int) get_user_meta( $user->ID, 'clwc_rewards_card_punches', true ) ?: 0;
+        $rewards_earned = (int) get_user_meta( $user->ID, 'clwc_rewards_earned', true ) ?: 0;
 
-        // Check if user needs new coupon.
-        if ( $card_check == $card_punches ) {
+        if ( $card_punches >= ($required_punches - 1) ) {
+            $coupon_code = clwc_get_random_string();
 
-            /**
-             * Create a coupon programatically
-             */
-            $coupon_code   = clwc_get_random_string(); // Code.
-            $amount        = clwc_rewards_card_coupon_amount(); // Amount.
-            $discount_type = clwc_rewards_card_coupon_type(); // Type: fixed_cart, percent, fixed_product, percent_product.
-
-            // Coupon args.
-            $coupon = array(
+            // Create coupon.
+            $coupon = [
                 'post_title'   => $coupon_code,
                 'post_content' => '',
                 'post_status'  => 'publish',
                 'post_author'  => 1,
                 'post_type'    => 'shop_coupon'
-            );
-
-            // Filter the args.
-            $coupon = apply_filters( 'clwc_create_coupon_args', $coupon );
+            ];
 
-            // Get newly create coupon's ID #
             $new_coupon_id = wp_insert_post( $coupon );
-
-            // Add custom meta data to the newly created coupon.
             update_post_meta( $new_coupon_id, 'discount_type', $discount_type );
-            update_post_meta( $new_coupon_id, 'coupon_amount', $amount );
-            update_post_meta( $new_coupon_id, 'individual_use', 'yes' );
-            update_post_meta( $new_coupon_id, 'product_ids', '' );
-            update_post_meta( $new_coupon_id, 'exclude_product_ids', '' );
+            update_post_meta( $new_coupon_id, 'coupon_amount', $coupon_amount );
             update_post_meta( $new_coupon_id, 'usage_limit', '1' );
-            update_post_meta( $new_coupon_id, 'expiry_date', '' );
-            update_post_meta( $new_coupon_id, 'apply_before_tax', 'yes' );
-            update_post_meta( $new_coupon_id, 'free_shipping', 'no' );
-
-            // Add coupon code to order meta data.
             update_post_meta( $order_id, 'clwc_customer_coupon_code', $coupon_code );
 
-            // Reset punches.
-            $card_punches = 0;
-
-            // Add 1 to rewards earned.
-            $rewards_earned = $rewards_earned + 1;
-
-            // Update user meta - rewards earned number.
-            update_user_meta( $user->ID, 'clwc_rewards_earned', $rewards_earned, $old_rewards );
+            $card_punches = 0; // Reset punches after coupon issue.
+            $rewards_earned++;
+            update_user_meta( $user->ID, 'clwc_rewards_earned', $rewards_earned );
         } else {
-            // Add 1 to punches count.
-            $card_punches = $card_punches + 1;
+            $card_punches++;
         }
 
-        // Update user meta - punch card number.
-        update_user_meta( $user->ID, 'clwc_rewards_card_punches', $card_punches, $old_punches );
+        update_user_meta( $user->ID, 'clwc_rewards_card_punches', $card_punches );
     }
 }
 add_action( 'woocommerce_thankyou', 'clwc_payment_complete', 10 );
 
 /**
- * Display Coupon Code for 10 punches to the Punch Card.
+ * Display Coupon Code for X punches to the Punch Card.
  * 
  * @param object $order 
  *
- * @return string
+ * @return void
  */
 function clwc_order_customer_coupon_code( $order ) {
     global $woocommerce, $post;
diff --git a/admin/js/clwc-admin.js b/admin/js/clwc-admin.js
@@ -1,13 +1,10 @@
 jQuery(document).ready(function($) {
-    console.log("Loyalty Points script loaded."); // Debugging line
     $('.clwc-loyalty-points').on('change', function() {
         var $input = $(this);
         var userID = $input.data('user-id');
         var points = $input.val();
 
-        console.log("User ID:", userID, "Points:", points); // Debugging line
-
-        // Disable the input while processing
+        // Disable the input while processing.
         $input.prop('disabled', true);
 
         $.ajax({
@@ -20,9 +17,8 @@ jQuery(document).ready(function($) {
                 security: clwc_ajax.nonce,
             },
             success: function(response) {
-                console.log(response); // Debugging line
                 if (response.success) {
-                    // Optionally, provide visual feedback
+                    // Optionally, provide visual feedback.
                     $input.css('border-color', 'green');
                 } else {
                     $input.css('border-color', 'red');
@@ -34,41 +30,55 @@ jQuery(document).ready(function($) {
                 alert('An AJAX error occurred: ' + textStatus);
             },
             complete: function() {
-                // Re-enable the input
+                // Re-enable the input.
                 $input.prop('disabled', false);
             }
         });
     });
 
     var file_frame;
 
+    // Handle the Upload Image button click.
     $(document).on('click', '.clwc-upload-image-button', function(e) {
         e.preventDefault();
 
-        // If the media frame already exists, reopen it
+        var $button = $(this);
+
+        // If the media frame already exists, reopen it.
         if (file_frame) {
             file_frame.open();
             return;
         }
 
-        // Create a new media frame
+        // Create a new media frame.
         file_frame = wp.media.frames.file_frame = wp.media({
             title: 'Select or Upload an Image',
             button: {
                 text: 'Use this image',
             },
-            multiple: false // Set to true if you want multiple files
+            multiple: false
         });
 
         // When an image is selected, run a callback
         file_frame.on('select', function() {
             var attachment = file_frame.state().get('selection').first().toJSON();
-            $('.clwc-upload-image-button').prev('input[type="hidden"]').val(attachment.id);
-            $('.clwc-upload-image-button').prev().prev('img').attr('src', attachment.url).show();
+            $button.siblings('.clwc-image-id').val(attachment.id);
+            $button.siblings('.clwc-image-preview').attr('src', attachment.url).show();
+            $button.siblings('.clwc-remove-image-button').show();
         });
 
-        // Finally, open the modal
+        // Open the modal.
         file_frame.open();
     });
 
+    // Handle the Remove Image button click.
+    $(document).on('click', '.clwc-remove-image-button', function(e) {
+        e.preventDefault();
+        var $button = $(this);
+
+        // Clear the hidden field and hide the preview image.
+        $button.siblings('.clwc-image-id').val('');
+        $button.siblings('.clwc-image-preview').attr('src', '').hide();
+        $button.hide();
+    });
 });
diff --git a/customer-loyalty-for-woocommerce.php b/customer-loyalty-for-woocommerce.php
