controllers/grid/content/spotlights/ManageSpotlightsGridHandler.inc.php

<?php

// import grid base classes
import('lib.pkp.classes.controllers.grid.GridHandler');


// import format grid specific classes
import('controllers.grid.content.spotlights.SpotlightsGridCellProvider');
import('controllers.grid.content.spotlights.SpotlightsGridRow');
import('controllers.grid.content.spotlights.form.SpotlightForm');

// import Spotlight class for class constants
import('classes.spotlight.Spotlight');

// Link action & modal classes
import('lib.pkp.classes.linkAction.request.AjaxModal');

class ManageSpotlightsGridHandler extends GridHandler {

   var $_press;

   function ManageSpotlightsGridHandler() {
      parent::GridHandler();
      $this->addRoleAssignment(
            array(ROLE_ID_PRESS_MANAGER),
            array('fetchGrid', 'fetchRow', 'addSpotlight', 'editSpotlight',
            'updateSpotlight', 'deleteSpotlight', 'itemAutocomplete'));
   }

   //
   // Getters/Setters
   //
   function &getPress() {
      return $this->_press;
   }

   function setPress($press) {
      $this->_press =& $press;
   }

   //
   // Overridden methods from PKPHandler
   //
   function authorize(&$request, $args, $roleAssignments) {
      import('classes.security.authorization.OmpPressAccessPolicy');
      $this->addPolicy(new OmpPressAccessPolicy($request, $roleAssignments));
      $returner = parent::authorize($request, $args, $roleAssignments);

      $spotlightId = $request->getUserVar('spotlightId');
      if ($spotlightId) {
         $press =& $request->getPress();
         $spotlightDao =& DAORegistry::getDAO('SpotlightDAO');
         $spotlight =& $spotlightDao->getById($spotlightId);
         if ($spotlight == null || $spotlight->getPressId() != $press->getId()) {
            return false;
         }
      }

      return $returner;
   }

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

      // Load locale components.
      AppLocale::requireComponents(LOCALE_COMPONENT_OMP_SUBMISSION, LOCALE_COMPONENT_OMP_MANAGER);

      // Basic grid configuration
      $this->setTitle('spotlight.spotlights');

      // Set the no items row text
      $this->setEmptyRowText('spotlight.noneExist');

      $press =& $request->getPress();
      $this->setPress($press);

      // Columns
      import('controllers.grid.content.spotlights.SpotlightsGridCellProvider');
      $spotlightsGridCellProvider = new SpotlightsGridCellProvider();
      $this->addColumn(
         new GridColumn('title',
            'grid.content.spotlights.form.title',
            null,
            'controllers/grid/gridCell.tpl',
            $spotlightsGridCellProvider,
            array('width' => 40)
         )
      );

      $this->addColumn(
         new GridColumn('itemTitle',
            'grid.content.spotlights.spotlightItemTitle',
            null,
            'controllers/grid/gridCell.tpl',
            $spotlightsGridCellProvider,
            array('width' => 40)
         )
      );

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

      // Add grid action.
      $router =& $request->getRouter();
      import('lib.pkp.classes.linkAction.request.AjaxModal');
      $this->addAction(
         new LinkAction(
            'addSpotlight',
            new AjaxModal(
               $router->url($request, null, null, 'addSpotlight', null, null),
               __('grid.action.addSpotlight'),
               'modal_add_item'
            ),
            __('grid.action.addSpotlight'),
            'add_item')
      );
   }


   //
   // Overridden methods from GridHandler
   //
   function &getRowInstance() {
      $row = new SpotlightsGridRow($this->getPress());
      return $row;
   }

   function loadData($request, $filter = null) {

      $spotlightDao =& DAORegistry::getDAO('SpotlightDAO');
      $press =& $this->getPress();
      return $spotlightDao->getByPressId($press->getId());
   }

   function getRequestArgs() {
      $press =& $this->getPress();
      return array(
         'pressId' => $press->getId()
      );
   }

   //
   // Public Spotlights Grid Actions
   //

   function addSpotlight($args, &$request) {
      return $this->editSpotlight($args, $request);
   }

   function editSpotlight($args, &$request) {
      $spotlightId = (int)$request->getUserVar('spotlightId');
      $press =& $request->getPress();
      $pressId = $press->getId();

      $spotlightForm = new SpotlightForm($pressId, $spotlightId);
      $spotlightForm->initData($args, $request);

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

   function updateSpotlight($args, &$request) {
      // Identify the spotlight entry to be updated
      $spotlightId = $request->getUserVar('spotlightId');

      $press =& $this->getPress();

      $spotlightDao =& DAORegistry::getDAO('SpotlightDAO');
      $spotlight = $spotlightDao->getById($spotlightId, $press->getId());

      // Form handling
      $spotlightForm = new SpotlightForm($press->getId(), $spotlightId);

      $spotlightForm->readInputData();
      if ($spotlightForm->validate()) {
         $spotlightId = $spotlightForm->execute($request);

         if(!isset($spotlight)) {
            // This is a new entry
            $spotlight =& $spotlightDao->getById($spotlightId, $press->getId());
            // New added entry action notification content.
            $notificationContent = __('notification.addedSpotlight');
         } else {
            // entry edit action notification content.
            $notificationContent = __('notification.editedSpotlight');
         }

         // Create trivial notification.
         $currentUser =& $request->getUser();
         $notificationMgr = new NotificationManager();
         $notificationMgr->createTrivialNotification($currentUser->getId(), NOTIFICATION_TYPE_SUCCESS, array('contents' => $notificationContent));

         // Prepare the grid row data
         $row =& $this->getRowInstance();
         $row->setGridId($this->getId());
         $row->setId($spotlightId);
         $row->setData($spotlight);
         $row->initialize($request);

         // Render the row into a JSON response
         return DAO::getDataChangedEvent();

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

   function deleteSpotlight($args, &$request) {

      // Identify the entry to be deleted
      $spotlightId = $request->getUserVar('spotlightId');

      $spotlightDao =& DAORegistry::getDAO('SpotlightDAO');
      $press =& $this->getPress();
      $spotlight =& $spotlightDao->getById($spotlightId, $press->getId());
      if ($spotlight != null) { // authorized

         $result = $spotlightDao->deleteObject($spotlight);

         if ($result) {
            $currentUser =& $request->getUser();
            $notificationMgr = new NotificationManager();
            $notificationMgr->createTrivialNotification($currentUser->getId(), NOTIFICATION_TYPE_SUCCESS, array('contents' => __('notification.removedSpotlight')));
            return DAO::getDataChangedEvent();
         } else {
            $json = new JSONMessage(false, __('manager.setup.errorDeletingItem'));
            return $json->getString();
         }
      }
   }

   function itemAutocomplete($args, &$request) {

      $name = $request->getUserVar('name');

      $press =& $this->getPress();

      $itemList = array();

      // get the items that match.

      $matches = array();

      $publishedMonographDao =& DAORegistry::getDAO('PublishedMonographDAO');
      $publishedMonographs =& $publishedMonographDao->getByPressId($press->getId());
      while ($monograph =& $publishedMonographs->next()) {
         if ($name == '' || preg_match('/'. preg_quote($name, '/') . '/i', $monograph->getLocalizedTitle())) {
            $matches[] = array('label' => $monograph->getLocalizedTitle(), 'value' => $monograph->getId() . ':' . SPOTLIGHT_TYPE_BOOK);
         }
      }

      if (!empty($matches)) {
         $itemList[] = array('label' => String::strtoupper(__('submission.workType.authoredWork')), 'value' => '');
         $itemList = array_merge($itemList, $matches);
      }

      $matches = array();

      $seriesDao =& DAORegistry::getDAO('SeriesDAO');
      $allSeries =& $seriesDao->getByPressId($press->getId());
      while ($series =& $allSeries->next()) {
         if ($name == '' || preg_match('/'. preg_quote($name, '/') . '/i', $series->getLocalizedTitle())) {
            $matches[] = array('label' => $series->getLocalizedTitle(), 'value' => $series->getId() . ':' . SPOTLIGHT_TYPE_SERIES);
         }
      }

      if (!empty($matches)) {
         $itemList[] = array('label' => String::strtoupper(__('manager.series.book')), 'value' => '');
         $itemList = array_merge($itemList, $matches);
      }

      $matches = array();

      $authorDao =& DAORegistry::getDAO('AuthorDAO');
      $authors =& $authorDao->getAuthorsAlphabetizedByPress($press->getId());
      while ($author =& $authors->next()) {
         if ($name == '' || preg_match('/'. preg_quote($name, '/') . '/i', $author->getFullName())) {
            $publishedMonograph =& $publishedMonographDao->getById($author->getSubmissionId());
            if ($publishedMonograph) { // only include Authors if they are authors on published monographs.
               $matches[] = array('label' => $author->getFullName() . ' (' . $publishedMonograph->getLocalizedTitle() . ')', 'value' => $author->getId() . ':' . SPOTLIGHT_TYPE_AUTHOR);
            }
         }
      }

      if (!empty($matches)) {
         $itemList[] = array('label' => String::strtoupper(__('user.role.author')), 'value' => '');
         $itemList = array_merge($itemList, $matches);
      }

      if (count($itemList) == 0) {
         return $this->noAutocompleteResults();
      }

      $json = new JSONMessage(true, $itemList);
      return $json->getString();
   }
}

?>