Merge pull request #1787 from Vitaliy-1/i10506_usergroup_eloquent

pkp/pkp-lib#10506 User Group refactoring to Eloquent Model
pkp · Dec 16, 2024 · 74b1370 · 74b1370
2 parents 1187580 + eb13ac6
commit 74b1370
Show file tree

Hide file tree

Showing 17 changed files with 56 additions and 38 deletions.
diff --git a/api/v1/submissions/SubmissionController.php b/api/v1/submissions/SubmissionController.php
@@ -21,7 +21,6 @@
 use APP\components\forms\publication\PublicationLicenseForm;
 use APP\components\forms\submission\AudienceForm;
 use APP\components\forms\submission\PublicationDatesForm;
-use APP\facades\Repo;
 use APP\file\PublicFileManager;
 use APP\publication\Publication;
 use APP\submission\Submission;
@@ -33,6 +32,7 @@
 use PKP\context\Context;
 use PKP\core\PKPApplication;
 use PKP\security\Role;
+use PKP\userGroup\UserGroup;
 
 class SubmissionController extends PKPSubmissionController
 {
@@ -150,7 +150,9 @@ protected function getPublicationLicenseForm(Request $illuminateRequest): JsonRe
         $publicationApiUrl = $data['publicationApiUrl']; /** @var String $publicationApiUrl */
 
         $locales = $this->getPublicationFormLocales($context, $submission);
-        $authorUserGroups = Repo::userGroup()->getByRoleIds([Role::ROLE_ID_AUTHOR], $submission->getData('contextId'));
+        $authorUserGroups = UserGroup::withRoleIds([Role::ROLE_ID_AUTHOR])
+            ->withContextIds([$submission->getData('contextId')])
+            ->get();
 
         $publicationLicenseForm = new PublicationLicenseForm($publicationApiUrl, $locales, $publication, $context, $authorUserGroups);
         $submissionLocale = $submission->getData('locale');

diff --git a/classes/components/forms/publication/PublicationLicenseForm.php b/classes/components/forms/publication/PublicationLicenseForm.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @file classes/components/form/publication/PublicationLicenseForm.php
  *
@@ -20,7 +21,7 @@
 use APP\press\Press;
 use APP\publication\Publication;
 use APP\submission\Submission;
-use Illuminate\Support\LazyCollection;
+use Illuminate\Support\Enumerable;
 use PKP\components\forms\FieldText;
 use PKP\components\forms\publication\PKPPublicationLicenseForm;
 use PKP\userGroup\UserGroup;
@@ -34,7 +35,7 @@ class PublicationLicenseForm extends PKPPublicationLicenseForm
      * @param array $locales Supported locales
      * @param Publication $publication The publication to change settings for
      * @param Press $context The publication's context
-     * @param LazyCollection<UserGroup> $userGroups User groups in this context
+     * @param Enumerable<UserGroup> $userGroups User groups in this context
      */
     public function __construct($action, $locales, $publication, $context, $userGroups)
     {

diff --git a/classes/monograph/Chapter.php b/classes/monograph/Chapter.php
@@ -286,7 +286,6 @@ public function setSourceChapterId(?int $sourceChapterId): void
     public function isPageEnabled(): ?bool
     {
         return $this->getData('isPageEnabled') || !empty($this->getDoi());
-        ;
     }
 
     /**

diff --git a/classes/search/MonographSearch.php b/classes/search/MonographSearch.php
@@ -26,6 +26,7 @@
 use PKP\db\DAORegistry;
 use PKP\plugins\Hook;
 use PKP\search\SubmissionSearch;
+use PKP\userGroup\UserGroup;
 
 class MonographSearch extends SubmissionSearch
 {
@@ -75,7 +76,8 @@ public function getSparseArray($unorderedResults, $orderBy, $orderDir, $exclude)
         }
 
         $i = 0; // Used to prevent ties from clobbering each other
-        $authorUserGroups = Repo::userGroup()->getCollector()->filterByRoleIds([\PKP\security\Role::ROLE_ID_AUTHOR])->getMany();
+        $authorUserGroups = UserGroup::withRoleIds([\PKP\security\Role::ROLE_ID_AUTHOR])
+            ->get();
         foreach ($unorderedResults as $submissionId => $data) {
             // Exclude unwanted IDs.
             if (in_array($submissionId, $exclude)) {

diff --git a/classes/submission/Submission.php b/classes/submission/Submission.php
@@ -22,9 +22,9 @@
 
 namespace APP\submission;
 
-use APP\facades\Repo;
 use APP\publication\Publication;
 use PKP\submission\PKPSubmission;
+use PKP\userGroup\UserGroup;
 
 class Submission extends PKPSubmission
 {
@@ -67,7 +67,11 @@ public function _getContextLicenseFieldValue($locale, $field, $publication = nul
                         if (!$publication) {
                             $publication = $this->getCurrentPublication();
                         }
-                        $authorUserGroups = Repo::userGroup()->getCollector()->filterByRoleIds([\PKP\security\Role::ROLE_ID_AUTHOR])->filterByContextIds([$context->getId()])->getMany();
+
+                        $authorUserGroups = UserGroup::withRoleIds([\PKP\security\Role::ROLE_ID_AUTHOR])
+                            ->withContextIds([$context->getId()])
+                            ->get();
+
                         $fieldValue = [$context->getPrimaryLocale() => $publication->getAuthorString($authorUserGroups)];
                         break;
                     case 'context':

diff --git a/lib/pkp b/lib/pkp
diff --git a/pages/catalog/CatalogBookHandler.php b/pages/catalog/CatalogBookHandler.php
@@ -44,6 +44,7 @@
 use PKP\submission\GenreDAO;
 use PKP\submission\PKPSubmission;
 use PKP\submissionFile\SubmissionFile;
+use PKP\userGroup\UserGroup;
 
 class CatalogBookHandler extends Handler
 {
@@ -175,9 +176,7 @@ public function book($args, $request)
             return empty($a) || strtotime((string) $b->getData('datePublished')) < strtotime((string) $a->getData('datePublished')) ? $b : $a;
         }, 0);
 
-        $userGroups = Repo::userGroup()->getCollector()
-            ->filterByContextIds([$submission->getData('contextId')])
-            ->getMany();
+        $userGroups = UserGroup::withContextIds([$submission->getData('contextId')])->get();
 
         $templateMgr->assign([
             'isChapterRequest' => $this->isChapterRequest,

diff --git a/pages/catalog/CatalogHandler.php b/pages/catalog/CatalogHandler.php
@@ -30,6 +30,7 @@
 use PKP\db\DAORegistry;
 use PKP\file\ContextFileManager;
 use PKP\pages\catalog\PKPCatalogHandler;
+use PKP\userGroup\UserGroup;
 
 class CatalogHandler extends PKPCatalogHandler
 {
@@ -104,7 +105,9 @@ public function page($args, $request, $isFirstPage = false)
 
         $templateMgr->assign([
             'publishedSubmissions' => $submissions->toArray(),
-            'authorUserGroups' => $authorUserGroups = Repo::userGroup()->getCollector()->filterByRoleIds([\PKP\security\Role::ROLE_ID_AUTHOR])->filterByContextIds([$context->getId()])->getMany()->remember(),
+            'authorUserGroups' => UserGroup::withRoleIds([\PKP\security\Role::ROLE_ID_AUTHOR])
+                ->withContextIds([$context->getId()])
+                ->get(),
             'featuredMonographIds' => $featuredMonographIds,
             'contextSeries' => $seriesIterator->toArray(),
         ]);
@@ -131,7 +134,9 @@ public function newReleases($args, $request)
         $newReleases = $newReleaseDao->getMonographsByAssoc(Application::ASSOC_TYPE_PRESS, $press->getId());
         $templateMgr->assign([
             'publishedSubmissions' => $newReleases,
-            'authorUserGroups' => $authorUserGroups = Repo::userGroup()->getCollector()->filterByRoleIds([\PKP\security\Role::ROLE_ID_AUTHOR])->filterByContextIds([$press->getId()])->getMany()->remember(),
+            'authorUserGroups' => UserGroup::withRoleIds([\PKP\security\Role::ROLE_ID_AUTHOR])
+                ->withContextIds([$press->getId()])
+                ->get(),
         ]);
 
         // Display
@@ -199,7 +204,9 @@ public function series($args, $request)
             'publishedSubmissions' => $submissions->toArray(),
             'featuredMonographIds' => $featuredMonographIds,
             'newReleasesMonographs' => $newReleases,
-            'authorUserGroups' => $authorUserGroups = Repo::userGroup()->getCollector()->filterByRoleIds([\PKP\security\Role::ROLE_ID_AUTHOR])->filterByContextIds([$context->getId()])->getMany()->remember(),
+            'authorUserGroups' => UserGroup::withRoleIds([\PKP\security\Role::ROLE_ID_AUTHOR])
+                ->withContextIds([$context->getId()])
+                ->get(),
         ]);
 
         $templateMgr->display('frontend/pages/catalogSeries.tpl');

diff --git a/pages/index/IndexHandler.php b/pages/index/IndexHandler.php
@@ -30,6 +30,7 @@
 use PKP\pages\index\PKPIndexHandler;
 use PKP\security\Validation;
 use PKP\site\Site;
+use PKP\userGroup\UserGroup;
 
 class IndexHandler extends PKPIndexHandler
 {
@@ -129,7 +130,9 @@ public function _displayPressIndexPage($press, $request)
             'homepageImage' => $press->getLocalizedSetting('homepageImage'),
             'pageTitleTranslated' => $press->getLocalizedSetting('name'),
             'displayCreativeCommons' => $press->getSetting('includeCreativeCommons'),
-            'authorUserGroups' => Repo::userGroup()->getCollector()->filterByRoleIds([\PKP\security\Role::ROLE_ID_AUTHOR])->filterByContextIds([$press->getId()])->getMany()->remember(),
+            'authorUserGroups' => UserGroup::withRoleIds([\PKP\security\Role::ROLE_ID_AUTHOR])
+                ->withContextIds([$press->getId()])
+                ->get(),
         ]);
 
         $this->_setupAnnouncements($press, $templateMgr);

diff --git a/pages/manageCatalog/ManageCatalogHandler.php b/pages/manageCatalog/ManageCatalogHandler.php
@@ -27,6 +27,7 @@
 use PKP\security\authorization\PKPSiteAccessPolicy;
 use PKP\security\Role;
 use PKP\submission\GenreDAO;
+use PKP\userGroup\UserGroup;
 
 class ManageCatalogHandler extends Handler
 {
@@ -124,9 +125,7 @@ public function index($args, $request)
         $total = $collector->getCount();
         $submissions = $collector->limit($catalogList->count)->getMany();
 
-        $userGroups = Repo::userGroup()->getCollector()
-            ->filterByContextIds([$context->getId()])
-            ->getMany();
+        $userGroups = UserGroup::withContextIds([$context->getId()])->get();
 
         /** @var GenreDAO $genreDao */
         $genreDao = DAORegistry::getDAO('GenreDAO');

diff --git a/pages/search/SearchHandler.php b/pages/search/SearchHandler.php
@@ -17,10 +17,10 @@
 namespace APP\pages\search;
 
 use APP\core\Request;
-use APP\facades\Repo;
 use APP\handler\Handler;
 use APP\search\MonographSearch;
 use APP\template\TemplateManager;
+use PKP\userGroup\UserGroup;
 
 class SearchHandler extends Handler
 {
@@ -57,10 +57,9 @@ public function search($args, $request)
         $templateMgr->assign([
             'results' => $monographSearch->retrieveResults($request, $press, [null => $query], $error, null, null, $rangeInfo),
             'searchQuery' => $query,
-            'authorUserGroups' => Repo::userGroup()->getCollector()
-                ->filterByRoleIds([\PKP\security\Role::ROLE_ID_AUTHOR])
-                ->filterByContextIds($press ? [$press->getId()] : null)
-                ->getMany()->remember(),
+            'authorUserGroups' => UserGroup::withRoleIds([\PKP\security\Role::ROLE_ID_AUTHOR])
+                ->withContextIds($press ? [$press->getId()] : null)
+                ->get(),
         ]);
 
         // Display

diff --git a/plugins/generic/citationStyleLanguage b/plugins/generic/citationStyleLanguage
diff --git a/plugins/generic/webFeed b/plugins/generic/webFeed
diff --git a/plugins/importexport/csv/CSVImportExportPlugin.php b/plugins/importexport/csv/CSVImportExportPlugin.php
@@ -28,6 +28,7 @@
 use PKP\submission\GenreDAO;
 use PKP\submission\PKPSubmission;
 use PKP\submissionFile\SubmissionFile;
+use PKP\userGroup\UserGroup;
 
 class CSVImportExportPlugin extends ImportExportPlugin
 {
@@ -162,11 +163,11 @@ public function executeCLI($scriptName, &$args)
                 continue;
             }
 
-            $authorGroup = Repo::userGroup()->getCollector()
-                ->filterByContextIds([$press->getId()])
-                ->filterByRoleIds([Role::ROLE_ID_AUTHOR])
-                ->filterByIsDefault(true)
-                ->getMany()
+            $authorGroup = UserGroup::withContextIds([$press->getId()])
+                ->withContextIds([$press->getId()])
+                ->withRoleIds([Role::ROLE_ID_AUTHOR])
+                ->isDefault(true)
+                ->get()
                 ->first();
             if (!$authorGroup) {
                 echo __('plugins.importexport.csv.noAuthorGroup', ['press' => $pressPath]) . "\n";
@@ -217,7 +218,7 @@ public function executeCLI($scriptName, &$args)
                 $author = Repo::author()->newDataObject();
                 $author->setData('publicationId', $publicationId);
                 $author->setSubmissionId($submissionId);
-                $author->setUserGroupId($authorGroup->getId());
+                $author->setUserGroupId($authorGroup->id);
                 $author->setGivenName($givenName, $locale);
                 $author->setFamilyName($familyName, $locale);
                 $author->setEmail($emailAddress);

diff --git a/plugins/reports/monographReport/Report.php b/plugins/reports/monographReport/Report.php
@@ -294,9 +294,11 @@ private function getDecision(int $editorIndex, int $decisionIndex): ?Decision
      */
     private function getEditorUserGroups(): Collection
     {
-        return $this->editorUserGroups ??= collect(Repo::userGroup()->getCollector()->filterByContextIds([$this->press->getId()])->getMany())
-            ->filter(fn (UserGroup $userGroup) => in_array($userGroup->getRoleId(), [Role::ROLE_ID_MANAGER, Role::ROLE_ID_SUB_EDITOR]))
-            ->mapWithKeys(fn (UserGroup $userGroup) => [$userGroup->getId() => true]);
+        $userGroups = UserGroup::withContextIds([$this->press->getId()])->get();
+
+        return $this->editorUserGroups ??= $userGroups
+            ->filter(fn (UserGroup $userGroup) => in_array($userGroup->roleId, [Role::ROLE_ID_MANAGER, Role::ROLE_ID_SUB_EDITOR]))
+            ->mapWithKeys(fn (UserGroup $userGroup) => [$userGroup->id => true]);
     }
 
     /**

diff --git a/templates/controllers/grid/settings/series/form/seriesForm.tpl b/templates/controllers/grid/settings/series/form/seriesForm.tpl
@@ -83,8 +83,8 @@
 		{fbvFormSection list=true title="manager.sections.form.assignEditors"}
 		<div>{translate key="manager.sections.form.assignEditors.description"}</div>
 		{foreach from=$assignableUserGroups item="assignableUserGroup"}
-			{assign var="role" value=$assignableUserGroup.userGroup->getLocalizedName()}
-			{assign var="userGroupId" value=$assignableUserGroup.userGroup->getId()}
+			{assign var="role" value=$assignableUserGroup.userGroup->getLocalizedData('name')}
+			{assign var="userGroupId" value=$assignableUserGroup.userGroup->id}
 			{foreach from=$assignableUserGroup.users item=$username key="id"}
 				{fbvElement
 					type="checkbox"

diff --git a/templates/controllers/grid/settings/user/userGroupsList.tpl b/templates/controllers/grid/settings/user/userGroupsList.tpl
@@ -13,7 +13,7 @@
 	<ul>	
 	{foreach from=$userGroups->toArray() item=userGroup}
 		<li>
-		{$userGroup->getLocalizedName()|escape}
+		{$userGroup->getLocalizedData('name')|escape}
 		</li>
 	{/foreach}
 	</ul>
-Original file line number
+Diff line change
@@ Expand Up @@
         public function isPageEnabled(): ?bool
         {
             return $this->getData('isPageEnabled') || !empty($this->getDoi());
-            ;
         }
         /**
@@ Expand Down @@