FrontEndUsers 1.31
\

\FrontEndUsers

The FrontEndUsers module, besides being a module to provide authentication services to the frontend of a CMSMS website also has a complete and flexible API.

Summary

Methods
Properties
Constants
AddGroup()
AddGroupPropertyRelation()
AddPropertyDefn()
AddSelectOptions()
AddUser()
AssignUserToGroup()
CountTempCodeRecords()
CountUsersInGroup()
DeleteAllGroupPropertyRelations()
DeleteAllGroupPropertyRelation()
DeletePropertyDefn()
DeletePropertyDefns()
DeleteSelectOptions()
DeleteUserFull()
DeleteUserPropertyByName()
DeleteUserProperty()
DeleteAllUserProperties()
DeleteAllUserPropertiesFull()
DeleteUserPropertyFull()
DeleteGroupFull()
DeleteUser()
ExpireUsers()
ExpireTempCodes()
GenerateRandomUsername()
GetUserProperties()
GetMemberGroupsArray()
GetUserProperty()
GetUserPropertyFull()
GetUserTempCode()
GetPropertyGroupRelations()
GetUserPropertyRelations()
GetGroupPropertyRelations()
GetGroupInfo()
GetUserHistory()
GetLoggedInUsers()
GetBulkUserInfo()
GetUserInfo()
GetUserInfoByName()
GetFullUsersInGroup()
GetUsersInGroup()
get_lastuserquery_matches()
get_lastuserquery_count()
reset_lastuserquery()
GroupExistsByID()
GroupExistsByName()
LoggedInEmail()
GetEmail()
ClearPropertyCache()
GetPropertyDefns()
GetPropertyDefn()
GetSelectOptions()
GetUserName()
GetUserID()
GetGroupName()
GetGroupDesc()
GetGroupList()
GetGroupListFull()
GetGroupID()
GetMemberGroups()
GetExpiryDate()
IsAccountExpired()
IsValidPassword()
GetUsernamePrompt()
IsValidEmailAddress()
IsValidUsername()
CheckPassword()
Login()
LoggedInName()
Logout()
LogoutUser()
LoggedInId()
LoggedIn()
MemberOfGroup()
RemoveUserTempCode()
RemoveUserFromGroup()
SetUserTempCode()
SetPropertyDefn()
SetPropertyDefnExtra()
SetGroup()
EncryptPassword()
SetUserPassword()
SetUserDisabled()
ForcePasswordChange()
ForceChangeSettings()
SetUser()
SetUserGroups()
AddUserToGroup()
SetUserProperties()
SetUserProperty()
IsUserPropertyValueUnique()
SetUserPropertyFull()
UserExistsByID()
SetEncryptionKey()
No public properties found
FIELDTYPE_TEXT
FIELDTYPE_CHECKBOX
FIELDTYPE_EMAIL
FIELDTYPE_TEXTAREA
FIELDTYPE_DROPDOWN
FIELDTYPE_MULTISELECT
FIELDTYPE_IMAGE
FIELDTYPE_RADIOBUTNS
FIELDTYPE_DATE
FIELDTYPE_DATA
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

FIELDTYPE_TEXT

FIELDTYPE_TEXT

Constant to indentify a text property.

FIELDTYPE_CHECKBOX

FIELDTYPE_CHECKBOX

Constant to indentify a checkbox property.

FIELDTYPE_EMAIL

FIELDTYPE_EMAIL

Constant to indentify an email property.

FIELDTYPE_TEXTAREA

FIELDTYPE_TEXTAREA

Constant to indentify a textarea property.

FIELDTYPE_DROPDOWN

FIELDTYPE_DROPDOWN

Constant to indentify a dropdown property.

FIELDTYPE_MULTISELECT

FIELDTYPE_MULTISELECT

Constant to indentify a multiselect property.

FIELDTYPE_IMAGE

FIELDTYPE_IMAGE

Constant to indentify an image property.

FIELDTYPE_RADIOBUTNS

FIELDTYPE_RADIOBUTNS

Constant to indentify a radio button group property.

FIELDTYPE_DATE

FIELDTYPE_DATE

Constant to indentify a date property.

FIELDTYPE_DATA

FIELDTYPE_DATA

Constant to indentify a data property.

Methods

AddGroup()

AddGroup(string $name, string $description) : array

Add a new group

Parameters

string $name

The group name
string $description

The group description

Returns

array —

Array containing two elements. The first element is the return status of the function (boolean), the second element is either a message in the case of an error, or the group id (integer) on success.

AddGroupPropertyRelation()

AddGroupPropertyRelation( $grpid,  $propname,  $sortkey,  $lostun,  $val)

Parameters

$grpid
$propname
$sortkey
$lostun
$val

AddPropertyDefn()

AddPropertyDefn( $name,  $prompt,  $type,  $length,  $maxlength,  $attribs,  $force_unique,  $encrypt)

Parameters

$name
$prompt
$type
$length
$maxlength
$attribs
$force_unique
$encrypt

AddSelectOptions()

AddSelectOptions( $name,  $seloptions)

Parameters

$name
$seloptions

AddUser()

AddUser( $name,  $password,  $expires)

Parameters

$name
$password
$expires

AssignUserToGroup()

AssignUserToGroup( $uid,  $gid)

Parameters

$uid
$gid

CountTempCodeRecords()

CountTempCodeRecords()

CountUsersInGroup()

CountUsersInGroup( $gid)

Parameters

$gid

DeleteAllGroupPropertyRelations()

DeleteAllGroupPropertyRelations( $grpid)

Parameters

$grpid

DeleteAllGroupPropertyRelation()

DeleteAllGroupPropertyRelation( $grpid,  $propname)

Parameters

$grpid
$propname

DeletePropertyDefn()

DeletePropertyDefn( $name)

Parameters

$name

DeletePropertyDefns()

DeletePropertyDefns()

DeleteSelectOptions()

DeleteSelectOptions( $name)

Parameters

$name

DeleteUserFull()

DeleteUserFull( $uid)

Parameters

$uid

DeleteUserPropertyByName()

DeleteUserPropertyByName( $title)

Parameters

$title

DeleteUserProperty()

DeleteUserProperty( $title,  $all)

Parameters

$title
$all

DeleteAllUserProperties()

DeleteAllUserProperties()

DeleteAllUserPropertiesFull()

DeleteAllUserPropertiesFull( $userid)

Parameters

$userid

DeleteUserPropertyFull()

DeleteUserPropertyFull( $title,  $userid,  $all)

Parameters

$title
$userid
$all

DeleteGroupFull()

DeleteGroupFull( $gid)

Parameters

$gid

DeleteUser()

DeleteUser( $id)

Parameters

$id

ExpireUsers()

ExpireUsers()

ExpireTempCodes()

ExpireTempCodes( $expirycode)

Parameters

$expirycode

GenerateRandomUsername()

GenerateRandomUsername( $prefix)

Parameters

$prefix

GetUserProperties()

GetUserProperties( $uid)

Parameters

$uid

GetMemberGroupsArray()

GetMemberGroupsArray( $userid)

Parameters

$userid

GetUserProperty()

GetUserProperty( $title,  $defaultvalue)

Parameters

$title
$defaultvalue

GetUserPropertyFull()

GetUserPropertyFull( $title,  $userid,  $defaultvalue)

Parameters

$title
$userid
$defaultvalue

GetUserTempCode()

GetUserTempCode( $uid)

Parameters

$uid

GetPropertyGroupRelations()

GetPropertyGroupRelations( $title)

Parameters

$title

GetUserPropertyRelations()

GetUserPropertyRelations( $uid)

Parameters

$uid

GetGroupPropertyRelations()

GetGroupPropertyRelations( $grpid)

Parameters

$grpid

GetGroupInfo()

GetGroupInfo( $gid)

Parameters

$gid

GetUserHistory()

GetUserHistory( $uid,  $action,  $count)

Parameters

$uid
$action
$count

GetLoggedInUsers()

GetLoggedInUsers( $not_active_since)

Parameters

$not_active_since

GetBulkUserInfo()

GetBulkUserInfo( $uids,  $deep)

Parameters

$uids
$deep

GetUserInfo()

GetUserInfo( $uid,  $deep)

Parameters

$uid
$deep

GetUserInfoByName()

GetUserInfoByName( $username)

Parameters

$username

GetFullUsersInGroup()

GetFullUsersInGroup( $gid)

Parameters

$gid

GetUsersInGroup()

GetUsersInGroup( $gid,  $regex,  $limit,  $sort,  $property,  $propregex,  $loggedinonly,  $start_record)

Parameters

$gid
$regex
$limit
$sort
$property
$propregex
$loggedinonly
$start_record

get_lastuserquery_matches()

get_lastuserquery_matches()

get_lastuserquery_count()

get_lastuserquery_count()

reset_lastuserquery()

reset_lastuserquery()

GroupExistsByID()

GroupExistsByID( $gid)

Parameters

$gid

GroupExistsByName()

GroupExistsByName( $name)

Parameters

$name

LoggedInEmail()

LoggedInEmail()

GetEmail()

GetEmail( $uid)

Parameters

$uid

ClearPropertyCache()

ClearPropertyCache()

GetPropertyDefns()

GetPropertyDefns()

GetPropertyDefn()

GetPropertyDefn( $name)

Parameters

$name

GetSelectOptions()

GetSelectOptions( $name,  $dim)

Parameters

$name
$dim

GetUserName()

GetUserName( $userid)

Parameters

$userid

GetUserID()

GetUserID( $username)

Parameters

$username

GetGroupName()

GetGroupName( $groupid)

Parameters

$groupid

GetGroupDesc()

GetGroupDesc( $groupid)

Parameters

$groupid

GetGroupList()

GetGroupList()

GetGroupListFull()

GetGroupListFull( $with_count)

Parameters

$with_count

GetGroupID()

GetGroupID( $groupname)

Parameters

$groupname

GetMemberGroups()

GetMemberGroups( $userid)

Parameters

$userid

GetExpiryDate()

GetExpiryDate( $uid)

Parameters

$uid

IsAccountExpired()

IsAccountExpired( $uid)

Parameters

$uid

IsValidPassword()

IsValidPassword( $password)

Parameters

$password

GetUsernamePrompt()

GetUsernamePrompt()

IsValidEmailAddress()

IsValidEmailAddress( $email,  $uid,  $check_existing)

Parameters

$email
$uid
$check_existing

IsValidUsername()

IsValidUsername( $username,  $check,  $uid)

Parameters

$username
$check
$uid

CheckPassword()

CheckPassword( $username,  $password,  $groups)

Parameters

$username
$password
$groups

Login()

Login( $username,  $password,  $groups,  $md5pw,  $force_logout)

Parameters

$username
$password
$groups
$md5pw
$force_logout

LoggedInName()

LoggedInName()

Logout()

Logout( $uid,  $message)

Parameters

$uid
$message

LogoutUser()

LogoutUser( $uid,  $eventmsg)

Parameters

$uid
$eventmsg

LoggedInId()

LoggedInId()

LoggedIn()

LoggedIn()

MemberOfGroup()

MemberOfGroup( $userid,  $groupid)

Parameters

$userid
$groupid

RemoveUserTempCode()

RemoveUserTempCode( $uid)

Parameters

$uid

RemoveUserFromGroup()

RemoveUserFromGroup( $uid,  $gid)

Parameters

$uid
$gid

SetUserTempCode()

SetUserTempCode( $uid,  $code)

Parameters

$uid
$code

SetPropertyDefn()

SetPropertyDefn( $name,  $newname,  $prompt,  $length,  $type,  $maxlength,  $attribs,  $force_unique,  $encrypt)

Parameters

$name
$newname
$prompt
$length
$type
$maxlength
$attribs
$force_unique
$encrypt

SetPropertyDefnExtra()

SetPropertyDefnExtra( $name,  $extra)

Parameters

$name
$extra

SetGroup()

SetGroup( $gid,  $name,  $desc)

Parameters

$gid
$name
$desc

EncryptPassword()

EncryptPassword( $uid,  $plain_password)

Parameters

$uid
$plain_password

SetUserPassword()

SetUserPassword( $uid,  $password)

Parameters

$uid
$password

SetUserDisabled()

SetUserDisabled( $uid,  $flag)

Parameters

$uid
$flag

ForcePasswordChange()

ForcePasswordChange( $uid,  $flag)

Parameters

$uid
$flag

ForceChangeSettings()

ForceChangeSettings( $uid,  $flag)

Parameters

$uid
$flag

SetUser()

SetUser( $uid,  $username,  $password,  $expires)

Parameters

$uid
$username
$password
$expires

SetUserGroups()

SetUserGroups( $uid,  $grpids)

Parameters

$uid
$grpids

AddUserToGroup()

AddUserToGroup( $uid,  $gid) : boolean

Add user to a group

does not effect user properties does not validate gid userid is validated

Parameters

$uid
$gid

Returns

boolean

SetUserProperties()

SetUserProperties( $uid,  $props)

Parameters

$uid
$props

SetUserProperty()

SetUserProperty( $title,  $data)

Parameters

$title
$data

IsUserPropertyValueUnique()

IsUserPropertyValueUnique( $uid,  $title,  $value)

Parameters

$uid
$title
$value

SetUserPropertyFull()

SetUserPropertyFull( $title,  $data,  $userid)

Parameters

$title
$data
$userid

UserExistsByID()

UserExistsByID( $uid)

Parameters

$uid

SetEncryptionKey()

SetEncryptionKey( $uid,  $force)

Parameters

$uid
$force