Feature: Update Campaign Donation Query (#7630)

composer.json

@@ -17,7 +17,8 @@
         "symfony/polyfill-ctype": "^1.19",
         "symfony/polyfill-mbstring": "^1.19",
         "woocommerce/action-scheduler": "^3.6",
-        "ext-json": "*"
+        "ext-json": "*",
+        "stellarwp/arrays": "^1.2"
     },
     "require-dev": {
         "fakerphp/faker": "^1.9",
@@ -93,6 +94,7 @@
             "classmap_prefix": "Give_Vendors_",
             "constant_prefix": "GIVE_VENDORS_",
             "packages": [
+                "stellarwp/arrays",
                 "stellarwp/validation",
                 "stellarwp/field-conditions",
                 "symfony/polyfill-ctype",

give.php

@@ -42,6 +42,7 @@
  * - The GiveWP Team
  */
 
+use Give\Campaigns\Repositories\CampaignRepository;
 use Give\Container\Container;
 use Give\DonationForms\ServiceProvider as DonationFormsServiceProvider;
 use Give\DonationForms\V2\Repositories\DonationFormsRepository;
@@ -132,6 +133,7 @@
  * @property-read DonorRepositoryProxy $donors
  * @property-read SubscriptionRepository $subscriptions
  * @property-read DonationFormsRepository $donationForms
+ * @property-read CampaignRepository $campaigns
  * @property-read Profile $donorDashboard
  * @property-read TabsRegister $donorDashboardTabs
  * @property-read Give_Recurring_DB_Subscription_Meta $subscription_meta

src/Campaigns/CampaignDonationQuery.php

@@ -29,12 +29,8 @@ public function __construct(Campaign $campaign)
         $this->where('paymentMode.meta_value', give_is_test_mode() ? 'test' : 'live');
 
         // Include only forms associated with the Campaign.
-        $this->joinDonationMeta(DonationMetaKeys::FORM_ID, 'formId');
-        $this->join(function (JoinQueryBuilder $builder) {
-            $builder->leftJoin('give_campaign_forms', 'campaign_forms')
-                    ->on('campaign_forms.form_id', 'formId.meta_value');
-        });
-        $this->where('campaign_forms.campaign_id', $campaign->id);
+        $this->joinDonationMeta(DonationMetaKeys::CAMPAIGN_ID, 'campaignId');
+        $this->where('campaignId.meta_value', $campaign->id);
     }
 
     /**

src/Campaigns/Migrations/Donations/AddCampaignId.php

@@ -0,0 +1,92 @@
+<?php
+
+namespace Give\Campaigns\Migrations\Donations;
+
+use Give\Donations\ValueObjects\DonationMetaKeys;
+use Give\Framework\Database\DB;
+use Give\Framework\Database\Exceptions\DatabaseQueryException;
+use Give\Framework\Migrations\Contracts\Migration;
+use Give\Framework\Migrations\Exceptions\DatabaseMigrationException;
+
+/**
+ * @unreleased
+ */
+class AddCampaignId extends Migration
+{
+    /**
+     * @inheritDoc
+     */
+    public static function id(): string
+    {
+        return 'add_campaign_id_to_donations';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public static function title(): string
+    {
+        return 'Add campaign id to donations';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public static function timestamp(): string
+    {
+        return strtotime('2024-11-22 00:00:00');
+    }
+
+    /**
+     * @inheritDoc
+     * @throws DatabaseMigrationException
+     */
+    public function run()
+    {
+        $relationships = [];
+
+        try {
+            $data = DB::table('give_campaign_forms')
+                ->select('campaign_id', 'form_id')
+                ->getAll();
+
+            foreach ($data as $relationship) {
+                $relationships[$relationship->campaign_id][] = $relationship->form_id;
+            }
+
+            $donations = DB::table('posts')
+                ->select('ID')
+                ->attachMeta(
+                    'give_donationmeta',
+                    'ID',
+                    'donation_id',
+                    [DonationMetaKeys::FORM_ID(), 'formId']
+                )
+                ->where('post_type', 'give_payment')
+                ->getAll();
+
+            $donationMeta = [];
+
+            foreach ($donations as $donation) {
+                foreach ($relationships as $campaignId => $formIds) {
+                    if (in_array($donation->formId, $formIds)) {
+                        $donationMeta[] = [
+                            'donation_id' => $donation->ID,
+                            'meta_key' => DonationMetaKeys::CAMPAIGN_ID,
+                            'meta_value' => $campaignId,
+                        ];
+
+                        break;
+                    }
+                }
+            }
+
+            if ( ! empty($donationMeta)) {
+                DB::table('give_donationmeta')
+                    ->insert($donationMeta, ['%d', '%s', '%d']);
+            }
+        } catch (DatabaseQueryException $exception) {
+            throw new DatabaseMigrationException("An error occurred while adding campaign ID to the donation meta table", 0, $exception);
+        }
+    }
+}

src/Campaigns/Repositories/CampaignRepository.php

@@ -47,11 +47,22 @@ public function getById(int $id)
      * Get Campaign by Form ID using a lookup table
      */
     public function getByFormId(int $formId)
+    {
+        return $this->queryByFormId($formId)->get();
+    }
+
+    /**
+     * @unreleased
+     *
+     * @param int $formId
+     *
+     * @return ModelQueryBuilder<Campaign>
+     */
+    public function queryByFormId(int $formId): ModelQueryBuilder
     {
         return $this->prepareQuery()
-            ->leftJoin('give_campaign_forms', 'campaigns.id', 'campaignForms.campaign_id', 'campaignForms')
-            ->where('campaignForms.form_id', $formId)
-            ->get();
+            ->leftJoin('give_campaign_forms', 'campaigns.id', 'forms.campaign_id', 'forms')
+            ->where('forms.form_id', $formId);
     }
 
     /**

src/Campaigns/ServiceProvider.php

@@ -6,13 +6,15 @@
 use Give\Campaigns\Actions\CreateDefaultCampaignForm;
 use Give\Campaigns\Actions\DeleteCampaignPage;
 use Give\Campaigns\Actions\FormInheritsCampaignGoal;
+use Give\Campaigns\Migrations\Donations\AddCampaignId as DonationsAddCampaignId;
 use Give\Campaigns\Migrations\MigrateFormsToCampaignForms;
 use Give\Campaigns\Migrations\P2P\SetCampaignType;
-use Give\Campaigns\Migrations\RevenueTable\AddCampaignID;
+use Give\Campaigns\Migrations\RevenueTable\AddCampaignID as RevenueTableAddCampaignID;
 use Give\Campaigns\Migrations\RevenueTable\AddIndexes;
 use Give\Campaigns\Migrations\RevenueTable\AssociateDonationsToCampaign;
 use Give\Campaigns\Migrations\Tables\CreateCampaignFormsTable;
 use Give\Campaigns\Migrations\Tables\CreateCampaignsTable;
+use Give\Campaigns\Repositories\CampaignRepository;
 use Give\DonationForms\V2\DonationFormsAdminPage;
 use Give\Framework\Migrations\MigrationsRegister;
 use Give\Helpers\Hooks;
@@ -29,6 +31,7 @@ class ServiceProvider implements ServiceProviderInterface
      */
     public function register(): void
     {
+        give()->singleton('campaigns', CampaignRepository::class);
         $this->registerTableNames();
     }
 
@@ -70,9 +73,10 @@ private function registerMigrations(): void
                 SetCampaignType::class,
                 CreateCampaignFormsTable::class,
                 MigrateFormsToCampaignForms::class,
-                AddCampaignID::class,
+                RevenueTableAddCampaignID::class,
                 AssociateDonationsToCampaign::class,
-                AddIndexes::class
+                AddIndexes::class,
+                DonationsAddCampaignId::class
             ]
         );
     }

src/Donations/Models/Donation.php

@@ -3,6 +3,7 @@
 namespace Give\Donations\Models;
 
 use DateTime;
+use Give\Campaigns\Models\Campaign;
 use Give\Donations\DataTransferObjects\DonationQueryData;
 use Give\Donations\Factories\DonationFactory;
 use Give\Donations\Properties\BillingAddress;
@@ -55,6 +56,7 @@
  * @property string $levelId
  * @property string $gatewayTransactionId
  * @property Donor $donor
+ * @property Campaign $campaign
  * @property Subscription $subscription
  * @property DonationNote[] $notes
  * @property string $company
@@ -99,6 +101,7 @@ class Donation extends Model implements ModelCrud, ModelHasFactory
      * @inheritdoc
      */
     protected $relationships = [
+        'campaign' => Relationship::BELONGS_TO,
         'donor' => Relationship::BELONGS_TO,
         'subscription' => Relationship::BELONGS_TO,
         'notes' => Relationship::HAS_MANY,
@@ -184,6 +187,16 @@ public function subscription(): ModelQueryBuilder
         return give()->subscriptions->queryByDonationId($this->id);
     }
 
+    /**
+     * @unreleased
+     *
+     * @return ModelQueryBuilder<Campaign>
+     */
+    public function campaign(): ModelQueryBuilder
+    {
+        return give()->campaigns->queryByFormId($this->formId);
+    }
+
     /**
      * @since 2.19.6
      *

src/Donations/Repositories/DonationRepository.php

@@ -359,6 +359,10 @@ private function getCoreDonationMetaForDatabase(Donation $donation): array
             DonationMetaKeys::ANONYMOUS => (int)$donation->anonymous
         ];
 
+        if ($campaign = $donation->campaign) {
+            $meta[DonationMetaKeys::CAMPAIGN_ID] = $campaign->id;
+        }
+
         if ($donation->feeAmountRecovered !== null) {
             $meta[DonationMetaKeys::FEE_AMOUNT_RECOVERED] = $donation->feeAmountRecovered->formatToDecimal();
         }

src/Donations/ValueObjects/DonationMetaKeys.php

@@ -12,6 +12,7 @@
  * @since 2.19.6
  *
  * @method static DonationMetaKeys AMOUNT()
+ * @method static DonationMetaKeys CAMPAIGN_ID()
  * @method static DonationMetaKeys CURRENCY()
  * @method static DonationMetaKeys GATEWAY()
  * @method static DonationMetaKeys DONOR_ID()
@@ -47,6 +48,7 @@ class DonationMetaKeys extends Enum
     use EnumInteractsWithQueryBuilder;
 
     const AMOUNT = '_give_payment_total';
+    const CAMPAIGN_ID = '_give_campaign_id';
     const BASE_AMOUNT = '_give_cs_base_amount';
     const CURRENCY = '_give_payment_currency';
     const EXCHANGE_RATE = '_give_cs_exchange_rate';

src/Framework/QueryBuilder/Concerns/CRUD.php

@@ -3,6 +3,7 @@
 namespace Give\Framework\QueryBuilder\Concerns;
 
 use Give\Framework\Database\DB;
+use Give\Vendors\StellarWP\Arrays\Arr;
 
 /**
  * @since 2.19.0
@@ -12,6 +13,7 @@ trait CRUD
     /**
      * @see https://developer.wordpress.org/reference/classes/wpdb/insert/
      *
+     * @unreleased Add support for inserting multiple rows at once
      * @since 2.19.0
      *
      * @param  array|string  $format
@@ -22,6 +24,12 @@ trait CRUD
      */
     public function insert($data, $format = null)
     {
+        if (Arr::is_list($data)) {
+            return DB::query(
+                $this->getInsertIntoSQL($data, $format)
+            );
+        }
+
         return DB::insert(
             $this->getTable(),
             $data,