CategoryCategoryGridHandler.inc.php

<?php
 
// Import the base GridHandler.
import('lib.pkp.classes.controllers.grid.CategoryGridHandler');
import('lib.pkp.classes.controllers.grid.DataObjectGridCellProvider');
 
// Import user group grid specific classes
import('lib.pkp.controllers.grid.settings.category.CategoryGridCategoryRow');
 
// Link action & modal classes
import('lib.pkp.classes.linkAction.request.AjaxModal');
 
class CategoryCategoryGridHandler extends CategoryGridHandler {
   var $_contextId;
 
   function __construct() {
      parent::__construct();
      $this->addRoleAssignment(
         array(ROLE_ID_MANAGER, ROLE_ID_SITE_ADMIN),
         array(
            'fetchGrid',
            'fetchCategory',
            'fetchRow',
            'addCategory',
            'editCategory',
            'updateCategory',
            'deleteCategory',
            'uploadImage',
            'saveSequence',
         )
      );
   }
 
   //
   // Overridden methods from PKPHandler.
   //
   function authorize($request, &$args, $roleAssignments) {
      import('lib.pkp.classes.security.authorization.ContextAccessPolicy');
      $this->addPolicy(new ContextAccessPolicy($request, $roleAssignments));
      return parent::authorize($request, $args, $roleAssignments);
   }
 
 
   function initialize($request, $args = null) {
 
      parent::initialize($request, $args);
 
      $context = $request->getContext();
      $this->_contextId = $context->getId();
 
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_MANAGER, LOCALE_COMPONENT_PKP_SUBMISSION);
 
      // Set the grid title.
      $this->setTitle('grid.category.categories');
 
      // Add grid-level actions.
      $router = $request->getRouter();
      $this->addAction(
         new LinkAction(
            'addCategory',
            new AjaxModal(
               $router->url($request, null, null, 'addCategory'),
               __('grid.category.add'),
               'modal_manage'
            ),
            __('grid.category.add'),
            'add_category'
         )
      );
 
      // Add grid columns.
      $cellProvider = new DataObjectGridCellProvider();
      $cellProvider->setLocale(AppLocale::getLocale());
 
      $this->addColumn(
         new GridColumn(
            'title',
            'grid.category.name',
            null,
            null,
            $cellProvider
         )
      );
   }
 
   function loadData($request, $filter) {
      // For top-level rows, only list categories without parents.
      $categoryDao = DAORegistry::getDAO('CategoryDAO'); /* @var $categoryDao CategoryDAO */
      $categoriesIterator = $categoryDao->getByParentId(null, $this->_getContextId());
      return $categoriesIterator->toAssociativeArray();
   }
 
   function initFeatures($request, $args) {
      import('lib.pkp.classes.controllers.grid.feature.OrderCategoryGridItemsFeature');
      return array_merge(
         parent::initFeatures($request, $args),
         array(new OrderCategoryGridItemsFeature(ORDER_CATEGORY_GRID_CATEGORIES_AND_ROWS, true, $this))
      );
   }
 
   function getDataElementInCategorySequence($categoryId, &$category) {
      return $category->getSequence();
   }
 
   function setDataElementInCategorySequence($parentCategoryId, &$category, $newSequence) {
      $category->setSequence($newSequence);
      $categoryDao = DAORegistry::getDAO('CategoryDAO'); /* @var $categoryDao CategoryDAO */
      $categoryDao->updateObject($category);
   }
 
   function getDataElementSequence($gridDataElement) {
      return $gridDataElement->getSequence();
   }
 
   function setDataElementSequence($request, $categoryId, $category, $newSequence) {
      $category->setSequence($newSequence);
      $categoryDao = DAORegistry::getDAO('CategoryDAO'); /* @var $categoryDao CategoryDAO */
      $categoryDao->updateObject($category);
   }
 
   function getCategoryRowIdParameterName() {
      return 'parentCategoryId';
   }
 
   function getRowInstance() {
      import('lib.pkp.controllers.grid.settings.category.CategoryGridRow');
      return new CategoryGridRow();
   }
 
   function getCategoryRowInstance() {
      return new CategoryGridCategoryRow();
   }
 
   function loadCategoryData($request, &$category, $filter = null) {
      $categoryId = $category->getId();
      $categoryDao = DAORegistry::getDAO('CategoryDAO'); /* @var $categoryDao CategoryDAO */
      $categoriesIterator = $categoryDao->getByParentId($categoryId, $this->_getContextId());
      return $categoriesIterator->toAssociativeArray();
   }
 
   function addCategory($args, $request) {
      return $this->editCategory($args, $request);
   }
 
   function editCategory($args, $request) {
      $categoryForm = $this->_getCategoryForm($request);
 
      $categoryForm->initData();
 
      return new JSONMessage(true, $categoryForm->fetch($request));
   }
 
   function updateCategory($args, $request) {
      $categoryForm = $this->_getCategoryForm($request);
 
      $categoryForm->readInputData();
      if($categoryForm->validate()) {
         $categoryForm->execute();
         return DAO::getDataChangedEvent();
      } else {
         return new JSONMessage(true, $categoryForm->fetch($request));
      }
   }
 
   function deleteCategory($args, $request) {
      // Identify the category to be deleted
      $categoryDao = DAORegistry::getDAO('CategoryDAO'); /* @var $categoryDao CategoryDAO */
      $context = $request->getContext();
      $category = $categoryDao->getById(
         $request->getUserVar('categoryId'),
         $context->getId()
      );
 
      // FIXME delete dependent objects?
 
      // Delete the category
      $categoryDao->deleteObject($category);
      return DAO::getDataChangedEvent();
   }
 
   function uploadImage($args, $request) {
      $user = $request->getUser();
 
      import('lib.pkp.classes.file.TemporaryFileManager');
      $temporaryFileManager = new TemporaryFileManager();
      $temporaryFile = $temporaryFileManager->handleUpload('uploadedFile', $user->getId());
      if ($temporaryFile) {
         $json = new JSONMessage(true);
         $json->setAdditionalAttributes(array(
               'temporaryFileId' => $temporaryFile->getId()
         ));
         return $json;
      } else {
         return new JSONMessage(false, __('common.uploadFailed'));
      }
   }
 
   //
   // Private helper methods.
   //
   function _getCategoryForm($request) {
      // Get the category ID.
      $categoryId = (int) $request->getUserVar('categoryId');
 
      // Instantiate the files form.
      import('lib.pkp.controllers.grid.settings.category.form.CategoryForm');
      $contextId = $this->_getContextId();
      return new CategoryForm($contextId, $categoryId);
   }
 
   function _getContextId() {
      return $this->_contextId;
   }
}