controllers/grid/settings/roles/form/UserGroupForm.inc.php

<?php

import('lib.pkp.classes.form.Form');

class UserGroupForm extends Form {

   var $_userGroupId;

   var $_pressId;


   function UserGroupForm($pressId, $userGroupId = null) {
      parent::Form('controllers/grid/settings/roles/form/userGroupForm.tpl');
      $this->_pressId = $pressId;
      $this->_userGroupId = $userGroupId;

      // Validation checks for this form
      $this->addCheck(new FormValidatorLocale($this, 'name', 'required', 'settings.roles.nameRequired'));
      $this->addCheck(new FormValidatorLocale($this, 'abbrev', 'required', 'settings.roles.abbrevRequired'));
      $this->addCheck(new FormValidatorArray($this, 'assignedStages', 'required', 'settings.roles.stageIdRequired'));
      if ($this->getUserGroupId() == null) {
         $this->addCheck(new FormValidator($this, 'roleId', 'required', 'settings.roles.roleIdRequired'));
      }
      $this->addCheck(new FormValidatorPost($this));
   }

   //
   // Getters and Setters
   //
   function getUserGroupId() {
      return $this->_userGroupId;
   }

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

   //
   // Implement template methods from Form.
   //
   function getLocaleFieldNames() {
      return array('name', 'abbrev');
   }

   function initData() {
      $userGroupDao =& DAORegistry::getDAO('UserGroupDAO');
      $userGroup = $userGroupDao->getById($this->getUserGroupId());
      $stages = $userGroupDao->getWorkflowStageTranslationKeys();
      $this->setData('stages', $stages);
      $this->setData('assignedStages', array()); // sensible default

      if ($userGroup) {
         $assignedStages =& $userGroupDao->getAssignedStagesByUserGroupId($this->getPressId(), $userGroup->getId());

         $data = array(
            'userGroupId' => $userGroup->getId(),
            'roleId' => $userGroup->getRoleId(),
            'name' => $userGroup->getName(null), //Localized
            'abbrev' => $userGroup->getAbbrev(null), //Localized
            'assignedStages' => array_keys($assignedStages),
         );
         foreach ($data as $field => $value) {
            $this->setData($field, $value);
         }
      }
   }

   function readInputData() {
      $this->readUserVars(array('roleId', 'name', 'abbrev', 'assignedStages'));
   }

   function fetch(&$request) {
      $templateMgr =& TemplateManager::getManager();

      import('classes.security.RoleDAO');
      $roleOptions = RoleDAO::getRoleNames(true);
      $templateMgr->assign('roleOptions', $roleOptions);

      // Users can't edit the role once user group is created.
      // userGroupId is 0 for new User Groups because it is cast to int in UserGroupGridHandler.
      $disableRoleSelect = ($this->getUserGroupId() > 0) ? true : false;
      $templateMgr->assign('disableRoleSelect', $disableRoleSelect);

      return parent::fetch($request);
   }

   function execute(&$request) {
      $userGroupId = $this->getUserGroupId();
      $userGroupDao =& DAORegistry::getDAO('UserGroupDAO');

      // Check if we are editing an existing user group or creating another one.
      if ($userGroupId == null) {
         $userGroup = $userGroupDao->newDataObject();
         $role = new Role($this->getData('roleId'));
         $userGroup->setRoleId($role->getId());
         $userGroup->setContextId($this->getPressId());
         $userGroup->setPath($role->getPath());
         $userGroup->setDefault(false);
         $userGroup = $this->_setUserGroupLocaleFields($userGroup, $request);
         $userGroupId = $userGroupDao->insertUserGroup($userGroup);
      } else {
         $userGroup = $userGroupDao->getById($userGroupId);
         $userGroup = $this->_setUserGroupLocaleFields($userGroup, $request);
         $userGroupDao->updateLocaleFields($userGroup);
      }

      // After we have created/edited the user group, we assign/update its stages.
      if ($this->getData('assignedStages')) {
         $this->_assignStagesToUserGroup($userGroupId, $this->getData('assignedStages'));
      }
   }


   //
   // Private helper methods
   //
   function _assignStagesToUserGroup($userGroupId, $userAssignedStages) {
      $pressId = $this->getPressId();
      $userGroupDao =& DAORegistry::getDAO('UserGroupDAO');

      // Current existing workflow stages.
      $stages = $userGroupDao->getWorkflowStageTranslationKeys();

      foreach (array_keys($stages) as $stageId) {
         $userGroupDao->removeGroupFromStage($pressId, $userGroupId, $stageId);
      }

      foreach ($userAssignedStages as $stageId) {

         // Check if is a valid stage.
         if (in_array($stageId, array_keys($stages))) {
            $userGroupDao->assignGroupToStage($pressId, $userGroupId, $stageId);
         } else {
            fatalError('Invalid stage id');
         }
      }
   }

   function _setUserGroupLocaleFields($userGroup, &$request) {
      $router = $request->getRouter();
      $press = $router->getContext($request);
      $supportedLocales = $press->getSupportedLocaleNames();

      if (!empty($supportedLocales)) {
         foreach ($press->getSupportedLocaleNames() as $localeKey => $localeName) {
            $name = $this->getData('name');
            $abbrev = $this->getData('abbrev');
            $userGroup->setName($name[$localeKey], $localeKey);
            $userGroup->setAbbrev($abbrev[$localeKey], $localeKey);
         }
      } else {
         $localeKey = AppLocale::getLocale();
         $userGroup->setName($this->getData('name'), $localeKey);
         $userGroup->setAbbrev($this->getData('abbrev'), $localeKey);
      }

      return $userGroup;
   }
}

?>