OrderItemsFeature.inc.php

<?php
 
import('lib.pkp.classes.controllers.grid.feature.GridFeature');
 
class OrderItemsFeature extends GridFeature {
   var $_overrideRowTemplate;
 
   var $_nonOrderableItemMessage;
 
   function __construct($overrideRowTemplate, $nonOrderableItemMessage = null) {
      parent::__construct('orderItems');
 
      $this->setOverrideRowTemplate($overrideRowTemplate);
      $this->setNonOrderableItemMessage($nonOrderableItemMessage);
   }
 
 
   //
   // Getters and setters.
   //
   function setOverrideRowTemplate($overrideRowTemplate) {
      $this->_overrideRowTemplate = $overrideRowTemplate;
   }
 
   function getOverrideRowTemplate(&$gridRow) {
      // Make sure we don't return the override row template
      // flag to objects that are not instances of GridRow class.
      if (get_class($gridRow) == 'GridRow') {
         return $this->_overrideRowTemplate;
      } else {
         return false;
      }
   }
 
   function setNonOrderableItemMessage($nonOrderableItemMessage) {
      $this->_nonOrderableItemMessage = $nonOrderableItemMessage;
   }
 
   function getNonOrderableItemMessage() {
      return $this->_nonOrderableItemMessage;
   }
 
 
   //
   // Extended methods from GridFeature.
   //
   function setOptions($request, $grid) {
      parent::setOptions($request, $grid);
 
      $router = $request->getRouter();
      $this->addOptions(array(
         'saveItemsSequenceUrl' => $router->url($request, null, null, 'saveSequence', null, $grid->getRequestArgs())
      ));
   }
 
   function fetchUIElements($request, $grid) {
      $templateMgr = TemplateManager::getManager($request);
      $UIElements = array();
      if ($this->isOrderActionNecessary()) {
         $templateMgr->assign('gridId', $grid->getId());
         $UIElements['orderFinishControls'] = $templateMgr->fetch('controllers/grid/feature/gridOrderFinishControls.tpl');
      }
      $nonOrderableItemMessage = $this->getNonOrderableItemMessage();
      if ($nonOrderableItemMessage) {
         $templateMgr->assign('orderMessage', $nonOrderableItemMessage);
         $UIElements['orderMessage'] = $templateMgr->fetch('controllers/grid/feature/gridOrderNonOrderableMessage.tpl');
      }
 
      return $UIElements;
   }
 
 
   //
   // Hooks implementation.
   //
   function getInitializedRowInstance($args) {
      $row =& $args['row'];
      if ($args['grid']->getDataElementSequence($row->getData()) !== false) {
         $this->addRowOrderAction($row);
      }
   }
 
   function gridInitialize($args) {
      $grid =& $args['grid'];
 
      if ($this->isOrderActionNecessary()) {
         import('lib.pkp.classes.linkAction.request.NullAction');
         $grid->addAction(
            new LinkAction(
               'orderItems',
               new NullAction(),
               __('grid.action.order'),
               'order_items'
            )
         );
      }
   }
 
 
   //
   // Protected methods.
   //
   function addRowOrderAction($row) {
      if ($this->getOverrideRowTemplate($row)) {
         $row->setTemplate('controllers/grid/gridRow.tpl');
      }
 
      import('lib.pkp.classes.linkAction.request.NullAction');
      $row->addAction(
         new LinkAction(
            'moveItem',
            new NullAction(),
            '',
            'order_items'
         ), GRID_ACTION_POSITION_ROW_LEFT
      );
   }
 
   //
   // Protected template methods.
   //
   function isOrderActionNecessary() {
      return true;
   }
}