\user

Summary

Methods

Properties

Constants

__get()
__isset()
__dependencies()
__shortcuts()
__destruct()
__construct()
getUserIDfromExchangeKey()
deriveKeyFromExchangekey()
getUserIDfromDerivedExchangekey()
is_signedin()
setup()
lang()
check_auth()
check_auths()
check_group()
check_pageobject()
check_pageobjects()
fireHooks()
updateAutologinKey()
encrypt_password()
checkPassword()
checkIfHashNeedsUpdate()
generate_salt()
get_settingsdata()
getAvailableLanguages()
multilangValue()
getAvatarProviders()
registerUserFromAuthProvider()

$dependencies
$shortcuts
$singleton
$class_hash
$normalUserTableFields
$style
$lang_name
$objLanguage

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$_shorts
$_shorts_loaded
$_class_index
$lang

N/A

File: core/user.class.php
Package: Default
Class hierarchy: \gen_class

\user

Properties

$dependencies

$dependencies :

Type

$shortcuts

$shortcuts :

Type

$singleton

$singleton :

Type

$class_hash

$class_hash :

Type

$normalUserTableFields

$normalUserTableFields :

Type

$style

$style :

Type

$lang_name

$lang_name :

Type

$objLanguage

$objLanguage :

Type

$_shorts

$_shorts :

Type

$_shorts_loaded

$_shorts_loaded :

Type

$_class_index

$_class_index :

Type

$lang

$lang :

Type

Methods

__get()

__get(  $name)

Parameters

$name

__isset()

__isset(  $name)

Parameters

$name

__dependencies()

__dependencies()

__shortcuts()

__shortcuts()

__destruct()

__destruct()

__construct()

__construct()

Constructor

getUserIDfromExchangeKey()

getUserIDfromExchangeKey(  $strKey)

Parameters

$strKey

deriveKeyFromExchangekey()

deriveKeyFromExchangekey(  $userID,   $strDerivedType)

Parameters

	$userID
	$strDerivedType

getUserIDfromDerivedExchangekey()

getUserIDfromDerivedExchangekey(  $strDerivedKey,   $strDerivedType)

Parameters

	$strDerivedKey
	$strDerivedType

is_signedin()

is_signedin()

setup()

setup(  $strLanguage = '',   $intStyleID)

Sets up user-data like language and style

Parameters

	$strLanguage	Language to set
	$intStyleID	Style ID to set

lang()

lang(  $key,   $return_key = false,   $error = true,   $lang = false,   $error_key = '')

Parameters

	$key
	$return_key
	$error
	$lang
	$error_key

check_auth()

check_auth(  $strAuthValue,   $boolDie = true,   $intUserID,   $boolGroups = true) : boolean

Checks if a user has permission to do ($auth_value)

Parameters

	$strAuthValue
	$boolDie
	$intUserID
	$boolGroups

Returns

boolean

check_auths()

check_auths(  $arrAuths,   $mode = 'AND',   $boolDie = true,   $intUserID,   $boolGroups = true) : boolean

Checks if a user has all (AND) or one (OR) of the required permissions

Parameters

	$arrAuths	Array of Permission we want to check
	$mode
	$boolDie
	$intUserID
	$boolGroups

Returns

boolean

check_group()

check_group(  $intGroupID,   $boolDie = true,   $intUserID) : boolean

Checks if a user is a member of the group

Parameters

	$intGroupID
	$boolDie
	$intUserID

Returns

boolean

check_pageobject()

check_pageobject(  $strPageObject,   $boolDie = true,   $intUserID)

Parameters

	$strPageObject
	$boolDie
	$intUserID

check_pageobjects()

check_pageobjects(  $arrPageObjects,   $mode = 'AND',   $boolDie = true,   $intUserID)

Parameters

	$arrPageObjects
	$mode
	$boolDie
	$intUserID

fireHooks()

fireHooks()

updateAutologinKey()

updateAutologinKey(  $intUserID,   $strAutologinKey)

Parameters

	$intUserID
	$strAutologinKey

encrypt_password()

encrypt_password(  $strPassword,   $strSalt = '',   $strMethod = '') : string

Function to abstract password encryption

Parameters

	$strPassword
	$strSalt
	$strMethod

Returns

string

checkPassword()

checkPassword(  $strPassword,   $strStoredHash,   $blnUseHash = false,   $blnReturnHash = false)

Parameters

	$strPassword
	$strStoredHash
	$blnUseHash
	$blnReturnHash

checkIfHashNeedsUpdate()

checkIfHashNeedsUpdate(  $strHash)

Parameters

$strHash

generate_salt()

generate_salt() : string

Generate Salt

Returns

string

get_settingsdata()

get_settingsdata(  $user_id = -1)

Generate User-Settings

Parameters

$user_id

getAvailableLanguages()

getAvailableLanguages(  $blnWithIsoShort = true,   $blnWithIcon = false,   $blnIsoAsKey = false)

Parameters

	$blnWithIsoShort
	$blnWithIcon
	$blnIsoAsKey

multilangValue()

multilangValue(  $strRawContent)

Parameters

$strRawContent

getAvatarProviders()

getAvatarProviders(  $blnForUsersettings = false)

Returns all available Avatar Providers, including their Settings

Parameters

$blnForUsersettings

registerUserFromAuthProvider()

registerUserFromAuthProvider(  $arrAccountDetails,   $strAuthMethod)

Parameters

	$arrAccountDetails
	$strAuthMethod