GenreGridHandler.inc.php

<?php
 
import('lib.pkp.controllers.grid.settings.SetupGridHandler');
import('lib.pkp.classes.controllers.grid.DataObjectGridCellProvider');
import('lib.pkp.controllers.grid.settings.genre.GenreGridRow');
 
class GenreGridHandler extends SetupGridHandler {
   function __construct() {
      parent::__construct();
      $this->addRoleAssignment(array(ROLE_ID_MANAGER), array(
         'fetchGrid', 'fetchRow',
         'addGenre', 'editGenre', 'updateGenre',
         'deleteGenre', 'restoreGenres', 'saveSequence'
      ));
   }
 
 
   //
   // Overridden template methods
   //
   /*
    * Configure the grid
    * @see SetupGridHandler::initialize
    */
   function initialize($request, $args = null) {
      parent::initialize($request, $args);
 
      // Load language components
      AppLocale::requireComponents(
         LOCALE_COMPONENT_APP_MANAGER,
         LOCALE_COMPONENT_APP_EDITOR,
         LOCALE_COMPONENT_PKP_COMMON,
         LOCALE_COMPONENT_PKP_USER,
         LOCALE_COMPONENT_APP_COMMON,
         LOCALE_COMPONENT_PKP_GRID,
         LOCALE_COMPONENT_APP_SUBMISSION,
         LOCALE_COMPONENT_PKP_SUBMISSION,
         LOCALE_COMPONENT_PKP_MANAGER,
         LOCALE_COMPONENT_APP_DEFAULT
      );
 
      // Set the grid title.
      $this->setTitle('grid.genres.title');
 
      // Add grid-level actions
      $router = $request->getRouter();
      $actionArgs = array('gridId' => $this->getId());
 
      import('lib.pkp.classes.linkAction.request.AjaxModal');
      $this->addAction(
         new LinkAction(
            'addGenre',
            new AjaxModal(
               $router->url($request, null, null, 'addGenre', null, $actionArgs),
               __('grid.action.addGenre'),
               'modal_add_item',
               true),
            __('grid.action.addGenre'),
            'add_item')
      );
 
      import('lib.pkp.classes.linkAction.request.RemoteActionConfirmationModal');
      $this->addAction(
         new LinkAction(
            'restoreGenres',
            new RemoteActionConfirmationModal(
               $request->getSession(),
               __('grid.action.restoreDefaults.confirm'),
               null,
               $router->url($request, null, null, 'restoreGenres', null, $actionArgs), 'modal_delete'),
            __('grid.action.restoreDefaults'),
            'reset_default')
      );
 
      // Columns
      $cellProvider = new DataObjectGridCellProvider();
      $cellProvider->setLocale(AppLocale::getLocale());
      $this->addColumn(
         new GridColumn('name',
            'common.name',
            null,
            null,
            $cellProvider
         )
      );
   }
 
   protected function loadData($request, $filter) {
      // Elements to be displayed in the grid
      $context = $request->getContext();
      $genreDao = DAORegistry::getDAO('GenreDAO'); /* @var $genreDao GenreDAO */
      return $genreDao->getEnabledByContextId($context->getId(), self::getRangeInfo($request, $this->getId()));
   }
 
   //
   // 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 GenreGridRow();
   }
 
   function getDataElementSequence($row) {
      return $row->getSequence();
   }
 
   function setDataElementSequence($request, $rowId, $gridDataElement, $newSequence) {
      $genreDao = DAORegistry::getDAO('GenreDAO'); /* @var $genreDao GenreDAO */
      $context = $request->getContext();
      $genre = $genreDao->getById($rowId, $context->getId());
      $genre->setSequence($newSequence);
      $genreDao->updateObject($genre);
   }
 
   //
   // Public Genre Grid Actions
   //
   function addGenre($args, $request) {
      // Calling editGenre with an empty row id will add a new Genre.
      return $this->editGenre($args, $request);
   }
 
   function editGenre($args, $request) {
      $genreId = isset($args['genreId']) ? (int) $args['genreId'] : null;
 
      $this->setupTemplate($request);
 
      import('lib.pkp.controllers.grid.settings.genre.form.GenreForm');
      $genreForm = new GenreForm($genreId);
 
      $genreForm->initData($args);
 
      return new JSONMessage(true, $genreForm->fetch($request));
   }
 
   function updateGenre($args, $request) {
      $genreId = isset($args['genreId']) ? (int) $args['genreId'] : null;
      $context = $request->getContext();
 
      import('lib.pkp.controllers.grid.settings.genre.form.GenreForm');
      $genreForm = new GenreForm($genreId);
      $genreForm->readInputData();
 
      $router = $request->getRouter();
 
      if ($genreForm->validate()) {
         $genreForm->execute();
         return DAO::getDataChangedEvent($genreForm->getGenreId());
      } else {
         return new JSONMessage(false);
      }
   }
 
   function deleteGenre($args, $request) {
      $genreId = isset($args['genreId']) ? (int) $args['genreId'] : null;
      $context = $request->getContext();
      $genreDao = DAORegistry::getDAO('GenreDAO'); /* @var $genreDao GenreDAO */
      $genre = $genreDao->getById($genreId, $context->getId());
      if ($genre && $request->checkCSRF()) {
         $genreDao->deleteObject($genre);
         return DAO::getDataChangedEvent($genre->getId());
      }
      return new JSONMessage(false, __('manager.setup.errorDeletingItem'));
   }
 
   function restoreGenres($args, $request) {
      if (!$request->checkCSRF()) return new JSONMessage(false);
 
      // Restore all the genres in this context form the registry XML file
      $context = $request->getContext();
      $genreDao = DAORegistry::getDAO('GenreDAO'); /* @var $genreDao GenreDAO */
      $genreDao->installDefaults($context->getId(), $context->getSupportedFormLocales());
      return DAO::getDataChangedEvent();
   }
}