Feature: Add editable Campaign dropdown to Donation Details screen

includes/admin/class-give-html-elements.php

@@ -10,6 +10,8 @@
  */
 
 // Exit if accessed directly.
+use Give\Campaigns\Models\Campaign;
+
 if ( ! defined( 'ABSPATH' ) ) {
 	exit;
 }
@@ -226,10 +228,96 @@ public function forms_dropdown( $args = array() ) {
 		return $output;
 	}
 
-	/**
-	 * Donors Dropdown
-	 *
-	 * Renders an HTML Dropdown of all donors.
+    /**
+     * @unreleased
+     */
+    public function campaigns_dropdown($args = [])
+    {
+        $defaults = [
+            'name' => 'campaigns',
+            'id' => 'campaigns',
+            'class' => '',
+            'multiple' => false,
+            'selected' => 0,
+            'chosen' => false,
+            'number' => 30,
+            'placeholder' => esc_attr__('All Campaigns', 'give'),
+            'data' => [
+                'search-type' => 'campaign',
+            ],
+            'query_args' => [],
+        ];
+
+        $args = wp_parse_args($args, $defaults);
+
+        $campaigns_args = wp_parse_args(
+            $args['query_args'],
+            [
+                'orderby' => 'id',
+                'order' => 'DESC',
+                'per_page' => $args['number'],
+            ]
+        );
+
+        /**
+         * Filter the campaigns dropdown.
+         *
+         * @unreleased
+         *
+         * @param array $campaigns_args Arguments for campaigns_dropdown query.
+         *
+         * @return array Arguments for campaigns_dropdown query.
+         */
+        $campaigns_args = apply_filters('give_campaigns_dropdown_args', $campaigns_args);
+
+        $campaigns = Campaign::query()
+            ->orderBy($campaigns_args['orderby'], $campaigns_args['order'])
+            ->limit($campaigns_args['per_page'])
+            ->getAll();
+
+        $options = [];
+
+        // Ensure the selected.
+        if (false !== $args['selected'] && $args['selected'] !== 0) {
+            $options[$args['selected']] = get_the_title($args['selected']);
+        }
+
+        $options[0] = esc_html__('No campaigns found.', 'give');
+        if ( ! empty($campaigns)) {
+            $options[0] = $args['placeholder'];
+            foreach ($campaigns as $campaign) {
+                $campaign_title = empty($campaign->title)
+                    ? sprintf(__('Untitled (#%s)', 'give'), $campaign->id)
+                    : $campaign->title;
+
+                $options[absint($campaign->id)] = esc_html($campaign_title);
+            }
+        }
+
+        $output = $this->select(
+            [
+                'name' => $args['name'],
+                'selected' => $args['selected'],
+                'id' => $args['id'],
+                'class' => $args['class'],
+                'options' => $options,
+                'chosen' => $args['chosen'],
+                'multiple' => $args['multiple'],
+                'placeholder' => $args['placeholder'],
+                'show_option_all' => false,
+                'show_option_none' => false,
+                'data' => $args['data'],
+            ]
+        );
+
+        return $output;
+    }
+
+
+    /**
+     * Donors Dropdown
+     *
+     * Renders an HTML Dropdown of all donors.
 	 *
 	 * @since  1.0
 	 * @access public

includes/admin/payments/actions.php

@@ -10,6 +10,7 @@
  */
 
 // Exit if accessed directly.
+use Give\Donations\Models\Donation;
 use Give\Donations\ValueObjects\DonationMetaKeys;
 
 if (!defined('ABSPATH')) {
@@ -312,6 +313,19 @@ function give_update_payment_details( $data ) {
 		$payment->update_payment_setup( $payment->ID );
 	}
 
+    // Update payment campaign.
+    $donation = Donation::find($payment->ID);
+
+    if ($donation) {
+        $new_campaign_id = absint($data['give-payment-campaign-select']);
+        $current_campaign_id = absint($donation->campaignId);
+
+        if ($new_campaign_id && $new_campaign_id !== $current_campaign_id) {
+            $donation->campaignId = $new_campaign_id;
+            $donation->save();
+        }
+    }
+
 	$comment_id                  = isset( $data['give_comment_id'] ) ? absint( $data['give_comment_id'] ) : 0;
 	$has_anonymous_setting_field = give_is_anonymous_donation_field_enabled( $payment->form_id );
 

includes/admin/payments/view-payment-details.php

@@ -441,7 +441,23 @@
 												);
 												?>
 											</p>
-										</div>
+                                            <p>
+                                                <strong><?php
+                                                    esc_html_e('Campaign:', 'give'); ?></strong><br>
+                                                <?php
+                                                $donation = Donation::find($payment->ID);
+                                                echo Give()->html->campaigns_dropdown(
+                                                    [
+                                                        'selected' => $donation->campaignId,
+                                                        'name' => 'give-payment-campaign-select',
+                                                        'id' => 'give-payment-campaign-select',
+                                                        'chosen' => true,
+                                                        'placeholder' => '',
+                                                    ]
+                                                );
+                                                ?>
+                                            </p>
+                                        </div>
 										<div class="column">
 											<p>
 												<strong><?php _e( 'Donation Date:', 'give' ); ?></strong><br>

src/Revenue/Listeners/UpdateRevenueWhenDonationAmountUpdated.php → src/Revenue/Listeners/UpdateRevenueWhenDonationUpdated.php

@@ -6,11 +6,13 @@
 use Give\Revenue\Repositories\Revenue;
 
 /**
+ * @unreleased Updated class to support update other properties
  * @since 2.22.1
  */
-class UpdateRevenueWhenDonationAmountUpdated
+class UpdateRevenueWhenDonationUpdated
 {
     /**
+     * @unreleased Added support to update revenue campaignId
      * @since 3.3.0 updated to accept Donation model
      * @since 2.22.1
      */
@@ -19,5 +21,9 @@ public function __invoke(Donation $donation)
         if ($donation->isDirty('amount')) {
             give(Revenue::class)->updateRevenueAmount($donation);
         }
+
+        if ($donation->isDirty('campaignId')) {
+            give(Revenue::class)->updateRevenueCampaignId($donation);
+        }
     }
 }

src/Revenue/Repositories/Revenue.php

@@ -85,6 +85,24 @@ public function updateRevenueAmount(Donation $donation)
         );
     }
 
+    /**
+     * @unreleased
+     *
+     * @return false|int
+     */
+    public function updateRevenueCampaignId(Donation $donation)
+    {
+        global $wpdb;
+
+        return DB::update(
+            $wpdb->give_revenue,
+            ['campaign_id' => $donation->campaignId],
+            ['donation_id' => $donation->id],
+            ['%d'],
+            ['%d']
+        );
+    }
+
     /**
      * Validate new revenue data.
      *

src/Revenue/RevenueServiceProvider.php

@@ -2,15 +2,13 @@
 
 namespace Give\Revenue;
 
-use Give\Donations\Models\Donation;
 use Give\Framework\Migrations\MigrationsRegister;
 use Give\Helpers\Hooks;
 use Give\Revenue\Listeners\DeleteRevenueWhenDonationDeleted;
-use Give\Revenue\Listeners\UpdateRevenueWhenDonationAmountUpdated;
+use Give\Revenue\Listeners\UpdateRevenueWhenDonationUpdated;
 use Give\Revenue\Migrations\AddPastDonationsToRevenueTable;
 use Give\Revenue\Migrations\CreateRevenueTable;
 use Give\Revenue\Migrations\RemoveRevenueForeignKeys;
-use Give\Revenue\Repositories\Revenue;
 use Give\ServiceProviders\ServiceProvider;
 
 class RevenueServiceProvider implements ServiceProvider
@@ -40,7 +38,7 @@ public function boot()
         Hooks::addAction('delete_post', DeleteRevenueWhenDonationDeleted::class, '__invoke', 10, 1);
         Hooks::addAction('give_insert_payment', DonationHandler::class, 'handle', 999, 1);
         Hooks::addAction('give_register_updates', AddPastDonationsToRevenueTable::class, 'register', 10, 1);
-        Hooks::addAction('givewp_donation_updated', UpdateRevenueWhenDonationAmountUpdated::class);
+        Hooks::addAction('givewp_donation_updated', UpdateRevenueWhenDonationUpdated::class);
         Hooks::addAction('give_updated_edited_donation',LegacyListeners\UpdateRevenueWhenDonationAmountUpdated::class);
     }
 

tests/Unit/Revenue/Listeners/UpdateRevenueWhenDonationAmountUpdatedTest.php

@@ -6,7 +6,7 @@
 use Give\Donations\ValueObjects\DonationStatus;
 use Give\Framework\Database\DB;
 use Give\Framework\Support\ValueObjects\Money;
-use Give\Revenue\Listeners\UpdateRevenueWhenDonationAmountUpdated;
+use Give\Revenue\Listeners\UpdateRevenueWhenDonationUpdated;
 use Give\Tests\TestCase;
 use Give\Tests\TestTraits\RefreshDatabase;
 
@@ -26,18 +26,24 @@ public function testRevenueIsUpdatedWhenDonationIsUpdated(): void
         $donation = Donation::factory()->create([
             'status' => DonationStatus::COMPLETE(),
             'amount' => Money::fromDecimal(250.00, 'USD'),
+            'campaignId' => 1,
         ]);
 
         $donation->amount = Money::fromDecimal(25.00, 'USD');
+        $donation->campaignId = 2;
         $donation->save();
 
-        $listener = new UpdateRevenueWhenDonationAmountUpdated();
+        $listener = new UpdateRevenueWhenDonationUpdated();
         $listener($donation);
 
         $this->assertEquals(
             Money::fromDecimal(25.00, 'USD')->formatToMinorAmount(),
             $this->getRevenueAmountForDonation($donation)
         );
+        $this->assertEquals(
+            2,
+            $this->getRevenueCampaignIdForDonation($donation)
+        );
     }
 
     /**
@@ -50,5 +56,13 @@ private function getRevenueAmountForDonation(Donation $donation)
 
         return $revenue->amount;
     }
+
+    private function getRevenueCampaignIdForDonation(Donation $donation)
+    {
+        global $wpdb;
+        $revenue = DB::get_row("SELECT * FROM {$wpdb->give_revenue} WHERE donation_id = {$donation->id}");
+
+        return $revenue->campaign_id;
+    }
 }