SeriesGridHandler.inc.php

<?php
 
import('lib.pkp.controllers.grid.settings.SetupGridHandler');
import('controllers.grid.settings.series.SeriesGridRow');
 
class SeriesGridHandler extends SetupGridHandler {
   function __construct() {
      parent::__construct();
      $this->addRoleAssignment(
         array(ROLE_ID_MANAGER),
         array('fetchGrid', 'fetchRow', 'addSeries', 'editSeries', 'updateSeries', 'deleteSeries', 'saveSequence', 'deactivateSeries','activateSeries')
      );
   }
 
 
   //
   // Overridden template methods
   //
   /*
    * @copydoc SetupGridHandler::initialize
    */
   function initialize($request, $args = null) {
      parent::initialize($request, $args);
      $press = $request->getPress();
 
      // FIXME are these all required?
      AppLocale::requireComponents(
         LOCALE_COMPONENT_APP_MANAGER,
         LOCALE_COMPONENT_PKP_MANAGER,
         LOCALE_COMPONENT_PKP_COMMON,
         LOCALE_COMPONENT_PKP_USER,
         LOCALE_COMPONENT_APP_COMMON
      );
 
      // Set the grid title.
      $this->setTitle('catalog.manage.series');
 
      // Elements to be displayed in the grid
      $seriesDao = DAORegistry::getDAO('SeriesDAO'); /* @var $seriesDao SeriesDAO */
      DAORegistry::getDAO('CategoryDAO'); // Load constants?
      $subEditorsDao = DAORegistry::getDAO('SubEditorsDAO'); /* @var $subEditorsDao SubEditorsDAO */
      $seriesIterator = $seriesDao->getByPressId($press->getId());
 
      $gridData = array();
      while ($series = $seriesIterator->next()) {
         // Get the categories data for the row
         $categories = $seriesDao->getCategories($series->getId(), $press->getId());
         $categoriesString = null;
         while ($category = $categories->next()) {
            if (!empty($categoriesString)) $categoriesString .= ', ';
            $categoriesString .= $category->getLocalizedTitle();
         }
         if (empty($categoriesString)) $categoriesString = __('common.none');
 
         // Get the series editors data for the row
         $assignedSeriesEditors = $subEditorsDao->getBySubmissionGroupId($series->getId(), ASSOC_TYPE_SECTION, $press->getId());
         if(empty($assignedSeriesEditors)) {
            $editorsString = __('common.none');
         } else {
            $editors = array();
            foreach ($assignedSeriesEditors as $seriesEditor) {
               $editors[] = $seriesEditor->getFullName();
            }
            $editorsString = implode(', ', $editors);
         }
 
         $seriesId = $series->getId();
         $gridData[$seriesId] = array(
            'title' => $series->getLocalizedTitle(),
            'categories' => $categoriesString,
            'editors' => $editorsString,
            'inactive' => $series->getIsInactive(),
            'seq' => $series->getSequence()
         );
      }
 
      $this->setGridDataElements($gridData);
 
      // Add grid-level actions
      $router = $request->getRouter();
      import('lib.pkp.classes.linkAction.request.AjaxModal');
      $this->addAction(
         new LinkAction(
            'addSeries',
            new AjaxModal(
               $router->url($request, null, null, 'addSeries', null, array('gridId' => $this->getId())),
               __('grid.action.addSeries'),
               'modal_manage'
            ),
            __('grid.action.addSeries'),
            'add_category'
         )
      );
 
      import('controllers.grid.settings.series.SeriesGridCellProvider');
      $seriesGridCellProvider = new SeriesGridCellProvider();
      // Columns
      $this->addColumn(
         new GridColumn(
            'title',
            'common.title'
         )
      );
      $this->addColumn(new GridColumn('categories', 'grid.category.categories'));
      $this->addColumn(new GridColumn('editors', 'user.role.editors'));
      // Series 'inactive'
      $this->addColumn(
         new GridColumn(
            'inactive',
            'common.inactive',
            null,
            'controllers/grid/common/cell/selectStatusCell.tpl',
            $seriesGridCellProvider,
            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());
   }
 
   function getPublishChangeEvents() {
      return array('updateSidebar');
   }
 
   function getRowInstance() {
      return new SeriesGridRow();
   }
 
   function getDataElementSequence($gridDataElement) {
      return $gridDataElement['seq'];
   }
 
   function setDataElementSequence($request, $rowId, $gridDataElement, $newSequence) {
      $seriesDao = DAORegistry::getDAO('SeriesDAO'); /* @var $seriesDao SeriesDAO */
      $press = $request->getPress();
      $series = $seriesDao->getById($rowId, $press->getId());
      $series->setSequence($newSequence);
      $seriesDao->updateObject($series);
   }
 
   //
   // Public Series Grid Actions
   //
   function addSeries($args, $request) {
      // Calling editSeries with an empty ID will add
      // a new series.
      return $this->editSeries($args, $request);
   }
 
   function editSeries($args, $request) {
      $seriesId = isset($args['seriesId']) ? $args['seriesId'] : null;
      $this->setupTemplate($request);
 
      import('controllers.grid.settings.series.form.SeriesForm');
      $seriesForm = new SeriesForm($request, $seriesId);
      $seriesForm->initData();
      return new JSONMessage(true, $seriesForm->fetch($request));
   }
 
   function updateSeries($args, $request) {
      $seriesId = $request->getUserVar('seriesId');
 
      import('controllers.grid.settings.series.form.SeriesForm');
      $seriesForm = new SeriesForm($request, $seriesId);
      $seriesForm->readInputData();
 
      if ($seriesForm->validate()) {
         $seriesForm->execute();
         $notificationManager = new NotificationManager();
         $notificationManager->createTrivialNotification($request->getUser()->getId());
         return DAO::getDataChangedEvent($seriesForm->getSeriesId());
      } else {
         return new JSONMessage(false);
      }
   }
 
   function deleteSeries($args, $request) {
      $press = $request->getPress();
 
      $seriesDao = DAORegistry::getDAO('SeriesDAO'); /* @var $seriesDao SeriesDAO */
      $series = $seriesDao->getById(
         $request->getUserVar('seriesId'),
         $press->getId()
      );
 
      if (isset($series)) {
         $result = $seriesDao->getByContextId($press->getId());
         $activeSeriesCount = (!$series->getIsInactive()) ? -1 : 0;
         while (!$result->eof()) {
            if (!$result->next()->getIsInactive()) {
               $activeSeriesCount++;
            }
         }
         if ($activeSeriesCount < 1) {
            return new JSONMessage(false, __('manager.series.confirmDeactivateSeries.error'));
            return false;
         }
 
         $seriesDao->deleteObject($series);
         return DAO::getDataChangedEvent($series->getId());
      } else {
         AppLocale::requireComponents(LOCALE_COMPONENT_PKP_MANAGER); // manager.setup.errorDeletingItem
         return new JSONMessage(false, __('manager.setup.errorDeletingItem'));
      }
   }
 
   function deactivateSeries($args, $request) {
      // Identify the current series
      $seriesId = (int) $request->getUserVar('seriesKey');
 
      // Identify the context id.
      $context = $request->getContext();
 
      // Get series object
      $seriesDao = DAORegistry::getDAO('SeriesDAO'); /* @var $seriesDao SeriesDAO */
      // Validate if it can be inactive
      $seriesIterator = $seriesDao->getByContextId($context->getId(),null,false);
      $activeSeriesCount = 0;
      while ($series = $seriesIterator->next()) {
         if (!$series->getIsInactive()) {
            $activeSeriesCount++;
         }
      }
      if ($activeSeriesCount > 1) {
         $series = $seriesDao->getById($seriesId, $context->getId());
 
         if ($request->checkCSRF() && isset($series) && !$series->getIsInactive()) {
            $series->setIsInactive(1);
            $seriesDao->updateObject($series);
 
            // Create the notification.
            $notificationMgr = new NotificationManager();
            $user = $request->getUser();
            $notificationMgr->createTrivialNotification($user->getId());
 
            return DAO::getDataChangedEvent($seriesId);
         }
      } else {
         // Create the notification.
         $notificationMgr = new NotificationManager();
         $user = $request->getUser();
         $notificationMgr->createTrivialNotification($user->getId(), NOTIFICATION_TYPE_ERROR, array('contents' => __('manager.series.confirmDeactivateSeries.error')));
         return DAO::getDataChangedEvent($seriesId);
      }
 
      return new JSONMessage(false);
   }
 
   function activateSeries($args, $request) {
 
      // Identify the current series
      $seriesId = (int) $request->getUserVar('seriesKey');
 
      // Identify the context id.
      $context = $request->getContext();
 
      // Get series object
      $seriesDao = DAORegistry::getDAO('SeriesDAO'); /* @var $seriesDao SeriesDAO */
      $series = $seriesDao->getById($seriesId, $context->getId());
 
      if ($request->checkCSRF() && isset($series) && $series->getIsInactive()) {
         $series->setIsInactive(0);
         $seriesDao->updateObject($series);
 
         // Create the notification.
         $notificationMgr = new NotificationManager();
         $user = $request->getUser();
         $notificationMgr->createTrivialNotification($user->getId());
 
         return DAO::getDataChangedEvent($seriesId);
      }
 
      return new JSONMessage(false);
   }
}