ePages 6.17.52 - DE_EPAGES/Presentation/API/User.pm

Package DE_EPAGES::Presentation::API::User

This package provides an interface for User in Sessions. Note: Use $Servlet->createAnonymousUser($Site) to create a new session and a User object without login. See DE_EPAGES::Presentation::Servlet::Permission::createAnonymousUser.

@EXPORT_OK
CreateUser
ExistsUser
ExistsUserByEMail
GetUser
GetUserFolder
GetUsersByEMail

Functions

CreateUser
ExistsUser
ExistsUserByEMail
GetUser
GetUserFolder
GetUsersByEMail

CreateUser

Generates a registered user.

Syntax
$User = CreateUser($Site, $hInfo);
Input
$Site (object)
Site object (e.g. shop or system) of new user
$hInfo (ref.hash)
user attributes like Alias/Password
Return
$User (object)
a new user

ExistsUser

Looks if a registered user with the given login exists in the site.

Syntax
$Exists = ExistsUser($Site, $Alias);
Input
$Site (object)
Site object (e.g. shop or system)
$Alias (ref.hash)
login of user
Return
$Exists (boolean)
exists user

ExistsUserByEMail

Looks if a registered user with the given login or email exists in the site.

Syntax
$Exists = ExistsUserByEMail($Site, $Alias);
Input
$Site (object)
Site object (e.g. shop or system)
$EMail (ref.hash)
login/email of user
Return
$Exists (boolean)
exists user

GetUser

Returns a registered user exists by login.

Syntax
$User = GetUser($Site, $Alias);
Input
$Site (object)
Site object (e.g. shop or system) of the user
$Alias (ref.hash)
login of user
Return
$User (object)
a registered user

GetUserFolder

Returns the folder for registered users of the site.

Syntax
$Folder = GetUserFolder($Site);
Input
$Site (object)
Site object (e.g. shop or system)
Return
$Folder (object)
a folder object

GetUsersByEMail

Returns all users by email.

Syntax
$aUsers = GetUsersByEMail($EMail, $Site);
Input
$EMail (ref.hash)
email or login of user
$Site (object)
Site object (e.g. shop or system) of the user
Return
$aUsers (array.object)
users