#10292 refactored interest manager to repo and removed it

pkp · Oct 8, 2024 · 3e03ed6 · 3e03ed6
1 parent 3e91b7a
commit 3e03ed6
Show file tree

Hide file tree

Showing 11 changed files with 74 additions and 126 deletions.
diff --git a/classes/user/InterestManager.php b/classes/user/InterestManager.php
diff --git a/classes/user/User.php b/classes/user/User.php
@@ -20,6 +20,7 @@
 
 namespace PKP\user;
 
+use APP\facades\Repo;
 use Illuminate\Contracts\Auth\Authenticatable;
 use PKP\db\DAORegistry;
 use PKP\identity\Identity;
@@ -192,8 +193,7 @@ public function setBillingAddress($billingAddress)
      */
     public function getInterestString()
     {
-        $interestManager = new InterestManager();
-        return $interestManager->getInterestsString($this);
+        return Repo::userInterest()->getInterestsString($this);
     }
 
     /**

diff --git a/classes/user/form/RegistrationForm.php b/classes/user/form/RegistrationForm.php
@@ -32,7 +32,6 @@
 use PKP\security\Role;
 use PKP\security\Validation;
 use PKP\site\Site;
-use PKP\user\InterestManager;
 use PKP\user\User;
 
 class RegistrationForm extends Form
@@ -323,8 +322,7 @@ public function execute(...$functionArgs)
         }
 
         // Insert the user interests
-        $interestManager = new InterestManager();
-        $interestManager->setInterestsForUser($user, $this->getData('interests'));
+        Repo::userInterest()->setInterestsForUser($user, $this->getData('interests'));
 
         return $userId;
     }

diff --git a/classes/user/form/RolesForm.php b/classes/user/form/RolesForm.php
@@ -19,7 +19,6 @@
 use APP\core\Application;
 use APP\facades\Repo;
 use APP\template\TemplateManager;
-use PKP\user\InterestManager;
 use PKP\user\User;
 
 class RolesForm extends BaseProfileForm
@@ -61,12 +60,10 @@ public function fetch($request, $template = null, $display = false)
      */
     public function initData()
     {
-        $interestManager = new InterestManager();
-
         $user = $this->getUser();
 
         $this->_data = [
-            'interests' => $interestManager->getInterestsForUser($user),
+            'interests' => Repo::userInterest()->getInterestsForUser($user),
         ];
     }
 
@@ -98,8 +95,7 @@ public function execute(...$functionArgs)
         $userFormHelper->saveRoleContent($this, $user);
 
         // Insert the user interests
-        $interestManager = new InterestManager();
-        $interestManager->setInterestsForUser($user, $this->getData('interests'));
+        Repo::userInterest()->setInterestsForUser($user, $this->getData('interests'));
 
         parent::execute(...$functionArgs);
     }

diff --git a/classes/user/interest/Repository.php b/classes/user/interest/Repository.php
@@ -16,21 +16,78 @@
 
 use APP\facades\Repo;
 use Illuminate\Support\Facades\DB;
+use PKP\user\User;
 use PKP\user\interest\UserInterest;
 use PKP\controlledVocab\ControlledVocabEntry;
 use Throwable;
 
 class Repository
 {
     /**
-     * Update a user's set of interests
+     * Get all interests for all users in the system
      */
-    public function setUserInterests(array $interests, int $userId): void
+    public function getAllInterests(?string $filter = null): array
     {
         $controlledVocab = Repo::controlledVocab()->build(
             UserInterest::CONTROLLED_VOCAB_INTEREST
         );
 
+        return ControlledVocabEntry::query()
+            ->withControlledVocabId($controlledVocab->id)
+            ->when(
+                $filter,
+                fn($query) => $query->withSetting(
+                    UserInterest::CONTROLLED_VOCAB_INTEREST,
+                    $filter
+                )
+            )
+            ->get()
+            ->sortBy(UserInterest::CONTROLLED_VOCAB_INTEREST)
+            ->pluck(UserInterest::CONTROLLED_VOCAB_INTEREST)
+            ->toArray();
+    }
+
+    /**
+     * Get user reviewing interests. (Cached in memory for batch fetches.)
+     */
+    public function getInterestsForUser(User $user): array
+    {
+        return ControlledVocabEntry::query()
+            ->whereHas(
+                "controlledVocab",
+                fn($query) => $query
+                    ->withSymbolic(UserInterest::CONTROLLED_VOCAB_INTEREST)
+                    ->withAssoc(0, 0)
+            )
+            ->whereHas("userInterest", fn($query) => $query->withUserId($user->getId()))
+            ->get()
+            ->pluck(UserInterest::CONTROLLED_VOCAB_INTEREST, 'id')
+            ->toArray();
+    }
+
+    /**
+     * Returns a comma separated string of a user's interests
+     */
+    public function getInterestsString(User $user): string
+    {
+        $interests = $this->getInterestsForUser($user);
+
+        return implode(', ', $interests);
+    }
+
+    /**
+     * Set a user's interests
+     */
+    public function setInterestsForUser(User $user, string|array|null $interests = null): void
+    {
+        $interests = is_array($interests)
+            ? $interests
+            : (empty($interests) ? [] : explode(',', $interests));
+
+        $controlledVocab = Repo::controlledVocab()->build(
+            UserInterest::CONTROLLED_VOCAB_INTEREST
+        );
+
         $currentInterests = ControlledVocabEntry::query()
             ->whereHas(
                 'controlledVocab',
@@ -47,7 +104,7 @@ public function setUserInterests(array $interests, int $userId): void
             DB::beginTransaction();
 
             // Delete the existing interests association.
-            UserInterest::query()->withUserId($userId)->delete();
+            UserInterest::query()->withUserId($user->getId())->delete();
 
             $newInterestIds = collect(
                     array_diff(
@@ -70,7 +127,7 @@ public function setUserInterests(array $interests, int $userId): void
             collect($currentInterests->pluck('id'))
                 ->merge($newInterestIds)
                 ->each(fn ($interestId) => UserInterest::create([
-                    'userId' => $userId,
+                    'userId' => $user->getId(),
                     'controlledVocabEntryId' => $interestId,
                 ]));
 

diff --git a/classes/user/maps/Schema.php b/classes/user/maps/Schema.php
@@ -14,11 +14,8 @@
 namespace PKP\user\maps;
 
 use APP\facades\Repo;
-use PKP\user\InterestManager;
-
 use APP\submission\Submission;
 use Illuminate\Support\Enumerable;
-use PKP\user\interest\UserInterest;
 use PKP\db\DAORegistry;
 use PKP\plugins\Hook;
 use PKP\security\Role;
@@ -175,7 +172,7 @@ protected function mapByProperties(array $props, User $user, array $auxiliaryDat
                 case 'interests':
                     $output[$prop] = [];
                     if ($this->context) {
-                        $interests = collect((new InterestManager())->getInterestsForUser($user))
+                        $interests = collect(Repo::userInterest()->getInterestsForUser($user))
                             ->map(fn($value, $index) => ['id' => $index, 'interest' => $value])
                             ->values()
                             ->toArray();

diff --git a/controllers/grid/settings/user/form/UserDetailsForm.php b/controllers/grid/settings/user/form/UserDetailsForm.php
@@ -31,7 +31,6 @@
 use PKP\mail\mailables\UserCreated;
 use PKP\notification\Notification;
 use PKP\security\Validation;
-use PKP\user\InterestManager;
 use PKP\user\User;
 use Symfony\Component\Mailer\Exception\TransportException;
 
@@ -154,7 +153,6 @@ public function initData()
         if (isset($this->user)) {
             $user = $this->user;
             $templateMgr->assign('user', $user);
-            $interestManager = new InterestManager();
 
             $data = [
                 'username' => $user->getUsername(),
@@ -169,7 +167,7 @@ public function initData()
                 'mailingAddress' => $user->getMailingAddress(),
                 'country' => $user->getCountry(),
                 'biography' => $user->getBiography(null), // Localized
-                'interests' => $interestManager->getInterestsForUser($user),
+                'interests' => Repo::userInterest()->getInterestsForUser($user),
                 'locales' => $user->getLocales(),
             ];
             $data['canCurrentUserGossip'] = Repo::user()->canCurrentUserGossip($user->getId());
@@ -392,8 +390,7 @@ public function execute(...$functionParams)
             }
         }
 
-        $interestManager = new InterestManager();
-        $interestManager->setInterestsForUser($this->user, $this->getData('interests'));
+        Repo::userInterest()->setInterestsForUser($this->user, $this->getData('interests'));
 
         return $this->user;
     }

diff --git a/controllers/grid/users/reviewer/form/CreateReviewerForm.php b/controllers/grid/users/reviewer/form/CreateReviewerForm.php
@@ -27,7 +27,6 @@
 use PKP\notification\Notification;
 use PKP\security\Validation;
 use PKP\submission\reviewRound\ReviewRound;
-use PKP\user\InterestManager;
 use Symfony\Component\Mailer\Exception\TransportException;
 
 class CreateReviewerForm extends ReviewerForm
@@ -143,8 +142,7 @@ public function execute(...$functionArgs)
         $this->setData('reviewerId', $reviewerId);
 
         // Insert the user interests
-        $interestManager = new InterestManager();
-        $interestManager->setInterestsForUser($user, $this->getData('interests'));
+        Repo::userInterest()->setInterestsForUser($user, $this->getData('interests'));
 
         // Assign the selected user group ID to the user
         $userGroupId = (int) $this->getData('userGroupId');

diff --git a/pages/user/PKPUserHandler.php b/pages/user/PKPUserHandler.php
@@ -17,12 +17,12 @@
 namespace PKP\pages\user;
 
 use APP\core\Request;
+use APP\facades\Repo;
 use APP\handler\Handler;
 use APP\template\TemplateManager;
 use PKP\core\JSONMessage;
 use PKP\core\PKPRequest;
 use PKP\security\Validation;
-use PKP\user\InterestManager;
 
 class PKPUserHandler extends Handler
 {
@@ -46,7 +46,7 @@ public function getInterests($args, $request)
     {
         return new JSONMessage(
             true,
-            (new InterestManager())->getAllInterests($request->getUserVar('term'))
+            Repo::userInterest()->getAllInterests($request->getUserVar('term'))
         );
     }
 

diff --git a/plugins/importexport/users/filter/PKPUserUserXmlFilter.php b/plugins/importexport/users/filter/PKPUserUserXmlFilter.php
@@ -21,7 +21,6 @@
 use PKP\filter\FilterDAO;
 use PKP\filter\FilterGroup;
 use PKP\plugins\importexport\native\filter\NativeExportFilter;
-use PKP\user\InterestManager;
 use PKP\user\User;
 
 class PKPUserUserXmlFilter extends NativeExportFilter
@@ -141,8 +140,7 @@ public function createPKPUserNode($doc, $user)
         }
 
         // Add Reviewing Interests, if any.
-        $interestManager = new InterestManager();
-        $interests = $interestManager->getInterestsString($user);
+        $interests = Repo::userInterest()->getInterestsString($user);
         $this->createOptionalNode($doc, $userNode, 'review_interests', $interests);
 
         return $userNode;

diff --git a/plugins/importexport/users/filter/UserXmlPKPUserFilter.php b/plugins/importexport/users/filter/UserXmlPKPUserFilter.php
@@ -26,7 +26,6 @@
 use PKP\plugins\importexport\users\PKPUserImportExportDeployment;
 use PKP\security\Validation;
 use PKP\site\SiteDAO;
-use PKP\user\InterestManager;
 use PKP\user\User;
 
 class UserXmlPKPUserFilter extends \PKP\plugins\importexport\native\filter\NativeImportFilter
@@ -264,8 +263,7 @@ public function parseUser($node)
                 $n = $interestNodeList->item(0);
                 if ($n) {
                     $interests = preg_split('/,\s*/', $n->textContent);
-                    $interestManager = new InterestManager();
-                    $interestManager->setInterestsForUser($user, $interests);
+                    Repo::userInterest()->setInterestsForUser($user, $interests);
                 }
             }