MarketForm.inc.php

<?php
 
import('lib.pkp.classes.form.Form');
 
class MarketForm extends Form {
   var $_submission;
 
   var $_market;
 
   public function __construct($submission, $publication, $market) {
      parent::__construct('controllers/grid/catalogEntry/form/marketForm.tpl');
      $this->setSubmission($submission);
      $this->setPublication($publication);
      $this->setMarket($market);
 
      // Validation checks for this form
      $this->addCheck(new FormValidator($this, 'representationId', 'required', 'grid.catalogEntry.publicationFormatRequired'));
      $this->addCheck(new FormValidator($this, 'date', 'required', 'grid.catalogEntry.dateRequired'));
      $this->addCheck(new FormValidator($this, 'price', 'required', 'grid.catalogEntry.priceRequired'));
      $this->addCheck(new FormValidatorPost($this));
      $this->addCheck(new FormValidatorCSRF($this));
   }
 
   //
   // Getters and Setters
   //
   public function getMarket() {
      return $this->_market;
   }
 
   public function setMarket($market) {
      $this->_market = $market;
   }
 
   public function getSubmission() {
      return $this->_submission;
   }
 
   public function setSubmission($submission) {
      $this->_submission = $submission;
   }
 
   public function getPublication() {
      return $this->_publication;
   }
 
   public function setPublication($publication) {
      $this->_publication = $publication;
   }
 
 
   //
   // Overridden template methods
   //
   public function initData() {
      $market = $this->getMarket();
 
      if ($market) {
         $this->_data = array(
            'marketId' => $market->getId(),
            'countriesIncluded' => $market->getCountriesIncluded(),
            'countriesExcluded' => $market->getCountriesExcluded(),
            'regionsIncluded' => $market->getRegionsIncluded(),
            'regionsExcluded' => $market->getRegionsExcluded(),
            'date' => $market->getDate(),
            'dateFormat' => $market->getDateFormat(),
            'discount' => $market->getDiscount(),
            'dateRole' => $market->getDateRole(),
            'agentId' => $market->getAgentId(),
            'supplierId' => $market->getSupplierId(),
         );
      }
   }
 
   public function fetch($request, $template = null, $display = false) {
      $templateMgr = TemplateManager::getManager($request);
      $submission = $this->getSubmission();
      $templateMgr->assign('submissionId', $submission->getId());
      $templateMgr->assign('publicationId', $this->getPublication()->getId());
      $market = $this->getMarket();
      $onixCodelistItemDao = DAORegistry::getDAO('ONIXCodelistItemDAO'); /* @var $onixCodelistItemDao ONIXCodelistItemDAO */
      $templateMgr->assign(array(
         'countryCodes' => $onixCodelistItemDao->getCodes('List91'), // countries (CA, US, GB, etc)
         'regionCodes' => $onixCodelistItemDao->getCodes('List49'), // regions (British Columbia, England, etc)
         'publicationDateFormats' => $onixCodelistItemDao->getCodes('List55'), // YYYYMMDD, YYMMDD, etc
         'publicationDateRoles' => $onixCodelistItemDao->getCodes('List163'),
         'currencyCodes' => $onixCodelistItemDao->getCodes('List96'), // GBP, USD, CAD, etc
         'priceTypeCodes' => $onixCodelistItemDao->getCodes('List58'), // without tax, with tax, etc
         'extentTypeCodes' => $onixCodelistItemDao->getCodes('List23'), // word count, FM page count, BM page count, main page count, etc
         'taxRateCodes' => $onixCodelistItemDao->getCodes('List62'), // higher rate, standard rate, zero rate
         'taxTypeCodes' => $onixCodelistItemDao->getCodes('List171'), // VAT, GST
      ));
 
      $availableAgents = DAORegistry::getDAO('RepresentativeDAO')->getAgentsByMonographId($submission->getId());
      $agentOptions = array();
      while ($agent = $availableAgents->next()) {
         $agentOptions[$agent->getId()] = $agent->getName();
      }
      $templateMgr->assign('availableAgents', $agentOptions);
 
      $availableSuppliers = DAORegistry::getDAO('RepresentativeDAO')->getSuppliersByMonographId($submission->getId());
      $supplierOptions = array();
      while ($supplier = $availableSuppliers->next()) {
         $supplierOptions[$supplier->getId()] = $supplier->getName();
      }
      $templateMgr->assign('availableSuppliers', $supplierOptions);
 
      if ($market) {
         $templateMgr->assign(array(
            'marketId' => $market->getId(),
            'countriesIncluded' => $market->getCountriesIncluded(),
            'countriesExcluded' => $market->getCountriesExcluded(),
            'regionsIncluded' => $market->getRegionsIncluded(),
            'regionsExcluded' => $market->getRegionsExcluded(),
            'date' => $market->getDate(),
            'dateRole' => $market->getDateRole(),
            'dateFormat' => $market->getDateFormat(),
            'discount' => $market->getDiscount(),
            'price' => $market->getPrice(),
            'priceTypeCode' => $market->getPriceTypeCode(),
            'currencyCode' => $market->getCurrencyCode() != '' ? $market->getCurrencyCode() : 'CAD',
            'taxRateCode' => $market->getTaxRateCode(),
            'taxTypeCode' => $market->getTaxTypeCode() != '' ? $market->getTaxTypeCode() : '02',
            'agentId' => $market->getAgentId(),
            'supplierId' => $market->getSupplierId(),
         ));
 
         $representationId = $market->getPublicationFormatId();
      } else { // loading a blank form
         $representationId = (int) $request->getUserVar('representationId');
         $templateMgr->assign(array(
            'dateFormat' => '20', // YYYYMMDD Onix code as a default
            'dateRole' => '01', // 'Date of Publication' as default
            'currencyCode' => 'CAD',
         ));
      }
 
      $publicationFormatDao = DAORegistry::getDAO('PublicationFormatDAO'); /* @var $publicationFormatDao PublicationFormatDAO */
      $publicationFormat = $publicationFormatDao->getById($representationId, $this->getPublication()->getId());
 
      if ($publicationFormat) { // the format exists for this submission
         $templateMgr->assign('representationId', $representationId);
      } else {
         fatalError('Format not in authorized submission');
      }
 
      return parent::fetch($request, $template, $display);
   }
 
   public function readInputData() {
      $this->readUserVars(array(
         'marketId',
         'representationId',
         'countriesIncluded',
         'countriesExcluded',
         'regionsIncluded',
         'regionsExcluded',
         'date',
         'dateFormat',
         'dateRole',
         'discount',
         'price',
         'priceTypeCode',
         'currencyCode',
         'taxRateCode',
         'taxTypeCode',
         'agentId',
         'supplierId',
      ));
   }
 
   public function execute(...$functionArgs) {
      parent::execute(...$functionArgs);
      $marketDao = DAORegistry::getDAO('MarketDAO'); /* @var $marketDao MarketDAO */
      $publicationFormatDao = DAORegistry::getDAO('PublicationFormatDAO'); /* @var $publicationFormatDao PublicationFormatDAO */
 
      $submission = $this->getSubmission();
      $market = $this->getMarket();
      $publicationFormat = $publicationFormatDao->getById($this->getData('representationId'), $this->getPublication()->getId());
 
      if (!$market) {
         // this is a new assigned format to this published submission
         $market = $marketDao->newDataObject();
         $existingFormat = false;
         if ($publicationFormat != null) { // ensure this assigned format is in this submission
            $market->setPublicationFormatId($publicationFormat->getId());
         } else {
            fatalError('This assigned format not in authorized submission context!');
         }
      } else {
         $existingFormat = true;
         if ($publicationFormat->getId() !== $market->getPublicationFormatId()) fatalError('Invalid format!');
      }
 
      $market->setCountriesIncluded($this->getData('countriesIncluded') ? $this->getData('countriesIncluded') : array());
      $market->setCountriesExcluded($this->getData('countriesExcluded') ? $this->getData('countriesExcluded') : array());
      $market->setRegionsIncluded($this->getData('regionsIncluded') ? $this->getData('regionsIncluded') : array());
      $market->setRegionsExcluded($this->getData('regionsExcluded') ? $this->getData('regionsExcluded') : array());
      $market->setDate($this->getData('date'));
      $market->setDateFormat($this->getData('dateFormat'));
      $market->setDiscount($this->getData('discount'));
      $market->setDateRole($this->getData('dateRole'));
      $market->setPrice($this->getData('price'));
      $market->setPriceTypeCode($this->getData('priceTypeCode'));
      $market->setCurrencyCode($this->getData('currencyCode'));
      $market->setTaxRateCode($this->getData('taxRateCode'));
      $market->setTaxTypeCode($this->getData('taxTypeCode'));
      $market->setAgentId($this->getData('agentId'));
      $market->setSupplierId($this->getData('supplierId'));
 
      if ($existingFormat) {
         $marketDao->updateObject($market);
         $marketId = $market->getId();
      } else {
         $marketId = $marketDao->insertObject($market);
      }
 
      return $marketId;
   }
}