OrderCategoryGridItemsFeature.inc.php

<?php
 
import('lib.pkp.classes.controllers.grid.feature.OrderItemsFeature');
 
define('ORDER_CATEGORY_GRID_CATEGORIES_ONLY', 0x01);
define('ORDER_CATEGORY_GRID_CATEGORIES_ROWS_ONLY', 0x02);
define('ORDER_CATEGORY_GRID_CATEGORIES_AND_ROWS', 0x03);
 
class OrderCategoryGridItemsFeature extends OrderItemsFeature {
 
   function __construct($typeOption = ORDER_CATEGORY_GRID_CATEGORIES_AND_ROWS, $overrideRowTemplate = true, $grid = null) {
      parent::__construct($overrideRowTemplate);
 
      if ($grid) {
         $grid->_constants['ORDER_CATEGORY_GRID_CATEGORIES_ONLY'] = ORDER_CATEGORY_GRID_CATEGORIES_ONLY;
         $grid->_constants['ORDER_CATEGORY_GRID_CATEGORIES_ROWS_ONLY'] = ORDER_CATEGORY_GRID_CATEGORIES_ROWS_ONLY;
         $grid->_constants['ORDER_CATEGORY_GRID_CATEGORIES_AND_ROWS'] = ORDER_CATEGORY_GRID_CATEGORIES_AND_ROWS;
      }
 
      $this->addOptions(array('type' => $typeOption));
   }
 
 
   //
   // Getters and setters.
   //
   function getType() {
      $options = $this->getOptions();
      return $options['type'];
   }
 
 
   //
   // Extended methods from GridFeature.
   //
   function getJSClass() {
      return '$.pkp.classes.features.OrderCategoryGridItemsFeature';
   }
 
 
   //
   // Hooks implementation.
   //
   function getInitializedRowInstance($args) {
      if ($this->getType() != ORDER_CATEGORY_GRID_CATEGORIES_ONLY) {
         parent::getInitializedRowInstance($args);
      }
   }
 
   function getInitializedCategoryRowInstance($args) {
      if ($this->getType() != ORDER_CATEGORY_GRID_CATEGORIES_ROWS_ONLY) {
         $row =& $args['row'];
         $this->addRowOrderAction($row);
      }
   }
 
   function saveSequence($args) {
      $request =& $args['request'];
      $grid =& $args['grid'];
 
      $data = json_decode($request->getUserVar('data'));
      $gridCategoryElements = $grid->getGridDataElements($request);
 
      if ($this->getType() != ORDER_CATEGORY_GRID_CATEGORIES_ROWS_ONLY) {
         $categoriesData = array();
         foreach($data as $categoryData) {
            $categoriesData[] = $categoryData->categoryId;
         }
 
         // Save categories sequence.
         $firstSeqValue = $grid->getDataElementSequence(reset($gridCategoryElements));
         foreach ($gridCategoryElements as $rowId => $element) {
            $rowPosition = array_search($rowId, $categoriesData);
            $newSequence = $firstSeqValue + $rowPosition;
            $currentSequence = $grid->getDataElementSequence($element);
            if ($newSequence != $currentSequence) {
               $grid->setDataElementSequence($request, $rowId, $element, $newSequence);
            }
         }
      }
 
      // Save rows sequence, if this grid has also orderable rows inside each category.
      $this->_saveRowsInCategoriesSequence($request, $grid, $gridCategoryElements, $data);
   }
 
 
   //
   // Private helper methods.
   //
   function _saveRowsInCategoriesSequence($request, &$grid, $gridCategoryElements, $data) {
      if ($this->getType() != ORDER_CATEGORY_GRID_CATEGORIES_ONLY) {
         foreach($gridCategoryElements as $categoryId => $element) {
            $gridRowElements = $grid->getGridCategoryDataElements($request, $element);
            if (!$gridRowElements) continue;
 
            // Get the correct rows sequence data.
            $rowsData = null;
            foreach ($data as $categoryData) {
               if ($categoryData->categoryId == $categoryId) {
                  $rowsData = $categoryData->rowsId;
                  break;
               }
            }
 
            unset($rowsData[0]); // remove the first element, it is always the parent category ID
            $firstSeqValue = $grid->getDataElementInCategorySequence($categoryId, reset($gridRowElements));
            foreach ($gridRowElements as $rowId => $element) {
               $newSequence = array_search($rowId, $rowsData);
               $currentSequence = $grid->getDataElementInCategorySequence($categoryId, $element);
               if ($newSequence != $currentSequence) {
                  $grid->setDataElementInCategorySequence($categoryId, $element, $newSequence);
               }
            }
         }
      }
   }
}