PublicationFormat.inc.php

<?php
 
import('lib.pkp.classes.submission.Representation');
 
class PublicationFormat extends Representation {
   function __construct() {
      parent::__construct();
   }
 
   function getBestId() {
      return $this->getData('urlPath')
         ? $this->getData('urlPath')
         : $this->getId();
   }
 
   function getPhysicalFormat() {
      return $this->getData('physicalFormat');
   }
 
   function setPhysicalFormat($physicalFormat) {
      return $this->setData('physicalFormat', $physicalFormat);
   }
 
   function getEntryKey() {
      return $this->getData('entryKey');
   }
 
   function setEntryKey($entryKey) {
      $this->setData('entryKey', $entryKey);
   }
 
   function getNameForONIXCode() {
      $onixCodelistItemDao = DAORegistry::getDAO('ONIXCodelistItemDAO'); /* @var $onixCodelistItemDao ONIXCodelistItemDAO */
      $codes = $onixCodelistItemDao->getCodes('List7'); // List7 is for object formats
      return $codes[$this->getEntryKey()];
   }
 
   function getCountryManufactureCode() {
      return $this->getData('countryManufactureCode');
   }
 
   function setCountryManufactureCode($countryManufactureCode) {
      return $this->setData('countryManufactureCode', $countryManufactureCode);
   }
 
   function getProductAvailabilityCode() {
      return $this->getData('productAvailabilityCode');
   }
 
   function setProductAvailabilityCode($productAvailabilityCode) {
      return $this->setData('productAvailabilityCode', $productAvailabilityCode);
   }
 
   function getHeight() {
      return $this->getData('height');
   }
 
   function setHeight($height) {
      return $this->setData('height', $height);
   }
 
   function getHeightUnitCode() {
      return $this->getData('heightUnitCode');
   }
 
   function setHeightUnitCode($heightUnitCode) {
      return $this->setData('heightUnitCode', $heightUnitCode);
   }
 
   function getWidth() {
      return $this->getData('width');
   }
 
   function setWidth($width) {
      return $this->setData('width', $width);
   }
 
   function getWidthUnitCode() {
      return $this->getData('widthUnitCode');
   }
 
   function setWidthUnitCode($widthUnitCode) {
      return $this->setData('widthUnitCode', $widthUnitCode);
   }
 
   function getThickness() {
      return $this->getData('thickness');
   }
 
   function setThickness($thickness) {
      return $this->setData('thickness', $thickness);
   }
 
   function getThicknessUnitCode() {
      return $this->getData('thicknessUnitCode');
   }
 
   function setThicknessUnitCode($thicknessUnitCode) {
      return $this->setData('thicknessUnitCode', $thicknessUnitCode);
   }
 
   function getWeight() {
      return $this->getData('weight');
   }
 
   function setWeight($weight) {
      return $this->setData('weight', $weight);
   }
 
   function getWeightUnitCode() {
      return $this->getData('weightUnitCode');
   }
 
   function setWeightUnitCode($weightUnitCode) {
      return $this->setData('weightUnitCode', $weightUnitCode);
   }
 
   function getFileSize() {
      return $this->getData('fileSize');
   }
 
   function getCalculatedFileSize() {
      $fileSize = 0;
      $publication = Services::get('publication')->get($this->getData('publicationId'));
      $submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO'); /* @var $submissionFileDao SubmissionFileDAO */
      import('lib.pkp.classes.submission.SubmissionFile'); // File constants
      $stageMonographFiles = $submissionFileDao->getLatestRevisionsByAssocId(
         ASSOC_TYPE_PUBLICATION_FORMAT, $this->getId(),
         $publication->getData('submissionId'), SUBMISSION_FILE_PROOF
      );
 
      foreach ($stageMonographFiles as $monographFile) {
         if ($monographFile->getViewable()) {
            $fileSize += (int) $monographFile->getFileSize();
         }
      }
 
      return sprintf('%d.3', $fileSize/(1024*1024)); // bytes to Mb
   }
 
   function setFileSize($fileSize) {
      return $this->setData('fileSize', $fileSize);
   }
 
   function getSalesRights() {
      $salesRightsDao = DAORegistry::getDAO('SalesRightsDAO'); /* @var $salesRightsDao SalesRightsDAO */
      return $salesRightsDao->getByPublicationFormatId($this->getId());
   }
 
   function getIdentificationCodes() {
      $identificationCodeDao = DAORegistry::getDAO('IdentificationCodeDAO'); /* @var $identificationCodeDao IdentificationCodeDAO */
      return $identificationCodeDao->getByPublicationFormatId($this->getId());
   }
 
   function getPublicationDates() {
      $publicationDateDao = DAORegistry::getDAO('PublicationDateDAO'); /* @var $publicationDateDao PublicationDateDAO */
      return $publicationDateDao->getByPublicationFormatId($this->getId());
   }
 
   function getMarkets() {
      $marketDao = DAORegistry::getDAO('MarketDAO'); /* @var $marketDao MarketDAO */
      return $marketDao->getByPublicationFormatId($this->getId());
   }
 
   function getProductFormDetailCode() {
      return $this->getData('productFormDetailCode');
   }
 
   function setProductFormDetailCode($productFormDetailCode) {
      return $this->setData('productFormDetailCode', $productFormDetailCode);
   }
 
   function getProductCompositionCode() {
      return $this->getData('productCompositionCode');
   }
 
   function setProductCompositionCode($productCompositionCode) {
      return $this->setData('productCompositionCode', $productCompositionCode);
   }
 
   function getFrontMatter() {
      return $this->getData('frontMatter');
   }
 
   function setFrontMatter($frontMatter) {
      return $this->setData('frontMatter', $frontMatter);
   }
 
   function getBackMatter() {
      return $this->getData('backMatter');
   }
 
   function setBackMatter($backMatter) {
      return $this->setData('backMatter', $backMatter);
   }
 
   function getImprint() {
      return $this->getData('imprint');
   }
 
   function setImprint($imprint) {
      return $this->setData('imprint', $imprint);
   }
 
   function getTechnicalProtectionCode() {
      return $this->getData('technicalProtectionCode');
   }
 
   function setTechnicalProtectionCode($technicalProtectionCode) {
      return $this->setData('technicalProtectionCode', $technicalProtectionCode);
   }
 
   function getReturnableIndicatorCode() {
      return $this->getData('returnableIndicatorCode');
   }
 
   function setReturnableIndicatorCode($returnableIndicatorCode) {
      return $this->setData('returnableIndicatorCode', $returnableIndicatorCode);
   }
 
   function getIsAvailable() {
      return $this->getData('isAvailable');
   }
 
   function setIsAvailable($isAvailable) {
      return $this->setData('isAvailable', $isAvailable);
   }
 
   function hasNeededONIXFields() {
      // ONIX requires one identification code and a market region with a defined price.
      $assignedIdentificationCodes = $this->getIdentificationCodes();
      $assignedMarkets = $this->getMarkets();
 
      $errors = array();
      if ($assignedMarkets->wasEmpty()) {
         $errors[] = 'monograph.publicationFormat.noMarketsAssigned';
      }
 
      if ($assignedIdentificationCodes->wasEmpty()) {
         $errors[] = 'monograph.publicationFormat.noCodesAssigned';
      }
 
      return array_merge($errors, $this->_checkRequiredFieldsAssigned());
   }
 
   function _checkRequiredFieldsAssigned() {
      $requiredFields = array('productCompositionCode' => 'grid.catalogEntry.codeRequired', 'productAvailabilityCode' => 'grid.catalogEntry.productAvailabilityRequired');
 
      $errors = array();
 
      foreach ($requiredFields as $field => $errorCode) {
         if ($this->getData($field) == '') {
            $errors[] = $errorCode;
         }
      }
 
      if (!$this->getPhysicalFormat()) {
         if (!$this->getFileSize() && !$this->getCalculatedFileSize()) {
            $errors['fileSize'] = 'grid.catalogEntry.fileSizeRequired';
         }
      }
 
      return $errors;
   }
 
   function getPressId() {
      return $this->getContextId();
   }
 
   function getDimensions() {
 
      if (!$this->getPhysicalFormat()) {
         return '';
      }
 
      $width = $this->getWidth();
      $height = $this->getHeight();
      $thickness = $this->getThickness();
 
      $dimensions = array();
      if (!empty($width)) { $dimensions[] = $width . $this->getWidthUnitCode(); }
      if (!empty($height)) { $dimensions[] = $height . $this->getHeightUnitCode(); }
      if (!empty($thickness)) { $dimensions[] = $thickness . $this->getThicknessUnitCode(); }
 
      return join( __('monograph.publicationFormat.productDimensionsSeparator'), $dimensions );
   }
}