PublicationFormatDAO.inc.php

<?php
import('classes.publicationFormat.PublicationFormat');
import('lib.pkp.classes.submission.RepresentationDAO');
import('lib.pkp.classes.plugins.PKPPubIdPluginDAO');
 
class PublicationFormatDAO extends RepresentationDAO implements PKPPubIdPluginDAO {
   function getById($representationId, $publicationId = null, $contextId = null) {
      $params = array((int) $representationId);
      if ($publicationId) $params[] = (int) $publicationId;
      if ($contextId) $params[] = (int) $contextId;
 
      $result = $this->retrieve(
         'SELECT pf.*
         FROM  publication_formats pf
         ' . ($contextId?'
            JOIN publications p ON (p.publication_id = pf.publicationId)
            JOIN submissions s ON (s.submission_id=p.submission_id)':'') . '
         WHERE pf.publication_format_id=?' .
         ($publicationId?' AND pf.publication_id = ?':'') .
         ($contextId?' AND s.context_id = ?':''),
         $params
      );
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
 
      $result->Close();
      return $returner;
   }
 
   function getBySetting($settingName, $settingValue, $publicationId = null, $pressId = null) {
      $params = array($settingName);
 
 
      $sql = 'SELECT pf.*
         FROM  publication_formats pf ';
      if ($pressId) {
         $sql .= 'INNER JOIN publications p ON p.publication_id = pf.publication_id
         INNER JOIN submissions s ON s.submission_id = p.submission_id ';
      }
      if (is_null($settingValue)) {
         $sql .= 'LEFT JOIN publication_format_settings pfs ON pf.publication_format_id = pfs.publication_format_id AND pfs.setting_name = ?
            WHERE (pfs.setting_value IS NULL OR pfs.setting_value = \'\')';
      } else {
         $params[] = (string) $settingValue;
         $sql .= 'INNER JOIN publication_format_settings pfs ON pf.publication_format_id = pfs.publication_format_id
            WHERE pfs.setting_name = ? AND pfs.setting_value = ?';
      }
 
      if ($publicationId) {
         $params[] = (int) $publicationId;
         $sql .= ' AND pf.publication_id = ?';
      }
 
      if ($pressId) {
         $params[] = (int) $pressId;
         $sql .= ' AND s.context_id = ?';
      }
 
      $orderByContextId = $pressId ? 's.context_id, ' : '';
      $sql .= ' ORDER BY ' . $orderByContextId . 'pf.seq, pf.publication_format_id';
      $result = $this->retrieve($sql, $params);
 
      $publicationFormats = array();
      while (!$result->EOF) {
         $publicationFormats[] = $this->_fromRow($result->GetRowAssoc(false));
         $result->MoveNext();
      }
      $result->Close();
 
      return $publicationFormats;
   }
 
   function getByPubId($pubIdType, $pubId, $publicationId = null, $pressId = null) {
      $publicationFormat = null;
      if (!empty($pubId)) {
         $publicationFormats = $this->getBySetting('pub-id::'.$pubIdType, $pubId, $publicationId, $pressId);
         if (!empty($publicationFormats)) {
            assert(count($publicationFormats) == 1);
            $publicationFormat = $publicationFormats[0];
         }
      }
      return $publicationFormat;
   }
 
   function getByBestId($representationId, $publicationId) {
 
      $result = $this->retrieve(
         'SELECT pf.*
         FROM  publication_formats pf
         WHERE pf.url_path = ?
            AND pf.publication_id = ?',
         [
            $representationId,
            $publicationId,
         ]
      );
 
      if ($result->RecordCount() != 0) {
         $publicationFormat = $this->_fromRow($result->GetRowAssoc(false));
      } elseif (is_int($representationId) || ctype_digit($representationId)) {
         $publicationFormat = $this->getById($representationId);
      }
      $result->Close();
 
      return $publicationFormat ?? null;
   }
 
   function getByPublicationId($publicationId, $contextId = null) {
      $params = array((int) $publicationId);
      if ($contextId) $params[] = (int) $contextId;
 
      return new DAOResultFactory(
         $this->retrieve(
            'SELECT pf.*
            FROM  publication_formats pf ' .
            ($contextId ?
               'INNER JOIN publications p ON (pf.publication_id=p.publication_id)
                INNER JOIN submissions s ON (s.submission_id = p.submission_id) '
               : '') .
            'WHERE pf.publication_id=? '
            . ($contextId?' AND s.context_id = ? ':'')
            . 'ORDER BY pf.seq',
            $params
         ),
         $this,
         '_fromRow'
      );
   }
 
   function getByContextId($pressId) {
      $params = array((int) $pressId);
      $result = $this->retrieve(
         'SELECT pf.*
         FROM  publication_formats pf
         JOIN  publications p ON (p.publication_id = pf.publication_id)
         JOIN  submissions s ON (s.submission_id = p.submission_id)
         WHERE s.context_id = ?
         ORDER BY pf.seq',
         $params
      );
 
      return new DAOResultFactory($result, $this, '_fromRow');
   }
 
   function getApprovedByPublicationId($publicationId) {
      $params = array((int) $publicationId);
 
      $result = $this->retrieve(
         'SELECT *
         FROM  publication_formats
         WHERE publication_id = ? AND is_approved=1
         ORDER BY seq',
         $params
      );
 
      return new DAOResultFactory($result, $this, '_fromRow');
   }
 
   function deleteById($representationId) {
      // remove settings, then the association itself.
      $this->update('DELETE FROM publication_format_settings WHERE publication_format_id = ?', (int) $representationId);
      return $this->update('DELETE FROM publication_formats WHERE publication_format_id = ?', (int) $representationId);
   }
 
   function updateLocaleFields($publicationFormat) {
      $this->updateDataObjectSettings(
         'publication_format_settings',
         $publicationFormat,
         array('publication_format_id' => $publicationFormat->getId())
      );
   }
 
   function newDataObject() {
      return new PublicationFormat();
   }
 
   function _fromRow($row, $params = array(), $callHooks = true) {
      $publicationFormat = $this->newDataObject();
 
      // Add the additional Publication Format data
      $publicationFormat->setIsApproved($row['is_approved']);
      $publicationFormat->setEntryKey($row['entry_key']);
      $publicationFormat->setPhysicalFormat($row['physical_format']);
      $publicationFormat->setSequence((int) $row['seq']);
      $publicationFormat->setId((int) $row['publication_format_id']);
      $publicationFormat->setData('publicationId', (int) $row['publication_id']);
      $publicationFormat->setFileSize($row['file_size']);
      $publicationFormat->setFrontMatter($row['front_matter']);
      $publicationFormat->setBackMatter($row['back_matter']);
      $publicationFormat->setHeight($row['height']);
      $publicationFormat->setHeightUnitCode($row['height_unit_code']);
      $publicationFormat->setWidth($row['width']);
      $publicationFormat->setWidthUnitCode($row['width_unit_code']);
      $publicationFormat->setThickness($row['thickness']);
      $publicationFormat->setThicknessUnitCode($row['thickness_unit_code']);
      $publicationFormat->setWeight($row['weight']);
      $publicationFormat->setWeightUnitCode($row['weight_unit_code']);
      $publicationFormat->setProductCompositionCode($row['product_composition_code']);
      $publicationFormat->setProductFormDetailCode($row['product_form_detail_code']);
      $publicationFormat->setCountryManufactureCode($row['country_manufacture_code']);
      $publicationFormat->setImprint($row['imprint']);
      $publicationFormat->setProductAvailabilityCode($row['product_availability_code']);
      $publicationFormat->setTechnicalProtectionCode($row['technical_protection_code']);
      $publicationFormat->setReturnableIndicatorCode($row['returnable_indicator_code']);
      $publicationFormat->setRemoteURL($row['remote_url']);
      $publicationFormat->setData('urlPath', $row['url_path']);
      $publicationFormat->setIsAvailable($row['is_available']);
 
      $this->getDataObjectSettings(
         'publication_format_settings',
         'publication_format_id',
         $row['publication_format_id'],
         $publicationFormat
      );
 
      if ($callHooks) HookRegistry::call('PublicationFormatDAO::_fromRow', array(&$publicationFormat, &$row));
 
      return $publicationFormat;
   }
 
   function insertObject($publicationFormat) {
      $this->update(
         'INSERT INTO publication_formats
            (is_approved, entry_key, physical_format, publication_id, seq, file_size, front_matter, back_matter, height, height_unit_code, width, width_unit_code, thickness, thickness_unit_code, weight, weight_unit_code, product_composition_code, product_form_detail_code, country_manufacture_code, imprint, product_availability_code, technical_protection_code, returnable_indicator_code, remote_url, url_path, is_available)
         VALUES
            (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)',
         array(
            (int) $publicationFormat->getIsApproved(),
            $publicationFormat->getEntryKey(),
            (int) $publicationFormat->getPhysicalFormat(),
            (int) $publicationFormat->getData('publicationId'),
            (int) $publicationFormat->getSequence(),
            $publicationFormat->getFileSize(),
            $publicationFormat->getFrontMatter(),
            $publicationFormat->getBackMatter(),
            $publicationFormat->getHeight(),
            $publicationFormat->getHeightUnitCode(),
            $publicationFormat->getWidth(),
            $publicationFormat->getWidthUnitCode(),
            $publicationFormat->getThickness(),
            $publicationFormat->getThicknessUnitCode(),
            $publicationFormat->getWeight(),
            $publicationFormat->getWeightUnitCode(),
            $publicationFormat->getProductCompositionCode(),
            $publicationFormat->getProductFormDetailCode(),
            $publicationFormat->getCountryManufactureCode(),
            $publicationFormat->getImprint(),
            $publicationFormat->getProductAvailabilityCode(),
            $publicationFormat->getTechnicalProtectionCode(),
            $publicationFormat->getReturnableIndicatorCode(),
            $publicationFormat->getRemoteURL(),
            $publicationFormat->getData('urlPath'),
            (int) $publicationFormat->getIsAvailable(),
         )
      );
 
      $publicationFormat->setId($this->_getInsertId('publication_formats', 'publication_format_id'));
      $this->updateLocaleFields($publicationFormat);
 
      return $publicationFormat->getId();
   }
 
   function updateObject($publicationFormat) {
      $this->update(
         'UPDATE publication_formats
         SET   is_approved = ?,
            entry_key = ?,
            physical_format = ?,
            seq = ?,
            file_size = ?,
            front_matter = ?,
            back_matter = ?,
            height = ?,
            height_unit_code = ?,
            width = ?,
            width_unit_code = ?,
            thickness = ?,
            thickness_unit_code = ?,
            weight = ?,
            weight_unit_code = ?,
            product_composition_code = ?,
            product_form_detail_code = ?,
            country_manufacture_code = ?,
            imprint = ?,
            product_availability_code = ?,
            technical_protection_code = ?,
            returnable_indicator_code = ?,
            remote_url = ?,
            url_path = ?,
            is_available = ?
         WHERE publication_format_id = ?',
         array(
            (int) $publicationFormat->getIsApproved(),
            $publicationFormat->getEntryKey(),
            (int) $publicationFormat->getPhysicalFormat(),
            (int) $publicationFormat->getSequence(),
            $publicationFormat->getFileSize(),
            $publicationFormat->getFrontMatter(),
            $publicationFormat->getBackMatter(),
            $publicationFormat->getHeight(),
            $publicationFormat->getHeightUnitCode(),
            $publicationFormat->getWidth(),
            $publicationFormat->getWidthUnitCode(),
            $publicationFormat->getThickness(),
            $publicationFormat->getThicknessUnitCode(),
            $publicationFormat->getWeight(),
            $publicationFormat->getWeightUnitCode(),
            $publicationFormat->getProductCompositionCode(),
            $publicationFormat->getProductFormDetailCode(),
            $publicationFormat->getCountryManufactureCode(),
            $publicationFormat->getImprint(),
            $publicationFormat->getProductAvailabilityCode(),
            $publicationFormat->getTechnicalProtectionCode(),
            $publicationFormat->getReturnableIndicatorCode(),
            $publicationFormat->getRemoteURL(),
            $publicationFormat->getData('urlPath'),
            (int) $publicationFormat->getIsAvailable(),
            (int) $publicationFormat->getId()
         )
      );
 
      $this->updateLocaleFields($publicationFormat);
   }
 
   function getLocaleFieldNames() {
      return array('name');
   }
 
   function getAdditionalFieldNames() {
      $additionalFields = parent::getAdditionalFieldNames();
      $additionalFields[] = 'pub-id::publisher-id';
      return $additionalFields;
   }
 
   function pubIdExists($pubIdType, $pubId, $excludePubObjectId, $contextId) {
      $result = $this->retrieve(
         'SELECT COUNT(*)
         FROM publication_format_settings pft
         INNER JOIN publication_formats pf ON pft.publication_format_id = pf.publication_format_id
         INNER JOIN publications p ON p.publication_id = pf.publication_id
         INNER JOIN submissions s ON p.submission_id = s.submission_id
         WHERE pft.setting_name = ?
         AND pft.setting_value = ?
         AND pf.publication_format_id <> ?
         AND s.context_id = ?',
         array(
            'pub-id::'.$pubIdType,
            $pubId,
            (int) $excludePubObjectId,
            (int) $contextId
         )
      );
      $returner = $result->fields[0] ? true : false;
      $result->Close();
      return $returner;
   }
 
   function changePubId($pubObjectId, $pubIdType, $pubId) {
      $idFields = array(
            'publication_format_id', 'locale', 'setting_name'
      );
      $updateArray = array(
            'publication_format_id' => (int) $pubObjectId,
            'locale' => '',
            'setting_name' => 'pub-id::'.$pubIdType,
            'setting_type' => 'string',
            'setting_value' => (string)$pubId
      );
      $this->replace('publication_format_settings', $updateArray, $idFields);
   }
 
   function deletePubId($pubObjectId, $pubIdType) {
      $settingName = 'pub-id::'.$pubIdType;
      $this->update(
         'DELETE FROM publication_format_settings WHERE setting_name = ? AND publication_format_id = ?',
         array(
            $settingName,
            (int)$pubObjectId
         )
      );
      $this->flushCache();
   }
 
   function deleteAllPubIds($contextId, $pubIdType) {
      $settingName = 'pub-id::'.$pubIdType;
 
      $formats = $this->getByContextId($contextId);
      while ($format = $formats->next()) {
         $this->update(
            'DELETE FROM publication_format_settings WHERE setting_name = ? AND publication_format_id = ?',
            array(
               $settingName,
               (int)$format->getId()
            )
         );
      }
      $this->flushCache();
   }
}