[class tree: bigace-classes] [index: bigace-classes] [all elements]

Class: UserAdminService

Source Location: /CORE/system/classes/user/UserAdminService.php

Class UserAdminService

Class Overview

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();

Located in /CORE/system/classes/user/UserAdminService.php [line 48]

Author(s):

Kevin Papst

API Tags:

Deprecated:

Information Tags:

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

Methods

[ Top ]

Method Summary

UserAdminService	UserAdminService()
void	activateUser()
void	changePassword()
boolean	checkIfUsernameExists()	Checks if the given Username exists.
int	createUser()	This creates a User within BIGACE.
void	deactivateUser()
mixed	deleteUser()	Deletes the given User.

[ Top ]

Methods

Constructor UserAdminService [line 50]

UserAdminService UserAdminService(
)

[ Top ]

activateUser [line 127]

void activateUser(

$id 
)

Parameters:

$id:

API Tags:

Deprecated:

[ Top ]

changePassword [line 75]

void changePassword(

$id, 
$newpass 
)

Parameters:

	$id:
	$newpass:

API Tags:

Deprecated:

[ Top ]

checkIfUsernameExists [line 141]

boolean checkIfUsernameExists(
String
$name 
)

Checks if the given Username exists.

Parameters:

String

$name:

the name that you want to test about its existence

API Tags:

Return:	true if Username allready exists, else false
Deprecated:

[ Top ]

createUser [line 92]

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

This creates a User within BIGACE.

Parameters:

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:

API Tags:

Return:	the ID for the new generated User
Deprecated:

[ Top ]

deactivateUser [line 116]

void deactivateUser(

$id 
)

Parameters:

$id:

API Tags:

Deprecated:

[ Top ]

deleteUser [line 62]

mixed deleteUser(
int
$id 
)

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!

Parameters:

int

$id:

the User ID for the User that will be deleted

API Tags:

Return:	the result of this deletion process
Deprecated:

[ Top ]