controllers/grid/catalogEntry/IdentificationCodeGridHandler.inc.php

<?php

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


// import format grid specific classes
import('controllers.grid.catalogEntry.IdentificationCodeGridCellProvider');
import('controllers.grid.catalogEntry.IdentificationCodeGridRow');

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

class IdentificationCodeGridHandler extends GridHandler {
   var $_monograph;

   var $_publicationFormat;

   function IdentificationCodeGridHandler() {
      parent::GridHandler();
      $this->addRoleAssignment(
            array(ROLE_ID_PRESS_MANAGER),
            array('fetchGrid', 'fetchRow', 'addCode', 'editCode',
            'updateCode', 'deleteCode'));
   }


   //
   // Getters/Setters
   //
   function &getMonograph() {
      return $this->_monograph;
   }

   function setMonograph($monograph) {
      $this->_monograph =& $monograph;
   }

   function &getPublicationFormat() {
      return $this->_publicationFormat;
   }

   function setPublicationFormat($publicationFormat) {
      $this->_publicationFormat =& $publicationFormat;
   }

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

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

      // Retrieve the authorized monograph.
      $this->setMonograph($this->getAuthorizedContextObject(ASSOC_TYPE_MONOGRAPH));
      $publicationFormatDao =& DAORegistry::getDAO('PublicationFormatDAO');
      $publicationFormatId = null;

      // Retrieve the associated publication format for this grid.
      $identificationCodeId = (int) $request->getUserVar('identificationCodeId'); // set if editing or deleting a code

      if ($identificationCodeId != '') {
         $identificationCodeDao =& DAORegistry::getDAO('IdentificationCodeDAO');
         $identificationCode =& $identificationCodeDao->getById($identificationCodeId, $this->getMonograph()->getId());
         if ($identificationCode) {
            $publicationFormatId =& $identificationCode->getPublicationFormatId();
         }
      } else { // empty form for new Code
         $publicationFormatId = (int) $request->getUserVar('publicationFormatId');
      }

      $publicationFormat =& $publicationFormatDao->getById($publicationFormatId, $this->getMonograph()->getId());

      if ($publicationFormat) {
         $this->setPublicationFormat($publicationFormat);
      } else {
         fatalError('The publication format is not assigned to authorized monograph!');
      }

      // Load submission-specific translations
      AppLocale::requireComponents(
         LOCALE_COMPONENT_OMP_SUBMISSION,
         LOCALE_COMPONENT_PKP_SUBMISSION,
         LOCALE_COMPONENT_PKP_USER,
         LOCALE_COMPONENT_OMP_DEFAULT_SETTINGS
      );

      // Basic grid configuration
      $this->setTitle('monograph.publicationFormat.productIdentifierType');

      // Grid actions
      $router =& $request->getRouter();
      $actionArgs = $this->getRequestArgs();
      $this->addAction(
         new LinkAction(
            'addCode',
            new AjaxModal(
               $router->url($request, null, null, 'addCode', null, $actionArgs),
               __('grid.action.addCode'),
               'modal_add_item'
            ),
            __('grid.action.addCode'),
            'add_item'
         )
      );

      // Columns
      $cellProvider = new IdentificationCodeGridCellProvider();
      $this->addColumn(
         new GridColumn(
            'value',
            'grid.catalogEntry.identificationCodeValue',
            null,
            'controllers/grid/gridCell.tpl',
            $cellProvider,
            array('width' => 50, 'alignment' => COLUMN_ALIGNMENT_LEFT)
         )
      );
      $this->addColumn(
         new GridColumn(
            'code',
            'grid.catalogEntry.identificationCodeType',
            null,
            'controllers/grid/gridCell.tpl',
            $cellProvider
         )
      );
   }


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

   function getRequestArgs() {
      $monograph =& $this->getMonograph();
      $publicationFormat =& $this->getPublicationFormat();

      return array(
         'monographId' => $monograph->getId(),
         'publicationFormatId' => $publicationFormat->getId()
      );
   }

   function &loadData($request, $filter = null) {
      $publicationFormat =& $this->getPublicationFormat();
      $identificationCodeDao =& DAORegistry::getDAO('IdentificationCodeDAO');
      $data =& $identificationCodeDao->getByPublicationFormatId($publicationFormat->getId());
      return $data->toArray();
   }


   //
   // Public Identification Code Grid Actions
   //

   function addCode($args, $request) {
      return $this->editCode($args, $request);
   }

   function editCode($args, &$request) {
      // Identify the code to be updated
      $identificationCodeId = (int) $request->getUserVar('identificationCodeId');
      $monograph =& $this->getMonograph();

      $identificationCodeDao =& DAORegistry::getDAO('IdentificationCodeDAO');
      $identificationCode = $identificationCodeDao->getById($identificationCodeId, $monograph->getId());

      // Form handling
      import('controllers.grid.catalogEntry.form.IdentificationCodeForm');
      $identificationCodeForm = new IdentificationCodeForm($monograph, $identificationCode);
      $identificationCodeForm->initData();

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

   function updateCode($args, &$request) {
      // Identify the code to be updated
      $identificationCodeId = $request->getUserVar('identificationCodeId');
      $monograph =& $this->getMonograph();

      $identificationCodeDao =& DAORegistry::getDAO('IdentificationCodeDAO');
      $identificationCode = $identificationCodeDao->getById($identificationCodeId, $monograph->getId());

      // Form handling
      import('controllers.grid.catalogEntry.form.IdentificationCodeForm');
      $identificationCodeForm = new IdentificationCodeForm($monograph, $identificationCode);
      $identificationCodeForm->readInputData();
      if ($identificationCodeForm->validate()) {
         $identificationCodeId = $identificationCodeForm->execute();

         if(!isset($identificationCode)) {
            // This is a new code
            $identificationCode =& $identificationCodeDao->getById($identificationCodeId, $monograph->getId());
            // New added code action notification content.
            $notificationContent = __('notification.addedIdentificationCode');
         } else {
            // code edit action notification content.
            $notificationContent = __('notification.editedIdentificationCode');
         }

         // 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($identificationCodeId);
         $row->setData($identificationCode);
         $row->initialize($request);

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

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

   function deleteCode($args, &$request) {

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

      $identificationCodeDao =& DAORegistry::getDAO('IdentificationCodeDAO');
      $identificationCode =& $identificationCodeDao->getById($identificationCodeId, $this->getMonograph()->getId());
      if ($identificationCode != null) { // authorized

         $result = $identificationCodeDao->deleteObject($identificationCode);

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

?>