controllers/tab/catalogEntry/form/CatalogEntryPublicationMetadataForm.inc.php

<?php

import('lib.pkp.classes.form.Form');

class CatalogEntryPublicationMetadataForm extends Form {

   var $_monograph;

   var $_stageId;

   var $_publicationFormatId;

   var $_isPhysicalFormat;

   var $_formParams;

   function CatalogEntryPublicationMetadataForm($monographId, $publicationFormatId, $isPhysicalFormat = true, $stageId = null, $formParams = null) {
      parent::Form('controllers/tab/catalogEntry/form/publicationMetadataFormFields.tpl');
      $monographDao =& DAORegistry::getDAO('MonographDAO');
      $this->_monograph = $monographDao->getById($monographId);

      $this->_stageId = $stageId;
      $this->_publicationFormatId = $publicationFormatId;
      $this->_isPhysicalFormat = $isPhysicalFormat;
      $this->_formParams = $formParams;

      $this->addCheck(new FormValidator($this, 'productAvailabilityCode', 'required', 'grid.catalogEntry.productAvailabilityRequired'));
      $this->addCheck(new FormValidatorRegExp($this, 'directSalesPrice', 'optional', 'grid.catalogEntry.validPriceRequired', '/^[0-9]*(\.[0-9]+)?$/'));
      $this->addCheck(new FormValidator($this, 'productCompositionCode', 'required', 'grid.catalogEntry.productCompositionRequired'));
      $this->addCheck(new FormValidatorPost($this));
   }

   function fetch(&$request) {
      $monograph =& $this->getMonograph();
      $press =& $request->getPress();

      $templateMgr =& TemplateManager::getManager();
      $templateMgr->assign('monographId', $monograph->getId());
      $templateMgr->assign('publicationFormatId', (int) $this->getPublicationFormatId());
      $templateMgr->assign('isPhysicalFormat', (int) $this->getPhysicalFormat()); // included to load format-specific template
      $templateMgr->assign('stageId', $this->getStageId());
      $templateMgr->assign('formParams', $this->getFormParams());
      $templateMgr->assign('submissionApproved', $monograph->getDatePublished());

      $onixCodelistItemDao =& DAORegistry::getDAO('ONIXCodelistItemDAO');

      // Check if e-commerce is available
      import('classes.payment.omp.OMPPaymentManager');
      $ompPaymentManager = new OMPPaymentManager($request);
      if ($ompPaymentManager->isConfigured()) {
         $templateMgr->assign('paymentConfigured', true);
         $templateMgr->assign('pressCurrency', $press->getSetting('pressCurrency'));
      }

      // get the lists associated with the select elements on these publication format forms.
      $codes = array(
         'productCompositionCodes' => 'List2', // single item, multiple item, trade-only, etc
         'measurementUnitCodes' => 'List50', // grams, inches, millimeters
         'weightUnitCodes' => 'List95', // pounds, grams, ounces
         'measurementTypeCodes' => 'List48', // height, width, depth
         'productFormDetailCodes' => 'List175', // refinement of product form (SACD, Mass market (rack) paperback, etc)
         'productAvailabilityCodes' => 'List65', // Available, In Stock, Print On Demand, Not Yet Available, etc
         'technicalProtectionCodes' => 'List144', // None, DRM, Apple DRM, etc
         'returnableIndicatorCodes' => 'List66', // No, not returnable, Yes, full copies only, (required for physical items only)
         'countriesIncludedCodes' => 'List91', // country region codes
      );

      foreach ($codes as $templateVarName => $list) {
         $templateMgr->assign_by_ref($templateVarName, $onixCodelistItemDao->getCodes($list));
      }

      // Notification options.
      $notificationRequestOptions = array(
         NOTIFICATION_LEVEL_NORMAL => array(
            NOTIFICATION_TYPE_CONFIGURE_PAYMENT_METHOD => array(ASSOC_TYPE_PRESS, $press->getId()),
            NOTIFICATION_TYPE_FORMAT_NEEDS_APPROVED_SUBMISSION => array(ASSOC_TYPE_MONOGRAPH, $monograph->getId())),
         NOTIFICATION_LEVEL_TRIVIAL => array()
      );

      $templateMgr->assign('notificationRequestOptions', $notificationRequestOptions);

      return parent::fetch($request);
   }

   function initData() {
      AppLocale::requireComponents(
         LOCALE_COMPONENT_APPLICATION_COMMON,
         LOCALE_COMPONENT_PKP_SUBMISSION,
         LOCALE_COMPONENT_OMP_SUBMISSION
      );

      $publicationFormatDao =& DAORegistry::getDAO('PublicationFormatDAO');
      $monograph =& $this->getMonograph();
      $publicationFormat =& $publicationFormatDao->getById($this->getPublicationFormatId(), $monograph->getId());
      assert($publicationFormat);

      $this->_data = array(
         'fileSize' => (boolean) $publicationFormat->getFileSize() ? $publicationFormat->getFileSize() : $publicationFormat->getCalculatedFileSize(),
         'override' => (boolean) $publicationFormat->getData('fileSize') ? true : false,
         'frontMatter' => $publicationFormat->getFrontMatter(),
         'backMatter' => $publicationFormat->getBackMatter(),
         'height' => $publicationFormat->getHeight(),
         'heightUnitCode' => $publicationFormat->getHeightUnitCode() != '' ? $publicationFormat->getHeightUnitCode() : 'mm',
         'width' => $publicationFormat->getWidth(),
         'widthUnitCode' => $publicationFormat->getWidthUnitCode() != '' ? $publicationFormat->getWidthUnitCode() : 'mm',
         'thickness' => $publicationFormat->getThickness(),
         'thicknessUnitCode' => $publicationFormat->getThicknessUnitCode() != '' ? $publicationFormat->getThicknessUnitCode() : 'mm',
         'weight' => $publicationFormat->getWeight(),
         'weightUnitCode' => $publicationFormat->getWeightUnitCode() != '' ? $publicationFormat->getWeightUnitCode() : 'gr',
         'productCompositionCode' => $publicationFormat->getProductCompositionCode(),
         'productFormDetailCode' => $publicationFormat->getProductFormDetailCode(),
         'countryManufactureCode' => $publicationFormat->getCountryManufactureCode() != '' ? $publicationFormat->getCountryManufactureCode() : 'CA',
         'imprint' => $publicationFormat->getImprint(),
         'productAvailabilityCode' => $publicationFormat->getProductAvailabilityCode() != '' ? $publicationFormat->getProductAvailabilityCode() : '20',
         'technicalProtectionCode' => $publicationFormat->getTechnicalProtectionCode() != '' ? $publicationFormat->getTechnicalProtectionCode() : '00',
         'returnableIndicatorCode' => $publicationFormat->getReturnableIndicatorCode() != '' ? $publicationFormat->getReturnableIndicatorCode() : 'Y',
         'isApproved' => (bool) $publicationFormat->getIsApproved(),
      );
   }

   function readInputData() {
      $this->readUserVars(array(
         'directSalesPrice',
         'fileSize',
         'override',
         'frontMatter',
         'backMatter',
         'height',
         'heightUnitCode',
         'width',
         'widthUnitCode',
         'thickness',
         'thicknessUnitCode',
         'weight',
         'weightUnitCode',
         'productCompositionCode',
         'productFormDetailCode',
         'countryManufactureCode',
         'imprint',
         'productAvailabilityCode',
         'technicalProtectionCode',
         'returnableIndicatorCode',
         'isApproved'
      ));
   }

   function execute(&$request) {
      parent::execute();

      $monograph =& $this->getMonograph();
      $publicationFormatDao =& DAORegistry::getDAO('PublicationFormatDAO');
      $publicationFormat =& $publicationFormatDao->getById($this->getPublicationFormatId(), $monograph->getId());
      assert($publicationFormat);

      // Manage tombstones for the publication format.
      if ($publicationFormat->getIsApproved() && !$this->getData('isApproved')) {
         // Publication format was approved and its being disabled. Create
         // a tombstone for it.
         $press =& $request->getPress();
         import('classes.publicationFormat.PublicationFormatTombstoneManager');
         $publicationFormatTombstoneMgr = new PublicationFormatTombstoneManager();
         $publicationFormatTombstoneMgr->insertTombstoneByPublicationFormat($publicationFormat, $press);

         // Log unpublish event.
         import('classes.log.MonographLog');
         MonographLog::logEvent($request, $monograph, MONOGRAPH_LOG_PUBLICATION_FORMAT_UNPUBLISH, 'submission.event.publicationFormatUnpublished', array('publicationFormatName' => $publicationFormat->getLocalizedName()));
      } elseif (!$publicationFormat->getIsApproved() && $this->getData('isApproved')) {
         // Wasn't approved and now it is. Delete tombstone.
         $tombstoneDao =& DAORegistry::getDAO('DataObjectTombstoneDAO');
         $tombstoneDao->deleteByDataObjectId($publicationFormat->getId());

         // Log publish event.
         import('classes.log.MonographLog');
         MonographLog::logEvent($request, $monograph, MONOGRAPH_LOG_PUBLICATION_FORMAT_PUBLISH, 'submission.event.publicationFormatPublished', array('publicationFormatName' => $publicationFormat->getLocalizedName()));
      }

      // populate the published monograph with the cataloging metadata
      $publicationFormat->setFileSize($this->getData('override') ? $this->getData('fileSize'):null);
      $publicationFormat->setFrontMatter($this->getData('frontMatter'));
      $publicationFormat->setBackMatter($this->getData('backMatter'));
      $publicationFormat->setHeight($this->getData('height'));
      $publicationFormat->setHeightUnitCode($this->getData('heightUnitCode'));
      $publicationFormat->setWidth($this->getData('width'));
      $publicationFormat->setWidthUnitCode($this->getData('widthUnitCode'));
      $publicationFormat->setThickness($this->getData('thickness'));
      $publicationFormat->setThicknessUnitCode($this->getData('thicknessUnitCode'));
      $publicationFormat->setWeight($this->getData('weight'));
      $publicationFormat->setWeightUnitCode($this->getData('weightUnitCode'));
      $publicationFormat->setProductCompositionCode($this->getData('productCompositionCode'));
      $publicationFormat->setProductFormDetailCode($this->getData('productFormDetailCode'));
      $publicationFormat->setCountryManufactureCode($this->getData('countryManufactureCode'));
      $publicationFormat->setImprint($this->getData('imprint'));
      $publicationFormat->setProductAvailabilityCode($this->getData('productAvailabilityCode'));
      $publicationFormat->setTechnicalProtectionCode($this->getData('technicalProtectionCode'));
      $publicationFormat->setReturnableIndicatorCode($this->getData('returnableIndicatorCode'));
      $publicationFormat->setIsApproved($this->getData('isApproved')?true:false);

      $publicationFormatDao->updateObject($publicationFormat);
   }

   //
   // Getters and Setters
   //
   function &getMonograph() {
      return $this->_monograph;
   }

   function getStageId() {
      return $this->_stageId;
   }

   function getPhysicalFormat() {
      return $this->_isPhysicalFormat;
   }
   function getPublicationFormatId() {
      return $this->_publicationFormatId;
   }

   function getFormParams() {
      return $this->_formParams;
   }
}

?>