Properties

$sid

$sid : 

Type

$data

$data : 

Type

$id

$id : 

Type

$blnFirstVisit

$blnFirstVisit : 

Type

$dependencies

$dependencies : 

Type

$normalUserTableFields

$normalUserTableFields : 

Type

$style

$style : 

Type

$lang_name

$lang_name : 

Type

$objLanguage

$objLanguage : 

Type

$shortcuts

$shortcuts : 

Type

$singleton

$singleton : 

Type

$class_hash

$class_hash : 

Type

$error

$error : 

Type

$current_time

$current_time : 

Type

$session_length

$session_length : 

Type

$settings

$settings : 

Type

$lang

$lang : 

Type

$_shorts

$_shorts : 

Type

$_shorts_loaded

$_shorts_loaded : 

Type

$_class_index

$_class_index : 

Type

Methods

__dependencies()

__dependencies() 

__construct()

__construct() 

Constructor

start()

start() : true

Initiates the whole Session-Thing

Returns

true

create()

create(  $user_id,   $strAutologinKey,   $boolSetAutoLogin = false,   $strOldSessionKey = false) : true

Creates a new Session, sets the cookies,

Parameters

$user_id
$strAutologinKey
$boolSetAutoLogin
$strOldSessionKey

Returns

true

destroy()

destroy() : true

Destroy the session of the current user

Returns

true

destroy_session()

destroy_session(  $strSID) : true

Destroys a specific Session

Parameters

$strSID

Returns

true

destroyUserSessions()

destroyUserSessions(integer  $intUserID) : boolean

Destroys all sessions of given UserID

Parameters

integer $intUserID

Returns

boolean

destroyOtherSessions()

destroyOtherSessions(integer  $intUserID = false) 

Destroys all other sessions but the current one of a given user

Parameters

integer $intUserID

getAllUserSessions()

getAllUserSessions(integer  $intUserID = false) 

Get all running sessions of a given user

Parameters

integer $intUserID

changeSessionUser()

changeSessionUser(integer  $intUserID) 

Changes User of the current Session

Parameters

integer $intUserID

cleanup()

cleanup(  $intTime) : true

Deletes old Sessions and updating of last-visit-date of the uers

Parameters

$intTime

Returns

true

check_session()

check_session(  $sid) : \$user_id

Checks if a session is valid and returns the user_id

Parameters

$sid

Session-ID

Returns

\$user_id —

Returns the User-ID

removeSIDfromString()

removeSIDfromString(  $string) 

Parameters

$string

generate_session_key()

generate_session_key() : string

Generates new Session Key for insertion

Returns

string

csrfGetToken()

csrfGetToken(  $strAction) : string

CSRF GET Token

Parameters

$strAction

Returns

string

checkCsrfGetToken()

checkCsrfGetToken(  $strToken,   $strAction) : string

Check CSRF GET Token

Parameters

$strToken
$strAction

Returns

string

csrfPostToken()

csrfPostToken(  $blnReturnOld = false) : string

CSRF POST Token

Parameters

$blnReturnOld

Returns

string

checkCsrfPostToken()

checkCsrfPostToken(  $strToken) : string

Check CSRF POST Token

Parameters

$strToken

Returns

string

overtake_permissions()

overtake_permissions(  $intUserID) 

Overtake the permissions of another User

Parameters

$intUserID

User-ID you want to overtake the permissions from

restore_permissions()

restore_permissions() 

Restore your own permissions

setSessionVar()

setSessionVar(  $strVarname,   $strValue) 

Parameters

$strVarname
$strValue

logout()

logout() 

Attempt to log out a user

get_available_loginmethods()

get_available_loginmethods() 

get_active_loginmethods()

get_active_loginmethods() 

get_loginmethod_settings()

get_loginmethod_settings() 

get_loginmethod_options()

get_loginmethod_options() 

handle_login_functions()

handle_login_functions(  $method,   $loginMethod = false,   $arrOptions = false) 

Parameters

$method
$loginMethod
$arrOptions

get_login_objects()

get_login_objects(  $loginMethod = false) 

Parameters

$loginMethod

get_available_authmethods()

get_available_authmethods() 

get_authmethod_settings()

get_authmethod_settings() 

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

__destruct()

__destruct() 

__get()

__get(  $name) 

Parameters

$name

__isset()

__isset(  $name) 

Parameters

$name

__shortcuts()

__shortcuts() 

pdl_html_format_login()

pdl_html_format_login(  $log_entry) 

Parameters

$log_entry

login()

login(  $strUsername,   $strPassword,   $boolSetAutoLogin = false,   $boolUseHash = false) : boolean

Attempt to log in a user

Parameters

$strUsername
$strPassword
$boolSetAutoLogin

Save login in cookie?

$boolUseHash

Use Hash for comparing

Returns

boolean

autologin()

autologin(  $arrCookieData) : boolean

Autologin

Parameters

$arrCookieData

The Data ot the Session-Cookies

Returns

boolean