pkp#10292 fixing unit tests

touhidurabir · Aug 20, 2024 · 1463f2d · 1463f2d
1 parent 4845517
commit 1463f2d
Show file tree

Hide file tree

Showing 9 changed files with 91 additions and 544 deletions.
diff --git a/classes/controlledVocab/ControlledVocab.php b/classes/controlledVocab/ControlledVocab.php
@@ -1,7 +1,4 @@
 <?php
-/**
- * @defgroup controlled_vocab Controlled Vocabulary
- */
 
 /**
  * @file classes/controlledVocab/ControlledVocab.php
@@ -12,7 +9,7 @@
  *
  * @class ControlledVocab
  *
- * @brief 
+ * @brief ControlledVocab model class
  */
 
 namespace PKP\controlledVocab;

diff --git a/classes/controlledVocab/ControlledVocabDAO.php b/classes/controlledVocab/ControlledVocabDAO.php
diff --git a/classes/controlledVocab/Repository.php b/classes/controlledVocab/Repository.php
@@ -1,5 +1,17 @@
 <?php
 
+/**
+ * @file classes/controlledVocab/Repository.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 Repository
+ *
+ * @brief A repository to manage actions related to controlled vocab
+ */
+
 namespace PKP\controlledVocab;
 
 use APP\facades\Repo;
@@ -38,11 +50,20 @@ public function getEntryDAO(): ControlledVocabEntryDAO
         return DAORegistry::getDAO('ControlledVocabEntryDAO');
     }
 
+    /**
+     * Return the extended Controlled Vocab Entry DAO.
+     * Can be subclassed to provide extended DAOs.
+     * 
+     * Will be removed once the eloquent based settings table relations task completes.
+     */
     public function getEntryDaoBySymbolic(string $symbolic): ControlledVocabEntryDAO
     {
         return DAORegistry::getDAO(ucfirst($symbolic) . 'EntryDAO');
     }
 
+    /**
+     * Get localized entry data
+     */
     public function getBySymbolic(
         string $symbolic,
         int $assocType,