\bridge_generic

Bridge Generic. Is abstract class, all Bridge have to extend this class.

Summary

Methods
Properties
Constants
__get()
__isset()
__dependencies()
__shortcuts()
__destruct()
__construct()
check_password()
sync_fields()
sync()
autologin()
logout()
before_login()
after_login()
login()
$dependencies
$shortcuts
$singleton
$class_hash
$data
$settings
$blnSyncEmail
No constants found
No protected methods found
$bridgedb
$prefix
N/A
No private methods found
$_shorts
$_shorts_loaded
$_class_index
N/A

Properties

$dependencies

$dependencies : 

Type

$shortcuts

$shortcuts : 

Type

$singleton

$singleton : 

Type

$class_hash

$class_hash : 

Type

$data

$data : array

Type

array — Contains Information about Tables to get the information

$settings

$settings : array

Type

array — Contains Bridge-specific Settings, like cookie domain etc.

$blnSyncEmail

$blnSyncEmail : boolean

Type

boolean — Set true if email adress should be synced from CMS

$bridgedb

$bridgedb : object

Type

object — Database Connection to CMS

$prefix

$prefix : string

Type

string — Prefix of CMS

$_shorts

$_shorts : 

Type

$_shorts_loaded

$_shorts_loaded : 

Type

$_class_index

$_class_index : 

Type

Methods

__get()

__get(  $name) 

Parameters

$name

__isset()

__isset(  $name) 

Parameters

$name

__dependencies()

__dependencies() 

__shortcuts()

__shortcuts() 

__destruct()

__destruct() 

__construct()

__construct(object  $objBridgeDB, string  $strPrefix) 

Constructor

Parameters

object $objBridgeDB
string $strPrefix

check_password()

check_password(string  $password, string  $hash, string  $strSalt = '', boolean  $boolUseHash = false, string  $strUsername = "",   $arrUserdata = array()) : boolean

Check if Password matches with saved Hash

Parameters

string $password

Password

string $hash

Saved Passwordhash

string $strSalt

Saved Salt

boolean $boolUseHash

if $password is a hash or not

string $strUsername

Username

$arrUserdata

Returns

boolean —

true if password matches

sync_fields()

sync_fields() : array

Returns Array with fields that are available to sync Key = fieldid of CMS Value = Name of Field

Returns

array —

Available Fields for Synching

sync()

sync(array  $arrUserdata) : \boolean/array

Returns Array with synched Userdata.

Please return all data, the Bridge Class handles the matching to the profilefields. If you want to sync birthday and country, add key "birthday" and "country" Key = fieldid of CMS Value = fieldvalue

Parameters

array $arrUserdata

Userdata of CMS

Returns

\boolean/array —

Return false if sync is disabled, otherwise return array with synced data

autologin()

autologin(array  $arrCookiedata) : \boolean/array

Autologin. Log User into EQdkp Using Session Information from CMS

Parameters

array $arrCookiedata

Cookiedata of EQdkp Autologin Cookie

Returns

\boolean/array —

Return false if autologin failed, otherwise array with EQdkp Userdata

logout()

logout() : boolean

Logout. Should be used to Logout User from CMS

Returns

boolean

before_login()

before_login(string  $strUsername, string  $strPassword, boolean  $boolSetAutologin = false, boolean  $boolUseHash = false) 

Fired before login. No return value, no influence to login.

Parameters

string $strUsername
string $strPassword
boolean $boolSetAutologin
boolean $boolUseHash

after_login()

after_login(string  $strUsername, string  $strPassword, boolean  $boolSetAutoLogin, array  $arrUserdata, boolean  $boolLoginResult, string  $boolUseHash = false) : boolean

Do some checks after User Passwordchecks.

Returning false prevents user from being logged into EQdkp.

Parameters

string $strUsername
string $strPassword
boolean $boolSetAutoLogin
array $arrUserdata
boolean $boolLoginResult
string $boolUseHash

Returns

boolean —

True if user should be logged in, false if not

login()

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

Login method. Should only be overwritten if default login of Bridge is not enough for you.

Parameters

string $strUsername
string $strPassword
boolean $boolSetAutologin
boolean $boolUseHash

Returns

boolean —

Return 0 is default login should be used. Otherwise return a boolean for the login status.