controllers/grid/settings/genre/GenreGridHandler.inc.php

<?php

import('controllers.grid.settings.SetupGridHandler');
import('lib.pkp.classes.controllers.grid.DataObjectGridCellProvider');
import('controllers.grid.settings.genre.GenreGridRow');

class GenreGridHandler extends SetupGridHandler {
   function GenreGridHandler() {
      parent::GridHandler();
      $this->addRoleAssignment(array(ROLE_ID_PRESS_MANAGER),
            array('fetchGrid', 'fetchRow', 'addGenre', 'editGenre', 'updateGenre',
            'deleteGenre', 'restoreGenres'));
   }


   //
   // Overridden template methods
   //
   /*
    * Configure the grid
    * @param $request PKPRequest
    */
   function initialize(&$request) {
      parent::initialize($request);

      // Load language components
      AppLocale::requireComponents(
         LOCALE_COMPONENT_OMP_MANAGER,
         LOCALE_COMPONENT_OMP_EDITOR,
         LOCALE_COMPONENT_PKP_COMMON,
         LOCALE_COMPONENT_PKP_USER,
         LOCALE_COMPONENT_APPLICATION_COMMON,
         LOCALE_COMPONENT_PKP_GRID,
         LOCALE_COMPONENT_OMP_SUBMISSION
      );

      // Basic grid configuration
      $press =& $request->getPress();

      // Set the grid title.
      $this->setTitle('grid.genres.title');

      $this->setInstructions('grid.genres.description');

      // Elements to be displayed in the grid
      $genreDao =& DAORegistry::getDAO('GenreDAO');
      $genres =& $genreDao->getEnabledByPressId($press->getId());
      $this->setGridDataElements($genres);

      // 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(
               __('grid.action.restoreDefaults'),
               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,
            'controllers/grid/gridCell.tpl',
            $cellProvider
         )
      );

      $this->addColumn(
         new GridColumn(
            'designation',
            'common.designation',
            null,
            'controllers/grid/gridCell.tpl',
            $cellProvider
         )
      );
   }

   //
   // Overridden methods from GridHandler
   //
   function &getRowInstance() {
      $row = new GenreGridRow();
      return $row;
   }

   //
   // 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();

      import('controllers.grid.settings.genre.form.GenreForm');
      $genreForm = new GenreForm($genreId);

      $genreForm->initData($args, $request);

      $json = new JSONMessage(true, $genreForm->fetch($request));
      return $json->getString();
   }

   function updateGenre($args, &$request) {
      $genreId = isset($args['genreId']) ? (int) $args['genreId'] : null;
      $press =& $request->getPress();

      import('controllers.grid.settings.genre.form.GenreForm');
      $genreForm = new GenreForm($genreId);
      $genreForm->readInputData();

      $router =& $request->getRouter();

      if ($genreForm->validate()) {
         $genreForm->execute($args, $request);
         return DAO::getDataChangedEvent($genreForm->getGenreId());
      } else {
         $json = new JSONMessage(false);
         return $json->getString();
      }
   }

   function deleteGenre($args, &$request) {
      // Identify the Genre to be deleted
      $genre =& $this->_getGenreFromArgs($request, $args);

      $genreDao =& DAORegistry::getDAO('GenreDAO');
      $result = $genreDao->deleteObject($genre);

      if ($result) {
         return DAO::getDataChangedEvent($genre->getId());
      } else {
         $json = new JSONMessage(false, __('manager.setup.errorDeletingItem'));
      }
      return $json->getString();
   }

   function restoreGenres($args, &$request) {
      $press =& $request->getPress();

      // Restore all the genres in this press form the registry XML file
      $genreDao =& DAORegistry::getDAO('GenreDAO');
      $genreDao->restoreByPressId($press->getId());
      return DAO::getDataChangedEvent();
   }

   //
   // Private helper function
   //
   function &_getGenreFromArgs($request, $args) {
      // Identify the Genre Id and retrieve the
      // corresponding element from the grid's data source.
      if (!isset($args['genreId'])) {
         fatalError('Missing Genre Id!');
      } else {
         $genre =& $this->getRowDataElement($request, $args['genreId']);
         if (is_null($genre)) fatalError('Invalid Genre Id!');
      }
      return $genre;
   }
}

?>