SubmissionChecklistGridHandler.inc.php

<?php
 
import('lib.pkp.controllers.grid.settings.SetupGridHandler');
import('lib.pkp.controllers.grid.settings.submissionChecklist.SubmissionChecklistGridRow');
 
class SubmissionChecklistGridHandler extends SetupGridHandler {
 
   function __construct() {
      parent::__construct();
      $this->addRoleAssignment(array(ROLE_ID_MANAGER),
            array('fetchGrid', 'fetchRow', 'addItem', 'editItem', 'updateItem', 'deleteItem', 'saveSequence'));
   }
 
   //
   // Overridden template methods
   //
   function initialize($request, $args = null) {
      parent::initialize($request, $args);
 
      // Basic grid configuration
      $this->setId('submissionChecklist');
      $this->setTitle('manager.setup.submissionPreparationChecklist');
 
      // Add grid-level actions
      import('lib.pkp.classes.linkAction.request.AjaxModal');
      $router = $request->getRouter();
      $this->addAction(
         new LinkAction(
            'addItem',
            new AjaxModal(
               $router->url($request, null, null, 'addItem', null, array('gridId' => $this->getId())),
               __('grid.action.addItem'),
               'modal_add_item',
               true),
            __('grid.action.addItem'),
            'add_item')
      );
 
      // Columns
      $this->addColumn(
         new GridColumn(
            'content',
            'grid.submissionChecklist.column.checklistItem',
            null,
            null,
            null,
            array('html' => true, 'maxLength' => 220)
         )
      );
   }
 
 
   //
   // Overridden methods from GridHandler
   //
   function initFeatures($request, $args) {
      import('lib.pkp.classes.controllers.grid.feature.OrderGridItemsFeature');
      return array(new OrderGridItemsFeature());
   }
 
   protected function getRowInstance() {
      return new SubmissionChecklistGridRow();
   }
 
   protected function loadData($request, $filter) {
      // Elements to be displayed in the grid
      $router = $request->getRouter();
      $context = $router->getContext($request);
      $submissionChecklist = $context->getData('submissionChecklist');
      return $submissionChecklist[AppLocale::getLocale()];
   }
 
 
   //
   // Public grid actions.
   //
   function addItem($args, $request) {
      // Calling editItem with an empty row id will add a new row.
      return $this->editItem($args, $request);
   }
 
   function editItem($args, $request) {
      import('lib.pkp.controllers.grid.settings.submissionChecklist.form.SubmissionChecklistForm');
      $submissionChecklistId = isset($args['rowId']) ? $args['rowId'] : null;
      $submissionChecklistForm = new SubmissionChecklistForm($submissionChecklistId);
 
      $submissionChecklistForm->initData($args);
 
      return new JSONMessage(true, $submissionChecklistForm->fetch($request));
   }
 
   function updateItem($args, $request) {
      // -> submissionChecklistId must be present and valid
      // -> htmlId must be present and valid
 
      import('lib.pkp.controllers.grid.settings.submissionChecklist.form.SubmissionChecklistForm');
      $submissionChecklistId = isset($args['rowId']) ? $args['rowId'] : null;
      $submissionChecklistForm = new SubmissionChecklistForm($submissionChecklistId);
      $submissionChecklistForm->readInputData();
 
      if ($submissionChecklistForm->validate()) {
         $submissionChecklistForm->execute();
         return DAO::getDataChangedEvent($submissionChecklistForm->submissionChecklistId);
      } else {
         return new JSONMessage(false);
      }
   }
 
   function deleteItem($args, $request) {
      if (!$request->checkCSRF()) return new JSONMessage(false);
 
      $rowId = $request->getUserVar('rowId');
 
      $router = $request->getRouter();
      $context = $router->getContext($request);
 
      // get all of the submissionChecklists
      $submissionChecklistAll = $context->getData('submissionChecklist');
 
      foreach (AppLocale::getSupportedLocales() as $locale => $name) {
         if ( isset($submissionChecklistAll[$locale][$rowId]) ) {
            unset($submissionChecklistAll[$locale][$rowId]);
         } else {
            // only fail if the currently displayed locale was not set
            // (this is the one that needs to be removed from the currently displayed grid)
            if ( $locale == AppLocale::getLocale() ) {
               return new JSONMessage(false, __('manager.setup.errorDeletingSubmissionChecklist'));
            }
         }
      }
 
      $context->updateSetting('submissionChecklist', $submissionChecklistAll, 'object', true);
      return DAO::getDataChangedEvent($rowId);
   }
 
   function getDataElementSequence($gridDataElement) {
      return $gridDataElement['order'];
   }
 
   function setDataElementSequence($request, $rowId, $gridDataElement, $newSequence) {
      $router = $request->getRouter();
      $context = $router->getContext($request);
 
      // Get all of the submissionChecklists.
      $submissionChecklistAll = $context->getData('submissionChecklist');
      $locale = AppLocale::getLocale();
 
      if (isset($submissionChecklistAll[$locale][$rowId])) {
         $submissionChecklistAll[$locale][$rowId]['order'] = $newSequence;
      }
 
      $orderMap = array();
      foreach ($submissionChecklistAll[$locale] as $id => $checklistItem) {
         $orderMap[$id] = $checklistItem['order'];
      }
 
      asort($orderMap);
 
      // Build the new order checklist object.
      $orderedChecklistItems = array();
      foreach ($orderMap as $id => $order) {
         if (isset($submissionChecklistAll[$locale][$id])) {
            $orderedChecklistItems[$locale][$id] = $submissionChecklistAll[$locale][$id];
         }
      }
 
      // Update both the in-memory value and database setting.
      $context->setData('submissionChecklist', $orderedChecklistItems);
      $context->updateSetting('submissionChecklist', $orderedChecklistItems, 'object', true);
   }
}