controllers/grid/catalogEntry/PublicationFormatGridCellProvider.inc.php

<?php

import('lib.pkp.classes.controllers.grid.DataObjectGridCellProvider');

// Import monograph file class which contains the MONOGRAPH_FILE_* constants.
import('classes.monograph.MonographFile');

class PublicationFormatGridCellProvider extends DataObjectGridCellProvider {

   var $_monographId;

   var $_inCatalogEntryModal;

   function PublicationFormatGridCellProvider($monographId, $inCatalogEntryModal) {
      parent::DataObjectGridCellProvider();
      $this->_monographId = $monographId;
      $this->_inCatalogEntryModal = $inCatalogEntryModal;
   }


   //
   // Getters and setters.
   //
   function getMonographId() {
      return $this->_monographId;
   }

   function getInCatalogEntryModal() {
      return $this->_inCatalogEntryModal;
   }


   //
   // Template methods from GridCellProvider
   //
   function getTemplateVarsFromRowColumn(&$row, $column) {
      $publicationFormat =& $row->getData();
      $columnId = $column->getId();
      assert(is_a($publicationFormat, 'DataObject') && !empty($columnId));
      switch ($columnId) {
         case 'name':
            $label = $publicationFormat->getLocalizedName() . ' (' .$publicationFormat->getNameForONIXCode() . ')';
            return array('label' => $label);
         case 'proofComplete':
         case 'isAvailable':
         case 'isApproved':
            return array('status' => $this->getCellState($row, $column));
         default:
            assert(false);
      }
   }

   function isProofComplete(&$publicationFormat) {
      $monographFiles =& $this->getMonographFiles($publicationFormat->getId());
      $proofComplete = false;
      // If we have at least one viewable file, we consider
      // proofs as approved.
      foreach ($monographFiles as $file) {
         if ($file->getViewable()) {
            $proofComplete = true;
            break;
         }
      }
      return $proofComplete;
   }

   function getCellState(&$row, &$column) {
      $publicationFormat =& $row->getData();
      switch ($column->getId()) {
         case 'proofComplete':
            return $this->isProofComplete($publicationFormat)?'completed':'new';
         case 'isApproved':
            $publishedMonographDao =& DAORegistry::getDAO('PublishedMonographDAO');
            $publishedMonograph =& $publishedMonographDao->getById($publicationFormat->getMonographId());
            return ($publicationFormat->getIsApproved() && $publishedMonograph)?'completed':'new';
         case 'isAvailable':
            return $publicationFormat->getIsAvailable()?'completed':'new';
         default:
            assert(false);
      }
   }

   function getCellActions($request, $row, $column) {
      $publicationFormat =& $row->getData();
      $actionArgs = array(
         'monographId' => $publicationFormat->getMonographId(),
         'publicationFormatId' => $publicationFormat->getId()
      );
      $monographId = $publicationFormat->getMonographId();
      $publicationFormatId = $publicationFormat->getId();
      switch ($column->getId()) {
         case 'proofComplete':
            import('controllers.api.proof.linkAction.ApproveProofsLinkAction');
            return array(new ApproveProofsLinkAction($request, $monographId, $publicationFormatId, $this->getCellState($row, $column)));
            break;
         case 'isApproved':
            if ($this->getInCatalogEntryModal()) {
               import('lib.pkp.classes.linkAction.request.NullAction');
               $toolTip = ($this->getCellState($row, $column) == 'completed') ? __('grid.action.formatInCatalogEntry') : null;
               return array(new LinkAction('publicationFormatTab', new NullAction(), __('monograph.publicationFormat.openTab'), $this->getCellState($row, $column), $toolTip));
            } else {
               import('controllers.modals.submissionMetadata.linkAction.CatalogEntryLinkAction');
               return array(new CatalogEntryLinkAction($request, $monographId, WORKFLOW_STAGE_ID_PRODUCTION, $publicationFormatId, $this->getCellState($row, $column)));
            }
            break;
         case 'isAvailable':
            $router =& $request->getRouter();
            $publishedMonographDao =& DAORegistry::getDAO('PublishedMonographDAO');
            $publishedMonograph =& $publishedMonographDao->getById($publicationFormat->getMonographId());

            // FIXME: Bug #7715
            $warningMarkup = '';
            $templateMgr =& TemplateManager::getManager();
            $templateMgr->assign('notificationStyleClass', 'notifyWarning');
            $templateMgr->assign('notificationTitle', __('common.warning'));
            if (!$publishedMonograph) {
               $templateMgr->assign('notificationId', uniqid('notPublished'));
               $templateMgr->assign('notificationContents', __('grid.catalogEntry.availablePublicationFormat.catalogNotApprovedWarning'));
               $warningMarkup .= $templateMgr->fetch('controllers/notification/inPlaceNotificationContent.tpl');
            }
            if (!$publicationFormat->getIsApproved()) {
               $templateMgr->assign('notificationId', uniqid('notAvailable'));
               $templateMgr->assign('notificationContents', __('grid.catalogEntry.availablePublicationFormat.notApprovedWarning'));
               $warningMarkup .= $templateMgr->fetch('controllers/notification/inPlaceNotificationContent.tpl');
            }
            if (!$this->isProofComplete($publicationFormat)) {
               $templateMgr->assign('notificationId', uniqid('notProofed'));
               $templateMgr->assign('notificationContents', __('grid.catalogEntry.availablePublicationFormat.proofNotApproved'));
               $warningMarkup .= $templateMgr->fetch('controllers/notification/inPlaceNotificationContent.tpl');
            }
            // If we have any notifications, wrap them in the appropriately styled div
            if ($warningMarkup !== '') $warningMarkup = "<div class=\"pkp_notification\">$warningMarkup</div>";
            $toolTip = ($this->getCellState($row, $column) == 'completed') ? __('grid.action.formatAvailable') : null;
            return array(new LinkAction(
               'availablePublicationFormat',
               new RemoteActionConfirmationModal(
                  $warningMarkup . __($publicationFormat->getIsAvailable()?'grid.catalogEntry.availablePublicationFormat.removeMessage':'grid.catalogEntry.availablePublicationFormat.message'),
                  __('grid.catalogEntry.availablePublicationFormat.title'),
                  $router->url($request, null, 'grid.catalogEntry.PublicationFormatGridHandler',
                     'setAvailable', null, array('publicationFormatId' => $publicationFormat->getId(), 'newAvailableState' => $publicationFormat->getIsAvailable()?0:1, 'monographId' => $monographId)),
                  'modal_approve'),
                  __('manager.emails.disable'),
                  $this->getCellState($row, $column),
                  $toolTip
            ));
            break;
         default:
            return array();
      }
   }

   function &getMonographFiles($publicationFormatId) {
      $submissionFileDao =& DAORegistry::getDAO('SubmissionFileDAO'); /* @var $submissionFileDao SubmissionFileDAO */
      $monographFiles =& $submissionFileDao->getLatestRevisionsByAssocId(
         ASSOC_TYPE_PUBLICATION_FORMAT, $publicationFormatId,
         $this->getMonographId(), MONOGRAPH_FILE_PROOF
      );

      return $monographFiles;
   }
}

?>