#10292 migrated controlled vocabs setting name from symbolics to name

pkp · Dec 21, 2024 · 9414859 · 9414859
1 parent fb469a3
commit 9414859
Show file tree

Hide file tree

Showing 9 changed files with 58 additions and 42 deletions.
diff --git a/api/v1/vocabs/PKPVocabController.php b/api/v1/vocabs/PKPVocabController.php
@@ -116,7 +116,7 @@ public function getMany(Request $illuminateRequest): JsonResponse
             ], Response::HTTP_BAD_REQUEST);
         }
 
-        if (ControlledVocab::hasDefinedVocabSymbolic($vocab)) {
+        if (in_array($vocab, ControlledVocab::getDefinedVocabSymbolic())) {
             $entries = ControlledVocabEntry::query()
                 ->whereHas(
                     'controlledVocab',
@@ -135,7 +135,7 @@ public function getMany(Request $illuminateRequest): JsonResponse
 
         $data = [];
         foreach ($entries as $entry) {
-            $data[] = $entry->getLocalizedData($vocab, $locale);
+            $data[] = $entry->getLocalizedData('name', $locale);
         }
 
         $data = array_values(array_unique($data));

diff --git a/classes/controlledVocab/ControlledVocab.php b/classes/controlledVocab/ControlledVocab.php
@@ -96,14 +96,6 @@ public static function getDefinedVocabSymbolic(): array
         ];
     }
 
-    /**
-     * Check if a provided vocab symbolic defined in pre defined symbolic list
-     */
-    public static function hasDefinedVocabSymbolic(string $vocab): bool
-    {
-        return in_array($vocab, static::getDefinedVocabSymbolic());
-    }
-
     /**
      * Get all controlled vocab entries for this controlled vocab
      */

diff --git a/classes/controlledVocab/ControlledVocabEntry.php b/classes/controlledVocab/ControlledVocabEntry.php
@@ -83,23 +83,15 @@ public static function getSchemaName(): ?string
      */
     public function getMultilingualProps(): array
     {
-        return array_merge(
-            $this->multilingualProps,
-            ControlledVocab::getDefinedVocabSymbolic(),
-            Arr::wrap(UserInterest::CONTROLLED_VOCAB_INTEREST)
-        );
+        return array_merge($this->multilingualProps, ['name']);
     }
 
     /**
      * @copydoc \PKP\core\traits\ModelWithSettings::getSettings
      */
     public function getSettings(): array
     {
-        return array_merge(
-            $this->settings,
-            ControlledVocab::getDefinedVocabSymbolic(),
-            Arr::wrap(UserInterest::CONTROLLED_VOCAB_INTEREST)
-        );
+        return array_merge($this->settings, ['name']);
     }
 
     /**

diff --git a/classes/controlledVocab/Repository.php b/classes/controlledVocab/Repository.php
@@ -53,13 +53,13 @@ public function getBySymbolic(
 
         ControlledVocabEntry::query()
             ->whereHas(
-                "controlledVocab",
+                'controlledVocab',
                 fn ($query) => $query->withSymbolics([$symbolic])->withAssoc($assocType, $assocId)
             )
             ->when(!empty($locales), fn ($query) => $query->withLocales($locales))
             ->get()
-            ->each(function ($entry) use (&$result, $symbolic) {
-                foreach ($entry->{$symbolic} as $locale => $value) {
+            ->each(function ($entry) use (&$result) {
+                foreach ($entry->name as $locale => $value) {
                     $result[$locale][] = $value;
                 }
             });
@@ -98,7 +98,7 @@ public function insertBySymbolic(
                             ControlledVocabEntry::create([
                                 'controlledVocabId' => $controlledVocab->id,
                                 'seq' => $index + 1,
-                                "{$symbolic}" => [
+                                'name' => [
                                     $locale => $vocab
                                 ],
                             ]) 

diff --git a/classes/migration/upgrade/v3_5_0/I10292_UpdateControlledVocabEntrySettingName.php b/classes/migration/upgrade/v3_5_0/I10292_UpdateControlledVocabEntrySettingName.php
@@ -0,0 +1,39 @@
+<?php
+
+/**
+ * @file classes/migration/upgrade/v3_5_0/I10292_UpdateControlledVocabEntrySettingName.php
+ *
+ * Copyright (c) 2024 Simon Fraser University
+ * Copyright (c) 2024 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class I10292_UpdateControlledVocabEntrySettingName
+ *
+ * @brief update the `setting_name` from sybmolics to `name` for `controlled_vocab_entry_settings` table
+ */
+
+namespace PKP\migration\upgrade\v3_5_0;
+
+use Illuminate\Support\Facades\DB;
+use PKP\install\DowngradeNotSupportedException;
+use PKP\migration\Migration;
+
+class I10292_UpdateControlledVocabEntrySettingName extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        DB::table('controlled_vocab_entry_settings')
+            ->update(['setting_name' => 'name']);
+    }
+
+    /**
+     * Reverse the migration.
+     */
+    public function down(): void
+    {
+        throw new DowngradeNotSupportedException();
+    }
+}
diff --git a/classes/user/interest/Repository.php b/classes/user/interest/Repository.php
@@ -37,18 +37,13 @@ public function getAllInterests(?string $filter = null): array
             ->withControlledVocabId($controlledVocab->id)
             ->when(
                 $filter,
-                fn ($query) => $query->withSetting(
-                    UserInterest::CONTROLLED_VOCAB_INTEREST,
-                    $filter
-                )
+                fn ($query) => $query->withSetting('name', $filter)
             )
             ->get()
             ->sortBy(UserInterest::CONTROLLED_VOCAB_INTEREST)
             ->mapWithKeys(
                 fn(ControlledVocabEntry $controlledVocabEntry, int $id) => [
-                    $id => collect(
-                        $controlledVocabEntry->{UserInterest::CONTROLLED_VOCAB_INTEREST}
-                    )->first()
+                    $id => collect($controlledVocabEntry->name)->first()
                 ]
             )
             ->toArray();
@@ -73,9 +68,7 @@ public function getInterestsForUser(User $user): array
             ->get()
             ->mapWithKeys(
                 fn(ControlledVocabEntry $controlledVocabEntry, int $id) => [
-                    $id => collect(
-                        $controlledVocabEntry->{UserInterest::CONTROLLED_VOCAB_INTEREST}
-                    )->first()
+                    $id => collect($controlledVocabEntry->name)->first()
                 ]
             )
             ->toArray();
@@ -117,7 +110,7 @@ public function setInterestsForUser(User $user, string|array|null $interests = n
                     )
             )
             ->withLocales([''])
-            ->withSettings(UserInterest::CONTROLLED_VOCAB_INTEREST, $interests)
+            ->withSettings('name', $interests)
             ->get();
 
         // Delete user's existing interests association.
@@ -126,15 +119,15 @@ public function setInterestsForUser(User $user, string|array|null $interests = n
         $newInterestIds = collect(
                 array_diff(
                     $interests,
-                    $currentInterests->pluck(UserInterest::CONTROLLED_VOCAB_INTEREST)->flatten()->toArray()
+                    $currentInterests->pluck('name')->flatten()->toArray()
                 )
             )
             ->map(fn (string $interest): string => trim($interest))
             ->unique()
             ->map(
                 fn (string $interest) => ControlledVocabEntry::create([
                     'controlledVocabId' => $controlledVocab->id,
-                    UserInterest::CONTROLLED_VOCAB_INTEREST => [
+                    'name' => [
                         '' => $interest
                     ],
                 ])->id

diff --git a/tests/classes/form/validation/FormValidatorControlledVocabTest.php b/tests/classes/form/validation/FormValidatorControlledVocabTest.php
@@ -47,14 +47,14 @@ public function testIsValid()
 
         $controlledVocabEntryId1 = ControlledVocabEntry::create([
             'controlledVocabId' => $testControlledVocab->id,
-            ControlledVocab::CONTROLLED_VOCAB_SUBMISSION_KEYWORD => [
+            'name' => [
                 'en' => 'testEntry',
             ],
         ])->id;
 
         $controlledVocabEntryId2 = ControlledVocabEntry::create([
             'controlledVocabId' => $testControlledVocab->id,
-            ControlledVocab::CONTROLLED_VOCAB_SUBMISSION_KEYWORD => [
+            'name' => [
                 'en' => 'testEntry',
             ],
         ])->id;

diff --git a/tests/classes/metadata/MetadataPropertyTest.php b/tests/classes/metadata/MetadataPropertyTest.php
@@ -153,7 +153,7 @@ public function testValidateControlledVocabulary()
 
         $controlledVocabEntry = ControlledVocabEntry::create([
             'controlledVocabId' => $vocab->id,
-            ControlledVocab::CONTROLLED_VOCAB_SUBMISSION_KEYWORD => [
+            'name' => [
                 'en' => 'testEntry',
             ],
         ]);

diff --git a/tests/classes/validation/ValidatorControlledVocabTest.php b/tests/classes/validation/ValidatorControlledVocabTest.php
@@ -42,14 +42,14 @@ public function testValidatorControlledVocab()
 
         $controlledVocabEntryId1 = ControlledVocabEntry::create([
             'controlledVocabId' => $testControlledVocab->id,
-            ControlledVocab::CONTROLLED_VOCAB_SUBMISSION_KEYWORD => [
+            'name' => [
                 'en' => 'testEntry',
             ],
         ])->id;
 
         $controlledVocabEntryId2 = ControlledVocabEntry::create([
             'controlledVocabId' => $testControlledVocab->id,
-            ControlledVocab::CONTROLLED_VOCAB_SUBMISSION_KEYWORD => [
+            'name' => [
                 'en' => 'testEntry',
             ],
         ])->id;