SeriesDAO.inc.php

<?php
 
import ('classes.press.Series');
import ('lib.pkp.classes.context.PKPSectionDAO');
 
class SeriesDAO extends PKPSectionDAO {
   function getById($seriesId, $pressId = null) {
      $params = array((int) $seriesId);
      if ($pressId) $params[] = (int) $pressId;
 
      $result = $this->retrieve(
         'SELECT  *
         FROM  series
         WHERE series_id = ?
         ' . ($pressId?' AND press_id = ?':''),
         $params
      );
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
 
      $result->Close();
      return $returner;
   }
 
   function getByPath($path, $pressId) {
      $result = $this->retrieve(
         'SELECT * FROM series WHERE path = ? AND press_id = ?',
         array((string) $path, (int) $pressId)
      );
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
 
      $result->Close();
      return $returner;
   }
 
   function newDataObject() {
      return new Series();
   }
 
   function _fromRow($row) {
      $series = parent::_fromRow($row);
 
      $series->setId($row['series_id']);
      $series->setPressId($row['press_id']);
      $series->setFeatured($row['featured']);
      $series->setImage(unserialize($row['image']));
      $series->setPath($row['path']);
      $series->setIsInactive($row['is_inactive']);
 
      $this->getDataObjectSettings('series_settings', 'series_id', $row['series_id'], $series);
 
      HookRegistry::call('SeriesDAO::_fromRow', array(&$series, &$row));
 
      return $series;
   }
 
   function getLocaleFieldNames() {
      return array_merge(
         parent::getLocaleFieldNames(),
         array('description', 'prefix', 'subtitle')
      );
   }
 
   function getAdditionalFieldNames() {
      return array_merge(
         parent::getAdditionalFieldNames(),
         array(
            'onlineIssn', 'printIssn', 'sortOption',
         )
      );
   }
 
   function updateLocaleFields($series) {
      $this->updateDataObjectSettings(
         'series_settings',
         $series,
         array('series_id' => (int) $series->getId())
      );
   }
 
   function insertObject($series) {
      $this->update(
         'INSERT INTO series
            (press_id, seq, featured, path, image, editor_restricted, is_inactive)
         VALUES
            (?, ?, ?, ?, ?, ?, ?)',
         array(
            (int) $series->getPressId(),
            (float) $series->getSequence(),
            (int) $series->getFeatured(),
            (string) $series->getPath(),
            serialize($series->getImage() ? $series->getImage() : array()),
            (int) $series->getEditorRestricted(),
            (int) $series->getIsInactive() ? 1 : 0,
         )
      );
 
      $series->setId($this->getInsertId());
      $this->updateLocaleFields($series);
      return $series->getId();
   }
 
   function updateObject($series) {
      $this->update(
         'UPDATE series
         SET   press_id = ?,
            seq = ?,
            featured = ?,
            path = ?,
            image = ?,
            editor_restricted = ?,
            is_inactive = ?
         WHERE series_id = ?',
         array(
            (int) $series->getPressId(),
            (float) $series->getSequence(),
            (int) $series->getFeatured(),
            (string) $series->getPath(),
            serialize($series->getImage() ? $series->getImage() : array()),
            (int) $series->getEditorRestricted(),
            (int) $series->getIsInactive(),
            (int) $series->getId(),
         )
      );
      $this->updateLocaleFields($series);
   }
 
   function deleteById($seriesId, $contextId = null) {
      // Validate the $contextId, if supplied.
      if (!$this->seriesExists($seriesId, $contextId)) return false;
 
      $subEditorsDao = DAORegistry::getDAO('SubEditorsDAO'); /* @var $subEditorsDao SubEditorsDAO */
      $subEditorsDao->deleteBySubmissionGroupId($seriesId, ASSOC_TYPE_SECTION, $contextId);
 
      // Remove monographs from this series
      $submissionsIterator = Services::get('submission')->getMany(['seriesIds' => $seriesId, 'count' => 1000]);
      foreach ($submissionsIterator as $submission) {
         foreach ((array) $submission->getData('publications') as $publication) {
            Services::get('publication')->edit($publication, ['seriesId' => 0]);
         }
      }
 
      // Delete the series and settings.
      $this->update('DELETE FROM series WHERE series_id = ?', (int) $seriesId);
      $this->update('DELETE FROM series_settings WHERE series_id = ?', (int) $seriesId);
   }
 
   function deleteByPressId($pressId) {
      $this->deleteByContextId($pressId);
   }
 
   function getByPressId($pressId, $rangeInfo = null) {
      return $this->getByContextId($pressId, $rangeInfo);
   }
 
   function getByContextId($pressId, $rangeInfo = null, $submittableOnly = false) {
      $params = array(
         'title', AppLocale::getPrimaryLocale(),
         'title', AppLocale::getLocale(),
         (int) $pressId
      );
 
      $result = $this->retrieveRange(
         'SELECT s.*, COALESCE(stpl.setting_value, stl.setting_value) AS series_title FROM series s
         LEFT JOIN series_settings stpl ON (s.series_id = stpl.series_id AND stpl.setting_name = ? AND stpl.locale = ?)
         LEFT JOIN series_settings stl ON (s.series_id = stl.series_id AND stl.setting_name = ? AND stl.locale = ?)
         WHERE press_id = ?
         ORDER BY seq',
         $params,
         $rangeInfo
      );
 
      return new DAOResultFactory($result, $this, '_fromRow');
   }
 
   function getTitlesByPressId($pressId, $submittableOnly = false) {
      $seriesTitles = array();
 
      $seriesIterator = $this->getByPressId($pressId, null);
      while ($series = $seriesIterator->next()) {
         if ($submittableOnly) {
            if (!$series->getEditorRestricted()) {
               $seriesTitles[$series->getId()] = $series->getLocalizedTitle();
            }
         } else {
            $seriesTitles[$series->getId()] = $series->getLocalizedTitle();
         }
      }
 
      return $seriesTitles;
   }
 
   function seriesExists($seriesId, $pressId) {
      $result = $this->retrieve(
         'SELECT COUNT(*) FROM series WHERE series_id = ? AND press_id = ?',
         array((int) $seriesId, (int) $pressId)
      );
      $returner = isset($result->fields[0]) && $result->fields[0] == 1 ? true : false;
 
      $result->Close();
      return $returner;
   }
 
   function getInsertId() {
      return $this->_getInsertId('series', 'series_id');
   }
 
   function addCategory($seriesId, $categoryId) {
      $this->update(
         'INSERT INTO series_categories
            (series_id, category_id)
         VALUES
            (?, ?)',
         array(
            (int) $seriesId,
            (int) $categoryId
         )
      );
   }
 
   public function removeCategories($seriesId) {
      $this->update(
         'DELETE FROM series_categories WHERE series_id = ?',
         array((int) $seriesId)
      );
   }
 
   function getCategories($seriesId, $pressId = null) {
      $params = array((int) $seriesId);
      if ($pressId) $params[] = (int) $pressId;
 
      $categoryDao = DAORegistry::getDAO('CategoryDAO'); /* @var $categoryDao CategoryDAO */
      $result = $this->retrieve(
         'SELECT  c.*
         FROM  categories c,
            series_categories sc,
            series s
         WHERE c.category_id = sc.category_id AND
            s.series_id = ? AND
            ' . ($pressId?' c.context_id = s.press_id AND s.press_id = ? AND':'') . '
            s.series_id = sc.series_id',
         $params
      );
 
      // Delegate category creation to the category DAO.
      return new DAOResultFactory($result, $categoryDao, '_fromRow');
   }
 
   function getUnassignedCategories($seriesId, $pressId = null) {
      $params = array((int) $seriesId);
      if ($pressId) $params[] = (int) $pressId;
 
      $categoryDao = DAORegistry::getDAO('CategoryDAO'); /* @var $categoryDao CategoryDAO */
      $result = $this->retrieve(
         'SELECT  c.*
         FROM  series s
            JOIN categories c ON (c.context_id = s.press_id)
            LEFT JOIN series_categories sc ON (s.series_id = sc.series_id AND sc.category_id = c.category_id)
         WHERE s.series_id = ? AND
            ' . ($pressId?' s.press_id = ? AND':'') . '
            sc.series_id IS NULL',
         $params
      );
 
      // Delegate category creation to the category DAO.
      return new DAOResultFactory($result, $categoryDao, '_fromRow');
   }
 
   function categoryAssociationExists($seriesId, $categoryId) {
      $result = $this->retrieve(
         'SELECT COUNT(*) FROM series_categories WHERE series_id = ? AND category_id = ?',
         array((int) $seriesId, (int) $categoryId)
      );
      $returner = isset($result->fields[0]) && $result->fields[0] == 1 ? true : false;
 
      $result->Close();
      return $returner;
   }
}