class.UserManagerRDB.php

Go to the documentation of this file.

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2014 wemove digital solutions GmbH
 *
 * Licensed under the terms of any of the following licenses 
 * at your choice:
 *
 * - GNU Lesser General Public License (LGPL)
 *   http://www.gnu.org/licenses/lgpl.html
 * - Eclipse Public License (EPL)
 *   http://www.eclipse.org/org/documents/epl-v10.php
 *
 * See the license.txt file distributed with this work for 
 * additional information.
 *
 * $Id: class.UserManagerRDB.php 1462 2014-02-04 23:52:27Z iherwig $
 */
require_once(BASE."wcmf/lib/security/class.UserManager.php");
require_once(BASE."wcmf/lib/security/class.User.php");
require_once(BASE."wcmf/lib/security/class.Role.php");
require_once(BASE."wcmf/lib/persistence/class.PersistenceFacade.php");

/**
 * @class UserManagerRDB
 * @ingroup Security
 * @brief UserManagerRDB is a UserManager that stores user and role information in a database
 * using RDBMappers. The User and Role implementation classes are defined by the configuration
 * keys 'User' and 'Role' in the [implementation] section.
 *
 * @author      ingo herwig <ingo@wemove.com>
 */
class UserManagerRDB extends UserManager
{
  /**
   * @see UserManager::initialize()
   */
  function initialize($params)
  {
    $userRepository = array();
    
    $userClass = UserManager::getUserClassName();
    $roleClass = UserManager::getRoleClassName();
    
    // load the user/role instances
    $query = &PersistenceFacade::createObjectQuery($userClass);
    $users = $query->execute(BUILDDEPTH_SINGLE);
    $query = &PersistenceFacade::createObjectQuery($roleClass);
    $roles = $query->execute(BUILDDEPTH_SINGLE);

    // add the user/role instances to the repository
    $userRepository['users'] = array();
    for ($i=0, $count=sizeof($users); $i<$count; $i++) {
      if ($users[$i] != null) {
        $users[$i]->loadChildren($roleClass);
        $userRepository['users'][sizeof($userRepository['users'])] = &$users[$i];
      } 
    }
    for ($i=0, $count=sizeof($roles); $i<$count; $i++) {
      if ($roles[$i] != null) {
        $roles[$i]->loadChildren($userClass);
        $userRepository['roles'][sizeof($userRepository['roles'])] = &$roles[$i];
      }
    }
        return $userRepository;
  }

  /**
   * @see UserManager::createUserImpl()
   */
  function &createUserImpl($name, $firstname, $login, $password)
  {
    $persistenceFacade = &PersistenceFacade::getInstance();
    $user = &$persistenceFacade->create(UserManager::getUserClassName(), BUILDDEPTH_REQUIRED);
    $user->setName($name);
    $user->setFirstname($firstname);
    $user->setLogin($login);
    $user->setPassword($password);
    $user->save();

    return $user;
  }

  /**
   * @see UserManager::removeUserImpl()
   */  
  function removeUserImpl(&$user)
  {
    $user->delete();
  }

  /**
   * @see UserManager::setUserPropertyImpl()
   */  
  function setUserPropertyImpl(&$user, $property, $value)
  {
    $user->setValue($property, $value, DATATYPE_ATTRIBUTE);
    $user->save();
  }

  /**
   * @see UserManager::createRoleImpl()
   */  
  function &createRoleImpl($name)
  {
    $persistenceFacade = &PersistenceFacade::getInstance();
    $role = &$persistenceFacade->create($this->getRoleClassName(), BUILDDEPTH_REQUIRED);
    $role->setName($name);
    $role->save();

    return $role;
  }

  /**
   * @see UserManager::removeRoleImpl()
   */  
  function removeRoleImpl(&$role)
  {
    $role->delete();
  }

  /**
   * @see UserManager::setRolePropertyImpl()
   */  
  function setRolePropertyImpl(&$role, $property, $value)
  {
    $role->setValue($property, $value, DATATYPE_ATTRIBUTE);
    $role->save();
  }

  /**
   * @see UserManager::addUserToRoleImpl()
   */  
  function addUserToRoleImpl(&$role, &$user)
  {
    $user->addRole($role->getName(), true);
  }

  /**
   * @see UserManager::removeUserFromRoleImpl()
   */  
  function removeUserFromRoleImpl(&$role, &$user)
  {
    $user->removeRole($role->getName(), true);
  }
}
?>