Docs For Class UserAdminService

Description

DO NOT USE THIS CLASS ANY LONGER, IT WILL BE REMOVED IN ONE OF THE NEXT VERSIONS!

Use PrincipalService instead:

 $services = ServiceFactory::get();
 $principalService = $services->getPrincipalService();

version: $Id: UserAdminService.php,v 1.6 2006/11/26 22:04:22 kpapst Exp $
copyright: Copyright (C) 2002-2006 Kevin Papst
author: Kevin Papst
license: GNU Public License
deprecated:

Method Summary

UserAdminService UserAdminService ()

void activateUser ( $id)

void changePassword ( $id, $newpass)

boolean checkIfUsernameExists (String $name)

int createUser (String $username, String $password, [int $language = 'en'], [boolean $aktiv = false], $groupID)

void deactivateUser ( $id)

mixed deleteUser (int $id)

Methods

Constructor UserAdminService (line 50)

UserAdminService UserAdminService ()

activateUser (line 127)

deprecated:

void activateUser ( $id)

$id

changePassword (line 75)

deprecated:

void changePassword ( $id, $newpass)

$id
$newpass

checkIfUsernameExists (line 141)

Checks if the given Username exists.

return: true if Username allready exists, else false
deprecated:

boolean checkIfUsernameExists (String $name)

String $name: the name that you want to test about its existence

createUser (line 92)

This creates a User within BIGACE.

return: the ID for the new generated User
deprecated:

int createUser (String $username, String $password, [int $language = 'en'], [boolean $aktiv = false], $groupID)

String $username: the Username
String $password: the password (will be crypted while saving to DB)
int $language: the language ID
boolean $aktiv: A boolean representing rhe Active Status for this User within BIGACE
$groupID

deactivateUser (line 116)

deprecated:

void deactivateUser ( $id)

$id

deleteUser (line 62)

Deletes the given User.

This will not work for the BIGACE and ANONYMOUS USER! We do not have to delete any right, because each user has a group and the rights are group dependend!

return: the result of this deletion process
deprecated:

mixed deleteUser (int $id)

int $id: the User ID for the User that will be deleted