controllers/grid/settings/roles/UserGroupGridHandler.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('controllers.grid.settings.roles.UserGroupGridCategoryRow');

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

class UserGroupGridHandler extends CategoryGridHandler {
   var $_pressId;

   function UserGroupGridHandler() {
      parent::CategoryGridHandler();

      $this->addRoleAssignment(
         array(ROLE_ID_PRESS_MANAGER),
         array(
            'fetchGrid',
            'fetchCategory',
            'fetchRow',
            'addUserGroup',
            'editUserGroup',
            'updateUserGroup'
         )
      );
   }

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

   function initialize(&$request) {
      parent::initialize($request);

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

      // Load user-related translations.
      AppLocale::requireComponents(
         LOCALE_COMPONENT_PKP_USER,
         LOCALE_COMPONENT_OMP_SUBMISSION,
         LOCALE_COMPONENT_OMP_MANAGER
      );

      // Basic grid configuration.
      $this->setTitle('grid.roles.currentRoles');
      $this->setInstructions('settings.roles.gridDescription');

      // Add grid-level actions.
      $router =& $request->getRouter();
      $this->addAction(
         new LinkAction(
            'addUserGroup',
            new AjaxModal(
               $router->url($request, null, null, 'addUserGroup'),
               __('grid.roles.add'),
               'modal_add_role'
            ),
            __('grid.roles.add'),
            'add_role'
         )
      );

      // Add grid columns.
      $cellProvider = new DataObjectGridCellProvider();
      $cellProvider->setLocale(AppLocale::getLocale());

      // Add array columns to the grid.
      $this->addColumn(new GridColumn(
         'name',
         'settings.roles.roleName',
         null,
         'controllers/grid/gridCell.tpl',
         $cellProvider,
         array('alignment' => COLUMN_ALIGNMENT_LEFT)
      ));
      $this->addColumn(new GridColumn(
         'abbrev',
         'settings.roles.roleAbbrev',
         null,
         'controllers/grid/gridCell.tpl',
         $cellProvider
      ));
   }

   function &loadData($request, $filter) {
      $pressId = $this->_getPressId();
      $userGroupDao =& DAORegistry::getDAO('UserGroupDAO');

      if (is_array($filter) && isset($filter['selectedRoleId']) && $filter['selectedRoleId'] != 0) {
         $userGroups =& $userGroupDao->getByRoleId($pressId, $filter['selectedRoleId']);
      } else {
         $userGroups =& $userGroupDao->getByContextId($pressId);
      }

      $stages = array();
      while ($userGroup =& $userGroups->next()) {
         $userGroupStages = $this->_getAssignedStages($pressId, $userGroup->getId());
         foreach ($userGroupStages as $stageId => $stage) {
            if ($stage != null) {
               $stages[$stageId] = array('id' => $stageId, 'name' => $stage);
            }
         }
         unset($userGroup);
      }

      return $stages;
   }

   function &getRowInstance() {
      import('controllers.grid.settings.roles.UserGroupGridRow');
      $row = new UserGroupGridRow();
      return $row;
   }

   function &getCategoryRowInstance() {
      $row = new UserGroupGridCategoryRow();
      return $row;
   }

   function getCategoryData(&$stage) {
      // $stage is an associative array, with id and name (locale key) elements
      $stageId = $stage['id'];

      $userGroupDao =& DAORegistry::getDAO('UserGroupDAO');

      $assignedGroups =& $userGroupDao->getUserGroupsByStage($this->_getPressId(), $stageId);
      $returner = $assignedGroups->toAssociativeArray(); // array of UserGroup objects

      return $returner;
   }

   function addUserGroup($args, &$request) {
      return $this->editUserGroup($args, $request);
   }

   function editUserGroup($args, &$request) {
      $userGroupForm = $this->_getUserGroupForm($request);

      $userGroupForm->initData();

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

   function updateUserGroup($args, &$request) {
      $userGroupForm = $this->_getUserGroupForm($request);

      $userGroupForm->readInputData();
      if($userGroupForm->validate()) {
         $userGroupForm->execute($request);
         return DAO::getDataChangedEvent();
      } else {
         $json = new JSONMessage(true, $userGroupForm->fetch($request));
         return $json->getString();
      }
   }

   //
   // Private helper methods.
   //

   function _getUserGroupForm(&$request) {
      // Get the user group Id.
      $userGroupId = (int) $request->getUserVar('userGroupId');

      // Instantiate the files form.
      import('controllers.grid.settings.roles.form.UserGroupForm');
      $pressId = $this->_getPressId();
      return new UserGroupForm($pressId, $userGroupId);
   }

   function _getAssignedStages($pressId, $userGroupId) {
      $userGroupDao =& DAORegistry::getDAO('UserGroupDAO');
      $assignedStages =& $userGroupDao->getAssignedStagesByUserGroupId($pressId, $userGroupId);

      $stages = $userGroupDao->getWorkflowStageTranslationKeys();
      foreach($stages as $stageId => $stageTranslationKey) {
         if (!array_key_exists($stageId, $assignedStages)) $stages[$stageId] = null;
      }

      return $stages;
   }

   function _getPressId() {
      return $this->_pressId;
   }
}

?>