SalesRightsForm.inc.php

<?php
 
import('lib.pkp.classes.form.Form');
 
class SalesRightsForm extends Form {
   var $_submission;
 
   var $_salesRights;
 
   public function __construct($submission, $publication, $salesRights) {
      parent::__construct('controllers/grid/catalogEntry/form/salesRightsForm.tpl');
      $this->setSubmission($submission);
      $this->setPublication($publication);
      $this->setSalesRights($salesRights);
 
      // Validation checks for this form
      $form = $this;
      $this->addCheck(new FormValidator($this, 'type', 'required', 'grid.catalogEntry.typeRequired'));
      $this->addCheck(new FormValidator($this, 'representationId', 'required', 'grid.catalogEntry.publicationFormatRequired'));
      $this->addCheck(new FormValidatorCustom(
         $this, 'ROWSetting', 'optional', 'grid.catalogEntry.oneROWPerFormat',
         function($ROWSetting) use ($form, $salesRights) {
            $salesRightsDao = DAORegistry::getDAO('SalesRightsDAO'); /* @var $salesRightsDao SalesRightsDAO */
            $pubFormatId = $form->getData('representationId');
            return $ROWSetting == '' || $salesRightsDao->getROWByPublicationFormatId($pubFormatId) == null ||
               ($salesRights != null && $salesRightsDao->getROWByPublicationFormatId($pubFormatId)->getId() == $salesRights->getId());
         }
      ));
 
      $this->addCheck(new FormValidatorPost($this));
      $this->addCheck(new FormValidatorCSRF($this));
   }
 
   //
   // Getters and Setters
   //
   public function getSalesRights() {
      return $this->_salesRights;
   }
 
   public function setSalesRights($salesRights) {
      $this->_salesRights = $salesRights;
   }
 
   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() {
      $salesRights = $this->getSalesRights();
 
      if ($salesRights) {
         $this->_data = array(
            'salesRightsId' => $salesRights->getId(),
            'type' => $salesRights->getType(),
            'ROWSetting' => $salesRights->getROWSetting(),
            'countriesIncluded' => $salesRights->getCountriesIncluded(),
            'countriesExcluded' => $salesRights->getCountriesExcluded(),
            'regionsIncluded' => $salesRights->getRegionsIncluded(),
            'regionsExcluded' => $salesRights->getRegionsExcluded(),
         );
      }
   }
 
   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());
      $salesRights = $this->getSalesRights();
      $onixCodelistItemDao = DAORegistry::getDAO('ONIXCodelistItemDAO'); /* @var $onixCodelistItemDao ONIXCodelistItemDAO */
      $templateMgr->assign('countryCodes', $onixCodelistItemDao->getCodes('List91')); // countries (CA, US, GB, etc)
      $templateMgr->assign('regionCodes', $onixCodelistItemDao->getCodes('List49')); // regions (British Columbia, England, etc)
 
      if ($salesRights) {
         $templateMgr->assign('salesRightsId', $salesRights->getId());
         $templateMgr->assign('type', $salesRights->getType());
         $templateMgr->assign('ROWSetting', $salesRights->getROWSetting());
         $templateMgr->assign('countriesIncluded', $salesRights->getCountriesIncluded());
         $templateMgr->assign('countriesExcluded', $salesRights->getCountriesExcluded());
         $templateMgr->assign('regionsIncluded', $salesRights->getRegionsIncluded());
         $templateMgr->assign('regionsExcluded', $salesRights->getRegionsExcluded());
 
         $representationId = $salesRights->getPublicationFormatId();
      } else { // loading a blank form
         $representationId = (int) $request->getUserVar('representationId');
      }
 
      $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);
         // SalesRightsType values are not normally used more than once per PublishingDetail block, so filter used ones out.
         $assignedSalesRights = $publicationFormat->getSalesRights();
         $assignedTypes = array_keys($assignedSalesRights->toAssociativeArray('type')); // currently assigned types
 
         if ($salesRights) $assignedTypes = array_diff($assignedTypes, array($salesRights->getType())); // allow existing codes to keep their value
 
         $types = $onixCodelistItemDao->getCodes('List46', $assignedTypes); // ONIX list for these
         $templateMgr->assign('salesRights', $types);
      } else {
         fatalError('Format not in authorized submission');
      }
 
      return parent::fetch($request, $template, $display);
   }
 
   public function readInputData() {
      $this->readUserVars(array(
         'salesRightsId',
         'representationId',
         'type',
         'ROWSetting',
         'countriesIncluded',
         'countriesExcluded',
         'regionsIncluded',
         'regionsExcluded',
      ));
   }
 
   public function execute(...$functionArgs) {
      parent::execute(...$functionArgs);
      $salesRightsDao = DAORegistry::getDAO('SalesRightsDAO'); /* @var $salesRightsDao SalesRightsDAO */
      $publicationFormatDao = DAORegistry::getDAO('PublicationFormatDAO'); /* @var $publicationFormatDao PublicationFormatDAO */
 
      $submission = $this->getSubmission();
      $salesRights = $this->getSalesRights();
      $publicationFormat = $publicationFormatDao->getById($this->getData('representationId'), $this->getPublication()->getId());
 
      if (!$salesRights) {
         // this is a new assigned format to this published submission
         $salesRights = $salesRightsDao->newDataObject();
         $existingFormat = false;
         if ($publicationFormat != null) { // ensure this assigned format is in this submission
            $salesRights->setPublicationFormatId($publicationFormat->getId());
         } else {
            fatalError('This assigned format not in authorized submission context!');
         }
      } else {
         $existingFormat = true;
         if ($publicationFormat->getId() !== $salesRights->getPublicationFormatId()) fatalError('Invalid format!');
      }
 
      $salesRights->setType($this->getData('type'));
      $salesRights->setROWSetting($this->getData('ROWSetting')?true:false);
      $salesRights->setCountriesIncluded($this->getData('countriesIncluded') ? $this->getData('countriesIncluded') : array());
      $salesRights->setCountriesExcluded($this->getData('countriesExcluded') ? $this->getData('countriesExcluded') : array());
      $salesRights->setRegionsIncluded($this->getData('regionsIncluded') ? $this->getData('regionsIncluded') : array());
      $salesRights->setRegionsExcluded($this->getData('regionsExcluded') ? $this->getData('regionsExcluded') : array());
 
      if ($existingFormat) {
         $salesRightsDao->updateObject($salesRights);
         $salesRightsId = $salesRights->getId();
      } else {
         $salesRightsId = $salesRightsDao->insertObject($salesRights);
      }
 
      return $salesRightsId;
   }
}