ReviewerGridCellProvider.inc.php

<?php
 
import('lib.pkp.classes.controllers.grid.DataObjectGridCellProvider');
 
import('lib.pkp.classes.linkAction.request.AjaxModal');
import('lib.pkp.classes.linkAction.request.AjaxAction');
 
class ReviewerGridCellProvider extends DataObjectGridCellProvider {
 
   public $_isCurrentUserAssignedAuthor;
 
   public function __construct($isCurrentUserAssignedAuthor) {
      parent::__construct();
      $this->_isCurrentUserAssignedAuthor = $isCurrentUserAssignedAuthor;
   }
 
   //
   // Template methods from GridCellProvider
   //
   function getCellState($row, $column) {
      $reviewAssignment = $row->getData();
      $columnId = $column->getId();
      assert(is_a($reviewAssignment, 'DataObject') && !empty($columnId));
      switch ($columnId) {
         case 'name':
         case 'method':
            return '';
         case 'considered':
         case 'actions':
            return $reviewAssignment->getStatus();
      }
   }
 
   function getTemplateVarsFromRowColumn($row, $column) {
      $element = $row->getData();
      $columnId = $column->getId();
      assert(is_a($element, 'DataObject') && !empty($columnId));
      switch ($columnId) {
         case 'name':
            $isReviewBlind = in_array($element->getReviewMethod(), array(SUBMISSION_REVIEW_METHOD_BLIND, SUBMISSION_REVIEW_METHOD_DOUBLEBLIND));
            if ($this->_isCurrentUserAssignedAuthor && $isReviewBlind) {
               return array('label' => __('editor.review.anonymousReviewer'));
            }
            return array('label' => $element->getReviewerFullName());
 
         case 'method':
            return array('label' => __($element->getReviewMethodKey()));
 
         case 'considered':
            return array('label' => $this->_getStatusText($this->getCellState($row, $column), $row));
 
         case 'actions':
            // Only attach actions to this column. See self::getCellActions()
            return array('label' => '');
      }
 
      return parent::getTemplateVarsFromRowColumn($row, $column);
   }
 
   function getCellActions($request, $row, $column, $position = GRID_ACTION_POSITION_DEFAULT) {
      $reviewAssignment = $row->getData();
 
      // Authors can't perform action on reviews
      if ($this->_isCurrentUserAssignedAuthor) {
         return array();
      }
 
      $actionArgs = array(
         'submissionId' => $reviewAssignment->getSubmissionId(),
         'reviewAssignmentId' => $reviewAssignment->getId(),
         'stageId' => $reviewAssignment->getStageId()
      );
 
      $router = $request->getRouter();
      $action = false;
      $submissionDao = DAORegistry::getDAO('SubmissionDAO'); /* @var $submissionDao SubmissionDAO */
      $submission = $submissionDao->getById($reviewAssignment->getSubmissionId());
 
      // Only attach actions to the actions column. The actions and status
      // columns share state values.
      $columnId = $column->getId();
      if ($columnId == 'actions') {
         switch($this->getCellState($row, $column)) {
            case REVIEW_ASSIGNMENT_STATUS_RESPONSE_OVERDUE:
            case REVIEW_ASSIGNMENT_STATUS_REVIEW_OVERDUE:
               import('lib.pkp.controllers.api.task.SendReminderLinkAction');
               return array(new SendReminderLinkAction($request, 'editor.review.reminder', $actionArgs));
            case REVIEW_ASSIGNMENT_STATUS_COMPLETE:
               import('lib.pkp.controllers.api.task.SendThankYouLinkAction');
               import('lib.pkp.controllers.review.linkAction.UnconsiderReviewLinkAction');
               return array(
                  new SendThankYouLinkAction($request, 'editor.review.thankReviewer', $actionArgs),
                  new UnconsiderReviewLinkAction($request, $reviewAssignment, $submission),
               );
            case REVIEW_ASSIGNMENT_STATUS_THANKED:
               import('lib.pkp.controllers.review.linkAction.UnconsiderReviewLinkAction');
               return array(new UnconsiderReviewLinkAction($request, $reviewAssignment, $submission));
            case REVIEW_ASSIGNMENT_STATUS_RECEIVED:
               $user = $request->getUser();
               import('lib.pkp.controllers.review.linkAction.ReviewNotesLinkAction');
               return array(new ReviewNotesLinkAction($request, $reviewAssignment, $submission, $user, 'grid.users.reviewer.ReviewerGridHandler', true));
         }
 
      }
      return parent::getCellActions($request, $row, $column, $position);
   }
 
   function _getStatusText($state, $row) {
      $reviewAssignment = $row->getData();
      switch ($state) {
         case REVIEW_ASSIGNMENT_STATUS_AWAITING_RESPONSE:
            return '<span class="state">'.__('editor.review.requestSent').'</span><span class="details">'.__('editor.review.responseDue', array('date' => substr($reviewAssignment->getDateResponseDue(),0,10))).'</span>';
         case REVIEW_ASSIGNMENT_STATUS_ACCEPTED:
            return '<span class="state">'.__('editor.review.requestAccepted').'</span><span class="details">'.__('editor.review.reviewDue', array('date' => substr($reviewAssignment->getDateDue(),0,10))).'</span>';
         case REVIEW_ASSIGNMENT_STATUS_COMPLETE:
            return $this->_getStatusWithRecommendation('common.complete', $reviewAssignment);
         case REVIEW_ASSIGNMENT_STATUS_REVIEW_OVERDUE:
            return '<span class="state overdue">'.__('common.overdue').'</span><span class="details">'.__('editor.review.reviewDue', array('date' => substr($reviewAssignment->getDateDue(),0,10))).'</span>';
         case REVIEW_ASSIGNMENT_STATUS_RESPONSE_OVERDUE:
            return '<span class="state overdue">'.__('common.overdue').'</span><span class="details">'.__('editor.review.responseDue', array('date' => substr($reviewAssignment->getDateResponseDue(),0,10))).'</span>';
         case REVIEW_ASSIGNMENT_STATUS_DECLINED:
            return '<span class="state declined" title="' . __('editor.review.requestDeclined.tooltip') . '">'.__('editor.review.requestDeclined').'</span>';
         case REVIEW_ASSIGNMENT_STATUS_CANCELLED:
            return '<span class="state declined" title="' . __('editor.review.requestCancelled.tooltip') . '">'.__('editor.review.requestCancelled').'</span>';
         case REVIEW_ASSIGNMENT_STATUS_RECEIVED:
            return  $this->_getStatusWithRecommendation('editor.review.reviewSubmitted', $reviewAssignment);
         case REVIEW_ASSIGNMENT_STATUS_THANKED:
            return  $this->_getStatusWithRecommendation('editor.review.reviewerThanked', $reviewAssignment);
         default:
            return '';
      }
   }
 
   function _getStatusWithRecommendation($statusKey, $reviewAssignment) {
 
      if (!$reviewAssignment->getRecommendation()) {
         return __($statusKey);
      }
 
      return '<span class="state">'.__($statusKey).'</span><span class="details">'.__('submission.recommendation', array('recommendation' => $reviewAssignment->getLocalizedRecommendation())).'</span>';
   }
}