Rename MilestoneUsersProgress to CampaignMilestoneUsersProgress

PTFS-Europe · Nov 7, 2024 · 376052c · 376052c
1 parent 08851c3
commit 376052c
Show file tree

Hide file tree

Showing 10 changed files with 48 additions and 48 deletions.
diff --git a/code/web/services/Community/AJAX.php b/code/web/services/Community/AJAX.php
@@ -1,7 +1,7 @@
 <?php
 require_once ROOT_DIR . '/JSON_Action.php';
 require_once ROOT_DIR . '/sys/Community/UserCampaign.php';
-require_once ROOT_DIR . '/sys/Community/MilestoneUsersProgress.php';
+require_once ROOT_DIR . '/sys/Community/CampaignMilestoneUsersProgress.php';
 
 class Community_AJAX extends JSON_Action {
     function campaignRewardGivenUpdate() {
@@ -33,14 +33,14 @@ function milestoneRewardGivenUpdate() {
             $userId = $_GET['userId'];
             $milestoneId = $_GET['milestoneId'];
 
-            $milestoneProgress = new MilestoneUsersProgress();
-            $milestoneProgress->userId = $userId;
-            $milestoneProgress->milestoneId = $milestoneId;
+            $campaignMilestoneProgress = new CampaignMilestoneUsersProgress();
+            $campaignMilestoneProgress->userId = $userId;
+            $campaignMilestoneProgress->milestoneId = $milestoneId;
 
-            if ($milestoneProgress->find(true)) {
-                $milestoneProgress->rewardGiven = 1;
+            if ($campaignMilestoneProgress->find(true)) {
+                $campaignMilestoneProgress->rewardGiven = 1;
 
-                if ($milestoneProgress->update()) {
+                if ($campaignMilestoneProgress->update()) {
                     ob_end_clean();
                     echo json_encode(['success' => true]);
                 } else {

diff --git a/code/web/services/Community/Dashboard.php b/code/web/services/Community/Dashboard.php
@@ -57,9 +57,9 @@ function launch() {
                 $milestoneCompletionStatus = $userCampaign->checkMilestoneCompletionStatus();
                 foreach ($milestones as $milestone) {
                     $milestoneComplete = $milestoneCompletionStatus[$milestone->id] ?? false;
-                    $userProgress = MilestoneUsersProgress::getProgressByMilestoneId($milestone->id, $user->id);
+                    $userProgress = CampaignMilestoneUsersProgress::getProgressByMilestoneId($milestone->id, $user->id);
                     $totalGoals = CampaignMilestone::getMilestoneGoalCountByCampaign($campaign->id, $milestone->id);
-                    $milestoneRewardGiven = MilestoneUsersProgress::getRewardGivenForMilestone($milestone->id, $user->id);
+                    $milestoneRewardGiven = CampaignMilestoneUsersProgress::getRewardGivenForMilestone($milestone->id, $user->id);
                     $userCampaigns[$campaign->id][$user->id]['milestones'][$milestone->id] = [
                         'milestoneComplete' => $milestoneComplete, 
                         'userProgress' => $userProgress,

diff --git a/code/web/sys/Community/Campaign.php b/code/web/sys/Community/Campaign.php
@@ -280,7 +280,7 @@ public static function getMilestoneRewards(int $campaignId, int $userId): array
             $userCampaign->campaignId = $campaignId;
 
             if ($userCampaign->find(true)) {
-                $milestoneProgress = MilestoneUsersProgress::getProgressByMilestoneId($milestone->id, $userId);
+                $milestoneProgress = CampaignMilestoneUsersProgress::getProgressByMilestoneId($milestone->id, $userId);
                 $rewardGiven = (int)$milestoneProgress->rewardGiven;
             }
 
@@ -373,9 +373,9 @@ public function getPastCampaigns(int $userId): array {
                         $pastCampaignList[$campaign->id]->campaignRewardGiven = (int)$userCampaign->rewardGiven;
 
                         foreach ($pastCampaignList[$campaign->id]->milestones as $milestone) {
-                            $milestone->userProgress = MilestoneUsersProgress::getProgressByMilestoneId($milestone->id, $userId);
+                            $milestone->userProgress = CampaignMilestoneUsersProgress::getProgressByMilestoneId($milestone->id, $userId);
                             $milestone->isComplete = $milestoneCompletionStatus[$milestone->id] ?? false;
-                            $milestone->rewardGiven = MilestoneUsersProgress::getRewardGivenForMilestone($milestone->id, $userId);
+                            $milestone->rewardGiven = CampaignMilestoneUsersProgress::getRewardGivenForMilestone($milestone->id, $userId);
                             $reward->id = $milestone->rewardId;
                             if($reward->find(true)) {
                                 $milestone->rewardName = $reward->name;

diff --git a/code/web/sys/Community/CampaignMilestone.php b/code/web/sys/Community/CampaignMilestone.php
@@ -1,7 +1,7 @@
 <?php
 require_once ROOT_DIR . '/sys/Community/Reward.php';
 require_once ROOT_DIR . '/sys/Community/Milestone.php';
-require_once ROOT_DIR . '/sys/Community/MilestoneUsersProgress.php';
+require_once ROOT_DIR . '/sys/Community/CampaignMilestoneUsersProgress.php';
 
 class CampaignMilestone extends DataObject {
     public $__table = 'ce_campaign_milestones';
@@ -102,14 +102,14 @@ public static function getMilestoneGoalCountByCampaign($campaignId, $milestoneId
     }
 
    public static function getMilestoneProgress($campaignId, $userId, $milestoneId) {
-        $milestoneUsersProgress = new MilestoneUsersProgress();
+        $campaignMilestoneUsersProgress = new CampaignMilestoneUsersProgress();
         $campaignMilestone = new CampaignMilestone();
 
         //Get goal total
         $goal = $campaignMilestone->getMilestoneGoalCountByCampaign($campaignId, $milestoneId);
 
         //Number of completed goals for this milestone
-        $userCompletedGoalCount = $milestoneUsersProgress->getProgressByMilestoneId($milestoneId, $userId);
+        $userCompletedGoalCount = $campaignMilestoneUsersProgress->getProgressByMilestoneId($milestoneId, $userId);
 
         if ($goal > 0) {
             $progress = ($userCompletedGoalCount / $goal ) * 100;

diff --git a/code/web/sys/Community/CampaignMilestoneProgressEntry.php b/code/web/sys/Community/CampaignMilestoneProgressEntry.php
@@ -7,7 +7,7 @@ class CampaignMilestoneProgressEntry extends DataObject
     public $id;
     public $userId;
     public $ce_milestone_id;
-    public $ce_milestone_users_progress_id;
+    public $ce_campaign_milestone_users_progress_id;
     public $tableName;
     public $processed;
     public $object;
@@ -19,9 +19,9 @@ class CampaignMilestoneProgressEntry extends DataObject
      * @param mixed $args Optional arguments to further configure the progress entry. Expects the following structure:
      * 
      *  [
-     *     "object"                 => An object param, may be of any of the allowed milestone types e.g. 'Checkout', 'Hold', etc.
-     *     "userId"                 => A user id param
-     *     "milestoneUsersProgress" => A MilestoneUsersProgress object param to be associated with this progress entry
+     *     "object"                         => An object param, may be of any of the allowed milestone types e.g. 'Checkout', 'Hold', etc.
+     *     "userId"                         => A user id param
+     *     "campaignMilestoneUsersProgress" => A CampaignMilestoneUsersProgress object param to be associated with this progress entry
      *  ]
      * 
      * @return void
@@ -35,7 +35,7 @@ public function initialize(Milestone $milestone, $args = null)
             return;
 
         $this->userId = $args['userId'];
-        $this->ce_milestone_users_progress_id = $args['milestoneUsersProgress']->id;
+        $this->ce_campaign_milestone_users_progress_id = $args['campaignMilestoneUsersProgress']->id;
         $this->processed = 0;
         $this->tableName = $args['object']->__table;
         $this->object = json_encode($args['object']);

diff --git a/.../sys/Community/MilestoneUsersProgress.php → ...munity/CampaignMilestoneUsersProgress.php b/.../sys/Community/MilestoneUsersProgress.php → ...munity/CampaignMilestoneUsersProgress.php
@@ -1,7 +1,7 @@
 <?php
-class MilestoneUsersProgress extends DataObject
+class CampaignMilestoneUsersProgress extends DataObject
 {
-    public $__table = 'ce_milestone_users_progress';
+    public $__table = 'ce_campaign_milestone_users_progress';
     public $id;
     public $userId;
     public $ce_milestone_id;
@@ -19,7 +19,7 @@ public static function getProgressByMilestoneId($milestoneId, $userId) {
     }
 
     public static function getRewardGivenForMilestone($milestoneId, $userId) {
-        $progress = new MilestoneUsersProgress();
+        $progress = new CampaignMilestoneUsersProgress();
         $progress->ce_milestone_id = $milestoneId;
         $progress->userId = $userId;
 

diff --git a/code/web/sys/Community/Milestone.php b/code/web/sys/Community/Milestone.php
@@ -1,7 +1,7 @@
 <?php
 require_once ROOT_DIR . '/sys/Community/Campaign.php';
 require_once ROOT_DIR . '/sys/Community/CampaignMilestone.php';
-require_once ROOT_DIR . '/sys/Community/MilestoneUsersProgress.php';
+require_once ROOT_DIR . '/sys/Community/CampaignMilestoneUsersProgress.php';
 require_once ROOT_DIR . '/sys/Community/Reward.php';
 require_once ROOT_DIR . '/sys/Community/UserCampaign.php';
 class Milestone extends DataObject {
@@ -178,14 +178,14 @@ public function addCampaignMilestoneProgressEntry( $object, $userId)
             return;
 
         # Check if this milestone already has progress for this user
-        $milestoneUsersProgress = new MilestoneUsersProgress();
-        $milestoneUsersProgress->ce_milestone_id = $this->id;
-        $milestoneUsersProgress->userId = $userId;
+        $campaignMilestoneUsersProgress = new CampaignMilestoneUsersProgress();
+        $campaignMilestoneUsersProgress->ce_milestone_id = $this->id;
+        $campaignMilestoneUsersProgress->userId = $userId;
 
         # If there isn't one, create it.
-        if (!$milestoneUsersProgress->find(true)) {
-            $milestoneUsersProgress->progress = 0;
-            $milestoneUsersProgress->insert();
+        if (!$campaignMilestoneUsersProgress->find(true)) {
+            $campaignMilestoneUsersProgress->progress = 0;
+            $campaignMilestoneUsersProgress->insert();
         }
 
         $campaignMilestoneProgressEntry = new CampaignMilestoneProgressEntry();
@@ -194,12 +194,12 @@ public function addCampaignMilestoneProgressEntry( $object, $userId)
             [
                 "object" => $object,
                 "userId" => $userId,
-                "milestoneUsersProgress" => $milestoneUsersProgress
+                "campaignMilestoneUsersProgress" => $campaignMilestoneUsersProgress
             ]
         );
 
-        $milestoneUsersProgress->progress++;
-        $milestoneUsersProgress->update();
+        $campaignMilestoneUsersProgress->progress++;
+        $campaignMilestoneUsersProgress->update();
     }
 
     /**

diff --git a/code/web/sys/Community/UserCampaign.php b/code/web/sys/Community/UserCampaign.php
@@ -1,6 +1,6 @@
 <?php
     require_once ROOT_DIR . '/sys/Community/CampaignMilestone.php';
-    require_once ROOT_DIR . '/sys/Community/MilestoneUsersProgress.php';
+    require_once ROOT_DIR . '/sys/Community/CampaignMilestoneUsersProgress.php';
 
 class UserCampaign extends DataObject {
     public $__table = 'ce_user_campaign';
@@ -68,7 +68,7 @@ public function checkCompletionStatus() {
         $isComplete = true;
 
         foreach ($milestones as $milestone) {
-            $userProgress = MilestoneUsersProgress::getProgressByMilestoneId($milestone->id, $this->userId);
+            $userProgress = CampaignMilestoneUsersProgress::getProgressByMilestoneId($milestone->id, $this->userId);
             $goal = CampaignMilestone::getMilestoneGoalCountByCampaign($this->campaignId, $milestone->id);
 
             if ($userProgress < $goal) {
@@ -85,7 +85,7 @@ public function checkMilestoneCompletionStatus() {
 
         foreach ($milestones as $milestone) {
             //User's progress for this milestone
-            $userProgress = MilestoneUsersProgress::getProgressByMilestoneId($milestone->id, $this->userId);
+            $userProgress = CampaignMilestoneUsersProgress::getProgressByMilestoneId($milestone->id, $this->userId);
 
             //Goal for this milestone
             $goal = CampaignMilestone::getMilestoneGoalCountByCampaign($this->campaignId, $milestone->id);

diff --git a/code/web/sys/Community/action-hooks.php b/code/web/sys/Community/action-hooks.php
@@ -18,7 +18,7 @@
         return;
 
     while ($milestone->fetch()) {
-        if (_milestoneProgressEntryObjectAlreadyExists($value, $milestone))
+        if (_campaignMilestoneProgressEntryObjectAlreadyExists($value, $milestone))
             return;
 
         $milestone->addCampaignMilestoneProgressEntry($value, $value->userId);
@@ -41,7 +41,7 @@
         return;
 
     while ($milestone->fetch()) {
-        if (_milestoneProgressEntryObjectAlreadyExists($value, $milestone))
+        if (_campaignMilestoneProgressEntryObjectAlreadyExists($value, $milestone))
             return;
 
         $milestone->addCampaignMilestoneProgressEntry($value, $value->userId);
@@ -98,13 +98,13 @@
  * @param Milestone $milestone The milestone object.
  * @return bool Returns true if an entry exists, false otherwise.
  */
-function _milestoneProgressEntryObjectAlreadyExists($value, $milestone)
+function _campaignMilestoneProgressEntryObjectAlreadyExists($value, $milestone)
 {
-    $milestoneProgressEntryCheck = new CampaignMilestoneProgressEntry();
-    $milestoneProgressEntryCheck->initialize($milestone);
-    if ($milestoneProgressEntryCheck->find()) {
-        while ($milestoneProgressEntryCheck->fetch()) {
-            $decoded_object = json_decode($milestoneProgressEntryCheck->object);
+    $campaignMilestoneProgressEntryCheck = new CampaignMilestoneProgressEntry();
+    $campaignMilestoneProgressEntryCheck->initialize($milestone);
+    if ($campaignMilestoneProgressEntryCheck->find()) {
+        while ($campaignMilestoneProgressEntryCheck->fetch()) {
+            $decoded_object = json_decode($campaignMilestoneProgressEntryCheck->object);
             if (
                 $decoded_object->sourceId == $value->sourceId &&
                 $decoded_object->recordId == $value->recordId &&

diff --git a/code/web/sys/DBMaintenance/community_engagement_updates.php b/code/web/sys/DBMaintenance/community_engagement_updates.php
@@ -61,18 +61,18 @@ function getCommunityEngagementUpdates() {
                      id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
                      userId INT NOT NULL,
                      ce_milestone_id INT NOT NULL,
-                     ce_milestone_users_progress_id INT NOT NULL,
+                     ce_campaign_milestone_users_progress_id INT NOT NULL,
                      tableName VARCHAR(100),
                      processed TINYINT DEFAULT 0,
                      object MEDIUMTEXT
                 )ENGINE = InnoDB",
             ],
         ],
-        'add_ce_milestone_users_progress' => [
-            'title' => 'Add add_ce_milestone_users_progress database table',
+        'add_ce_campaign_milestone_users_progress' => [
+            'title' => 'Add add_ce_campaign_milestone_users_progress database table',
             'description' => 'Store milestone progress for each user',
             'sql' => [
-                "CREATE TABLE IF NOT EXISTS ce_milestone_users_progress (
+                "CREATE TABLE IF NOT EXISTS ce_campaign_milestone_users_progress (
                      id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
                      userId INT NOT NULL,
                      ce_milestone_id INT NOT NULL,