pkp/pkp-lib#10292 Controlled Vocab DAO to Eloquent Model

pkp · Oct 9, 2024 · 27fca5b · 27fca5b
1 parent 48db9be
commit 27fca5b
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 30 deletions.
diff --git a/classes/search/PreprintSearch.php b/classes/search/PreprintSearch.php
@@ -23,12 +23,12 @@
 use APP\core\Request;
 use APP\facades\Repo;
 use APP\server\Server;
+use PKP\controlledVocab\ControlledVocab;
 use PKP\db\DAORegistry;
 use PKP\facades\Locale;
 use PKP\plugins\Hook;
 use PKP\search\SubmissionSearch;
 use PKP\submission\PKPSubmission;
-use PKP\submission\SubmissionKeywordDAO;
 use PKP\user\User;
 
 class PreprintSearch extends SubmissionSearch
@@ -318,9 +318,14 @@ public function getSimilarityTerms($submissionId)
             $preprint = Repo::submission()->get($submissionId);
             if ($preprint->getData('status') === PKPSubmission::STATUS_PUBLISHED) {
                 // Retrieve keywords (if any).
-                /** @var SubmissionKeywordDAO */
-                $submissionSubjectDao = DAORegistry::getDAO('SubmissionKeywordDAO');
-                $allSearchTerms = array_filter($submissionSubjectDao->getKeywords($preprint->getId(), [Locale::getLocale(), $preprint->getData('locale'), Locale::getPrimaryLocale()]));
+                $allSearchTerms = array_filter(
+                    Repo::controlledVocab()->getBySymbolic(
+                        ControlledVocab::CONTROLLED_VOCAB_SUBMISSION_KEYWORD,
+                        Application::ASSOC_TYPE_PUBLICATION,
+                        $preprint->getId(),
+                        [Locale::getLocale(), $preprint->getData('locale'), Locale::getPrimaryLocale()]
+                    )
+                );
                 foreach ($allSearchTerms as $locale => $localeSearchTerms) {
                     $searchTerms += $localeSearchTerms;
                 }

diff --git a/dbscripts/xml/upgrade.xml b/dbscripts/xml/upgrade.xml
@@ -131,6 +131,7 @@
 		<migration class="APP\migration\upgrade\v3_5_0\I9937_EditorialTeamToEditorialHistory"/>
 		<migration class="PKP\migration\upgrade\v3_5_0\I10041_UserGroupsAndUserUserGroupsMastheadValues"/>
         <migration class="PKP\migration\upgrade\v3_5_0\I9771_OrcidMigration"/>
+		<migration class="PKP\migration\upgrade\v3_5_0\I10292_RemoveControlledVocabEntrySettingType"/>
 	</upgrade>
 
 	<!-- update plugin configuration - should be done as the final upgrade task -->

diff --git a/plugins/metadata/dc11/filter/Dc11SchemaPreprintAdapter.php b/plugins/metadata/dc11/filter/Dc11SchemaPreprintAdapter.php
@@ -26,14 +26,13 @@
 use APP\oai\ops\OAIDAO;
 use APP\plugins\PubIdPlugin;
 use APP\submission\Submission;
+use PKP\controlledVocab\ControlledVocab;
 use PKP\db\DAORegistry;
 use PKP\facades\Locale;
 use PKP\metadata\MetadataDataObjectAdapter;
 use PKP\metadata\MetadataDescription;
 use PKP\plugins\Hook;
 use PKP\plugins\PluginRegistry;
-use PKP\submission\SubmissionKeywordDAO;
-use PKP\submission\SubmissionSubjectDAO;
 
 class Dc11SchemaPreprintAdapter extends MetadataDataObjectAdapter
 {
@@ -88,14 +87,20 @@ public function &extractMetadataFromDataObject(&$submission)
         }
 
         // Subject
-        /** @var SubmissionKeywordDAO */
-        $submissionKeywordDao = DAORegistry::getDAO('SubmissionKeywordDAO');
-        /** @var SubmissionSubjectDAO */
-        $submissionSubjectDao = DAORegistry::getDAO('SubmissionSubjectDAO');
         $supportedLocales = array_keys(Locale::getSupportedFormLocales());
         $subjects = array_merge_recursive(
-            (array) $submissionKeywordDao->getKeywords($publication->getId(), $supportedLocales),
-            (array) $submissionSubjectDao->getSubjects($publication->getId(), $supportedLocales)
+            Repo::controlledVocab()->getBySymbolic(
+                ControlledVocab::CONTROLLED_VOCAB_SUBMISSION_KEYWORD,
+                Application::ASSOC_TYPE_PUBLICATION,
+                $publication->getId(),
+                $supportedLocales
+            ),
+            Repo::controlledVocab()->getBySymbolic(
+                ControlledVocab::CONTROLLED_VOCAB_SUBMISSION_SUBJECT,
+                Application::ASSOC_TYPE_PUBLICATION,
+                $publication->getId(),
+                $supportedLocales
+            )
         );
         $this->_addLocalizedElements($dc11Description, 'dc:subject', $subjects);
 

diff --git a/plugins/oaiMetadataFormats/dc/tests/OAIMetadataFormat_DCTest.php b/plugins/oaiMetadataFormats/dc/tests/OAIMetadataFormat_DCTest.php
@@ -35,17 +35,17 @@
 use APP\server\Server;
 use APP\submission\Submission;
 use Illuminate\Support\LazyCollection;
+use Mockery;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\MockObject\MockObject;
+use PKP\controlledVocab\Repository as ControlledVocabRepository;
 use PKP\core\Dispatcher;
 use PKP\core\Registry;
 use PKP\db\DAORegistry;
 use PKP\doi\Doi;
 use PKP\galley\Collector as GalleyCollector;
 use PKP\galley\Galley;
 use PKP\oai\OAIRecord;
-use PKP\submission\SubmissionKeywordDAO;
-use PKP\submission\SubmissionSubjectDAO;
 use PKP\tests\PKPTestCase;
 
 #[CoversClass(OAIMetadataFormat_DC::class)]
@@ -57,7 +57,7 @@ class OAIMetadataFormat_DCTest extends PKPTestCase
      */
     protected function getMockedDAOs(): array
     {
-        return [...parent::getMockedDAOs(), 'OAIDAO', 'SubmissionSubjectDAO', 'SubmissionKeywordDAO'];
+        return [...parent::getMockedDAOs(), 'OAIDAO'];
     }
 
     /**
@@ -93,6 +93,7 @@ public function testToXml()
         $publication = $this->getMockBuilder(Publication::class)
             ->onlyMethods([])
             ->getMock();
+        $publication->setData('id', 0);
         $publication->setData('pages', 15);
         $publication->setData('type', 'art-type', 'en');
         $publication->setData('title', 'preprint-title-en', 'en');
@@ -158,6 +159,7 @@ public function testToXml()
             ->willReturn(Server::PUBLISHING_MODE_OPEN);
         $server->setName('server-title', 'en');
         $server->setData('publisherInstitution', 'server-publisher');
+        $server->setData('supportedFormLocales', []);
         $server->setPrimaryLocale('en');
         $server->setPath('server-path');
         $server->setData('onlineIssn', 'onlineIssn');
@@ -232,23 +234,18 @@ public function testToXml()
             ->willReturn(LazyCollection::wrap($galleys));
         app()->instance(GalleyCollector::class, $mockGalleyCollector);
 
-        // Mocked DAO to return the subjects
-        $submissionSubjectDao = $this->getMockBuilder(SubmissionSubjectDAO::class)
-            ->onlyMethods(['getSubjects'])
+        $controlledVocabRepoMock = Mockery::mock(ControlledVocabRepository::class)
+            ->makePartial()
+            ->shouldReceive('getBySymbolic')
+            ->twice()
+            ->withAnyArgs()
+            ->andReturn(
+                ['en' => ['preprint-keyword']],
+                ['en' => ['preprint-subject', 'preprint-subject-class']]
+            )
             ->getMock();
-        $submissionSubjectDao->expects($this->any())
-            ->method('getSubjects')
-            ->willReturn(['en' => ['preprint-subject', 'preprint-subject-class']]);
-        DAORegistry::registerDAO('SubmissionSubjectDAO', $submissionSubjectDao);
 
-        // Mocked DAO to return the keywords
-        $submissionKeywordDao = $this->getMockBuilder(SubmissionKeywordDAO::class)
-            ->onlyMethods(['getKeywords'])
-            ->getMock();
-        $submissionKeywordDao->expects($this->any())
-            ->method('getKeywords')
-            ->willReturn(['en' => ['preprint-keyword']]);
-        DAORegistry::registerDAO('SubmissionKeywordDAO', $submissionKeywordDao);
+        app()->instance(ControlledVocabRepository::class, $controlledVocabRepoMock);
 
         //
         // Test