SectionGridHandler.inc.php

<?php
 
import('lib.pkp.controllers.grid.settings.SetupGridHandler');
import('controllers.grid.settings.sections.SectionGridRow');
 
class SectionGridHandler extends SetupGridHandler {
   function __construct() {
      parent::__construct();
      $this->addRoleAssignment(
         array(ROLE_ID_MANAGER),
         array('fetchGrid', 'fetchRow', 'addSection', 'editSection', 'updateSection', 'deleteSection', 'saveSequence', 'deactivateSection','activateSection')
      );
   }
 
 
   //
   // Overridden template methods
   //
   function initialize($request, $args = null) {
      parent::initialize($request, $args);
      $journal = $request->getJournal();
 
      // FIXME are these all required?
      AppLocale::requireComponents(
         LOCALE_COMPONENT_APP_MANAGER,
         LOCALE_COMPONENT_PKP_COMMON,
         LOCALE_COMPONENT_PKP_USER,
         LOCALE_COMPONENT_APP_COMMON
      );
 
      // Set the grid title.
      $this->setTitle('section.sections');
 
      // Elements to be displayed in the grid
      $sectionDao = DAORegistry::getDAO('SectionDAO'); /* @var $sectionDao SectionDAO */
      $subEditorsDao = DAORegistry::getDAO('SubEditorsDAO'); /* @var $subEditorsDao SubEditorsDAO */
      $sectionIterator = $sectionDao->getByJournalId($journal->getId());
 
      $gridData = array();
      while ($section = $sectionIterator->next()) {
         // Get the section editors data for the row
         $assignedSubEditors = $subEditorsDao->getBySubmissionGroupId($section->getId(), ASSOC_TYPE_SECTION, $journal->getId());
         if(empty($assignedSubEditors)) {
            $editorsString = __('common.none');
         } else {
            $editors = array();
            foreach ($assignedSubEditors as $subEditor) {
               $editors[] = $subEditor->getFullName();
            }
            $editorsString = implode(', ', $editors);
         }
 
         $sectionId = $section->getId();
         $gridData[$sectionId] = array(
            'title' => $section->getLocalizedTitle(),
            'editors' => $editorsString,
            'inactive' => $section->getIsInactive(),
            'seq' => $section->getSequence()
         );
      }
      uasort($gridData, function($a,$b) {
         return $a['seq']-$b['seq'];
      });
 
      $this->setGridDataElements($gridData);
 
      // Add grid-level actions
      $router = $request->getRouter();
      import('lib.pkp.classes.linkAction.request.AjaxModal');
      $this->addAction(
         new LinkAction(
            'addSection',
            new AjaxModal(
               $router->url($request, null, null, 'addSection', null, array('gridId' => $this->getId())),
               __('manager.sections.create'),
               'modal_manage'
            ),
            __('manager.sections.create'),
            'add_section'
         )
      );
 
      //
      // Grid columns.
      //
      import('controllers.grid.settings.sections.SectionGridCellProvider');
      $sectionGridCellProvider = new SectionGridCellProvider();
 
      // Section name
      $this->addColumn(
         new GridColumn(
            'title',
            'common.title'
         )
      );
      // Section 'editors'
      $this->addColumn(new GridColumn('editors', 'user.role.editors'));
      //Section 'inactive'
      $this->addColumn(
         new GridColumn(
            'inactive',
            'common.inactive',
            null,
            'controllers/grid/common/cell/selectStatusCell.tpl',
            $sectionGridCellProvider,
            array('alignment' => COLUMN_ALIGNMENT_CENTER,
                  'width' => 20)
         )
      );
   }
 
   //
   // 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 SectionGridRow();
   }
 
   function getDataElementSequence($row) {
      return $row['seq'];
   }
 
   function setDataElementSequence($request, $rowId, $gridDataElement, $newSequence) {
      $sectionDao = DAORegistry::getDAO('SectionDAO'); /* @var $sectionDao SectionDAO */
      $journal = $request->getJournal();
      $section = $sectionDao->getById($rowId, $journal->getId());
      $section->setSequence($newSequence);
      $sectionDao->updateObject($section);
   }
 
   //
   // Public Section Grid Actions
   //
   function addSection($args, $request) {
      // Calling editSection with an empty ID will add
      // a new section.
      return $this->editSection($args, $request);
   }
 
   function editSection($args, $request) {
      $sectionId = isset($args['sectionId']) ? $args['sectionId'] : null;
      $this->setupTemplate($request);
 
      import('controllers.grid.settings.sections.form.SectionForm');
      $sectionForm = new SectionForm($request, $sectionId);
      $sectionForm->initData();
      return new JSONMessage(true, $sectionForm->fetch($request));
   }
 
   function updateSection($args, $request) {
      $sectionId = $request->getUserVar('sectionId');
 
      import('controllers.grid.settings.sections.form.SectionForm');
      $sectionForm = new SectionForm($request, $sectionId);
      $sectionForm->readInputData();
 
      if ($sectionForm->validate()) {
         $sectionForm->execute();
         $notificationManager = new NotificationManager();
         $notificationManager->createTrivialNotification($request->getUser()->getId());
         return DAO::getDataChangedEvent($sectionForm->getSectionId());
      }
      return new JSONMessage(false);
   }
 
   function deleteSection($args, $request) {
      $journal = $request->getJournal();
 
      $sectionDao = DAORegistry::getDAO('SectionDAO'); /* @var $sectionDao SectionDAO */
      $section = $sectionDao->getById(
         $request->getUserVar('sectionId'),
         $journal->getId()
      );
 
      if (!$request->checkCSRF()) {
         return new JSONMessage(false, __('form.csrfInvalid'));
      }
 
      if (!$section) {
         return new JSONMessage(false, __('manager.setup.errorDeletingItem'));
      }
 
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_MANAGER);
      $submissionDao = DAORegistry::getDAO('SubmissionDAO'); /* @var $submissionDao SubmissionDAO */
      $checkSubmissions = $submissionDao->retrieve('SELECT p.publication_id FROM publications p JOIN submissions s ON (s.submission_id = p.submission_id) WHERE p.section_id = ? AND s.context_id = ?', array((int) $request->getUserVar('sectionId'), (int) $journal->getId()));
 
      if ($checkSubmissions->numRows() > 0) {
         return new JSONMessage(false, __('manager.sections.alertDelete'));
      }
 
      // Validate if it can be deleted
      $sectionsIterator = $sectionDao->getByContextId($journal->getId(),null,false);
      $activeSectionsCount = (!$section->getIsInactive()) ? -1 : 0;
      while ($checkSection = $sectionsIterator->next()) {
         if (!$checkSection->getIsInactive()) {
            $activeSectionsCount++;
         }
      }
 
      if ($activeSectionsCount < 1) {
         return new JSONMessage(false, __('manager.sections.confirmDeactivateSection.error'));
         return false;
      }
 
      if ($checkSubmissions->numRows() > 0) {
         return new JSONMessage(false, __('manager.sections.alertDelete'));
      }
 
      $sectionDao->deleteObject($section);
      return DAO::getDataChangedEvent($section->getId());
 
   }
 
   function deactivateSection($args, $request) {
      // Identify the current section
      $sectionId = (int) $request->getUserVar('sectionKey');
 
      // Identify the context id.
      $context = $request->getContext();
 
      // Get section object
      $sectionDao = DAORegistry::getDAO('SectionDAO'); /* @var $sectionDao SectionDAO */
      // Validate if it can be inactive
      $sectionsIterator = $sectionDao->getByContextId($context->getId(),null,false);
      $activeSectionsCount = 0;
      while ($section = $sectionsIterator->next()) {
         if (!$section->getIsInactive()) {
            $activeSectionsCount++;
         }
      }
      if ($activeSectionsCount > 1) {
         $section = $sectionDao->getById($sectionId, $context->getId());
 
         if ($request->checkCSRF() && isset($section) && !$section->getIsInactive()) {
            $section->setIsInactive(1);
            $sectionDao->updateObject($section);
 
            // Create the notification.
            $notificationMgr = new NotificationManager();
            $user = $request->getUser();
            $notificationMgr->createTrivialNotification($user->getId());
 
            return DAO::getDataChangedEvent($sectionId);
         }
      } else {
         // Create the notification.
         $notificationMgr = new NotificationManager();
         $user = $request->getUser();
         $notificationMgr->createTrivialNotification($user->getId(), NOTIFICATION_TYPE_ERROR, array('contents' => __('manager.sections.confirmDeactivateSection.error')));
         return DAO::getDataChangedEvent($sectionId);
      }
 
      return new JSONMessage(false);
   }
 
   function activateSection($args, $request) {
 
      // Identify the current section
      $sectionId = (int) $request->getUserVar('sectionKey');
 
      // Identify the context id.
      $context = $request->getContext();
 
      // Get section object
      $sectionDao = DAORegistry::getDAO('SectionDAO'); /* @var $sectionDao SectionDAO */
      $section = $sectionDao->getById($sectionId, $context->getId());
 
      if ($request->checkCSRF() && isset($section) && $section->getIsInactive()) {
         $section->setIsInactive(0);
         $sectionDao->updateObject($section);
 
         // Create the notification.
         $notificationMgr = new NotificationManager();
         $user = $request->getUser();
         $notificationMgr->createTrivialNotification($user->getId());
 
         return DAO::getDataChangedEvent($sectionId);
      }
 
      return new JSONMessage(false);
   }
 
}