SubmissionKeywordDAO.inc.php

<?php
 
import('lib.pkp.classes.controlledVocab.ControlledVocabDAO');
 
define('CONTROLLED_VOCAB_SUBMISSION_KEYWORD', 'submissionKeyword');
 
class SubmissionKeywordDAO extends ControlledVocabDAO {
 
   function build($publicationId, $assocType = ASSOC_TYPE_PUBLICATION) {
      // may return an array of ControlledVocabs
      return parent::_build(CONTROLLED_VOCAB_SUBMISSION_KEYWORD, $assocType, $publicationId);
   }
 
   function getLocaleFieldNames() {
      return array('submissionKeyword');
   }
 
   function getKeywords($publicationId, $locales = [], $assocType = ASSOC_TYPE_PUBLICATION) {
      $result = [];
 
      $keywords = $this->build($publicationId, $assocType);
      $submissionKeywordEntryDao = DAORegistry::getDAO('SubmissionKeywordEntryDAO'); /* @var $submissionKeywordEntryDao SubmissionKeywordEntryDAO */
      $submissionKeywords = $submissionKeywordEntryDao->getByControlledVocabId($keywords->getId());
      while ($keywordEntry = $submissionKeywords->next()) {
         $keyword = $keywordEntry->getKeyword();
         foreach ($keyword as $locale => $value) {
            if (empty($locales) || in_array($locale, $locales)) {
               if (!array_key_exists($locale, $result)) {
                  $result[$locale] = [];
               }
               $result[$locale][] = $value;
            }
         }
      }
 
      return $result;
   }
 
   function getAllUniqueKeywords() {
      $keywords = array();
 
      $result = $this->retrieve(
         'SELECT DISTINCT setting_value FROM controlled_vocab_entry_settings WHERE setting_name = ?', CONTROLLED_VOCAB_SUBMISSION_KEYWORD
      );
 
      while (!$result->EOF) {
         $keywords[] = $result->fields[0];
         $result->MoveNext();
      }
 
      $result->Close();
      return $keywords;
   }
 
   function insertKeywords($keywords, $publicationId, $deleteFirst = true, $assocType = ASSOC_TYPE_PUBLICATION) {
      $keywordDao = DAORegistry::getDAO('SubmissionKeywordDAO'); /* @var $keywordDao SubmissionKeywordDAO */
      $submissionKeywordEntryDao = DAORegistry::getDAO('SubmissionKeywordEntryDAO'); /* @var $submissionKeywordEntryDao SubmissionKeywordEntryDAO */
 
      if ($deleteFirst) {
         $currentKeywords = $this->deleteByPublicationId($publicationId);
      } else {
         $currentKeywords = $this->build($publicationId, $assocType);
      }
      if (is_array($keywords)) { // localized, array of arrays
 
         foreach ($keywords as $locale => $list) {
            if (is_array($list)) {
               $list = array_unique($list); // Remove any duplicate keywords
               $i = 1;
               foreach ($list as $keyword) {
                  $keywordEntry = $submissionKeywordEntryDao->newDataObject();
                  $keywordEntry->setControlledVocabId($currentKeywords->getId());
                  $keywordEntry->setKeyword(urldecode($keyword), $locale);
                  $keywordEntry->setSequence($i);
                  $i++;
                  $submissionKeywordEntryDao->insertObject($keywordEntry);
               }
            }
         }
      }
   }
 
   public function deleteByPublicationId($publicationId) {
      $keywordDao = DAORegistry::getDAO('SubmissionKeywordDAO'); /* @var $keywordDao SubmissionKeywordDAO */
      $submissionKeywordEntryDao = DAORegistry::getDAO('SubmissionKeywordEntryDAO'); /* @var $submissionKeywordEntryDao SubmissionKeywordEntryDAO */
      $currentKeywords = $this->build($publicationId);
 
      $existingEntries = $keywordDao->enumerate($currentKeywords->getId(), CONTROLLED_VOCAB_SUBMISSION_KEYWORD);
      foreach ($existingEntries as $id => $entry) {
         $entry = trim($entry);
         $entryObj = $submissionKeywordEntryDao->getById($id);
         $submissionKeywordEntryDao->deleteObjectById($id);
      }
 
      return $currentKeywords;
   }
 
}