PublicationFormatMetadataForm.inc.php

<?php
 
import('lib.pkp.classes.form.Form');
import('lib.pkp.classes.plugins.PKPPubIdPluginHelper');
 
class PublicationFormatMetadataForm extends Form {
 
   var $_submission;
 
   var $_publication;
 
   var $_stageId;
 
   var $_publicationFormat;
 
   var $_pubIdPluginHelper;
 
   var $_isPhysicalFormat;
 
   var $_remoteURL;
 
   var $_formParams;
 
   public function __construct($submission, $publication, $representation, $isPhysicalFormat = true, $remoteURL = null, $stageId = null, $formParams = null) {
      parent::__construct('controllers/tab/catalogEntry/form/publicationMetadataFormFields.tpl');
      $this->_submission = $submission;
      $this->_publication = $publication;
      $this->_publicationFormat = $representation;
 
      if (!$this->_submission || !$this->_publication || !$this->_publicationFormat) {
         throw new Exception('PublicationFormatMetadataForm was instantiated without required dependencies.');
      }
 
      $this->_pubIdPluginHelper = new PKPPubIdPluginHelper();
 
      $this->_stageId = $stageId;
      $this->_isPhysicalFormat = $isPhysicalFormat;
      $this->_remoteURL = $remoteURL;
      $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));
      $this->addCheck(new FormValidatorCSRF($this));
   }
 
   public function fetch($request, $template = null, $display = false) {
      $publicationFormat = $this->getPublicationFormat();
      $context = $request->getContext();
 
      $templateMgr = TemplateManager::getManager($request);
      $templateMgr->assign('submissionId', $this->getSubmission()->getId());
      $templateMgr->assign('publicationId', $this->getPublication()->getId());
      $templateMgr->assign('representationId', (int) $publicationFormat->getId());
 
      // included to load format-specific templates
      $templateMgr->assign('isPhysicalFormat', (bool) $this->getPhysicalFormat());
      $templateMgr->assign('remoteURL', $this->getRemoteURL());
 
      $templateMgr->assign('stageId', $this->getStageId());
      $templateMgr->assign('formParams', $this->getFormParams());
 
      $onixCodelistItemDao = DAORegistry::getDAO('ONIXCodelistItemDAO'); /* @var $onixCodelistItemDao ONIXCodelistItemDAO */
 
      // Check if e-commerce is available
      $paymentManager = Application::getPaymentManager($context);
      if ($paymentManager->isConfigured()) {
         $templateMgr->assign('paymentConfigured', true);
         $templateMgr->assign('currency', $context->getSetting('currency'));
      }
 
      // 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($templateVarName, $onixCodelistItemDao->getCodes($list));
      }
 
      // consider public identifiers
      $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true);
      $templateMgr->assign('pubIdPlugins', $pubIdPlugins);
      $templateMgr->assign('pubObject', $publicationFormat);
 
      $templateMgr->assign('notificationRequestOptions', array(
         NOTIFICATION_LEVEL_NORMAL => array(
            NOTIFICATION_TYPE_CONFIGURE_PAYMENT_METHOD => array(ASSOC_TYPE_PRESS, $context->getId()),
         ),
         NOTIFICATION_LEVEL_TRIVIAL => array()
      ));
 
      return parent::fetch($request, $template, $display);
   }
 
   public function initData() {
      AppLocale::requireComponents(
         LOCALE_COMPONENT_APP_COMMON,
         LOCALE_COMPONENT_PKP_SUBMISSION,
         LOCALE_COMPONENT_APP_SUBMISSION
      );
 
      $submission = $this->getSubmission();
      $publicationFormat = $this->getPublicationFormat();
 
      $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',
         // the pubId plugin needs the format object.
         'publicationFormat' => $publicationFormat
      );
 
      // initialize the pubId fields.
      $pubIdPluginHelper = $this->_getPubIdPluginHelper();
      $pubIdPluginHelper->init($submission->getContextId(), $this, $publicationFormat);
      $pubIdPluginHelper->setLinkActions($submission->getContextId(), $this, $publicationFormat);
 
   }
 
   public function readInputData() {
      $submission = $this->getSubmission();
      $this->readUserVars(array(
         'directSalesPrice',
         'fileSize',
         'override',
         'frontMatter',
         'backMatter',
         'height',
         'heightUnitCode',
         'width',
         'widthUnitCode',
         'thickness',
         'thicknessUnitCode',
         'weight',
         'weightUnitCode',
         'productCompositionCode',
         'productFormDetailCode',
         'countryManufactureCode',
         'imprint',
         'productAvailabilityCode',
         'technicalProtectionCode',
         'returnableIndicatorCode',
      ));
 
      // consider the additional field names from the public identifer plugins
      $pubIdPluginHelper = $this->_getPubIdPluginHelper();
      $pubIdPluginHelper->readInputData($submission->getContextId(), $this);
 
   }
 
   public function validate($callHooks = true) {
      $submission = $this->getSubmission();
      $publicationFormat = $this->getPublicationFormat();
      $pubIdPluginHelper = $this->_getPubIdPluginHelper();
      $pubIdPluginHelper->validate($submission->getContextId(), $this, $publicationFormat);
      return parent::validate($callHooks);
   }
 
   public function execute(...$functionArgs) {
      parent::execute(...$functionArgs);
 
      $submission = $this->getSubmission();
      $publicationFormat = $this->getPublicationFormat();
 
      // populate the published submission 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'));
 
      // consider the additional field names from the public identifer plugins
      $pubIdPluginHelper = $this->_getPubIdPluginHelper();
      $pubIdPluginHelper->execute($submission->getContextId(), $this, $publicationFormat);
 
      $publicationFormatDao = DAORegistry::getDAO('PublicationFormatDAO'); /* @var $publicationFormatDao PublicationFormatDAO */
      $publicationFormatDao->updateObject($publicationFormat);
   }
 
   //
   // Getters and Setters
   //
   public function getSubmission() {
      return $this->_submission;
   }
 
   public function getPublication() {
      return $this->_publication;
   }
 
   public function getStageId() {
      return $this->_stageId;
   }
 
   public function getPhysicalFormat() {
      return $this->_isPhysicalFormat;
   }
 
   public function getRemoteURL() {
      return $this->_remoteURL;
   }
 
   public function getPublicationFormat() {
      return $this->_publicationFormat;
   }
 
   public function getFormParams() {
      return $this->_formParams;
   }
 
   public function _getPubIdPluginHelper() {
      return $this->_pubIdPluginHelper;
   }
}