vB_Library_ExternalLogin
extends vB_Library
in package
Uses
vB_Trait_NoSerialize
vB_Library_Auth
Tags
Table of Contents
- $instance : mixed
- $loginlibraryid : mixed
- $productid : mixed
- __construct() : mixed
- __serialize() : mixed
- __sleep() : mixed
- __unserialize() : mixed
- __wakeup() : mixed
- clearCache() : mixed
- createLoginLibraryId() : mixed
- formatPersonalDataForExport() : array<string|int, mixed>
- Given userauth record & the loginlibrary data, fetch any additional personal data stored for the user & format it for export.
- getContentInstance() : mixed
- getPersonalData() : mixed
- getSessionAuthRecord() : mixed
- getUserAuthRecord() : mixed
- instance() : vB_PageCache
- Returns singleton instance of self.
- linkCurrentUserWithApp() : mixed
- loginUser() : mixed
- monitorWords() : mixed
- Checks if the text contains monitored words, and if so, sends notifications to admins and moderators if the setting is on.
- postUserDelete() : mixed
- saveUserLink() : mixed
- unlinkCurrentUserFromApp() : mixed
- checkExternalUseridAvailability() : mixed
- checkLinkSuccess() : mixed
- deleteSessionAuthRecord() : mixed
- deleteUserAuthRecord() : mixed
- getLibraryClassNameInternal() : mixed
- getLoginLibraryId() : mixed
- getNonce() : mixed
- removeExpiredSessionAuths() : mixed
- updateSessionAuthRecord() : mixed
- updateUserAuthRecord() : mixed
Properties
$instance
protected
static mixed
$instance
= array()
$loginlibraryid
protected
mixed
$loginlibraryid
$productid
protected
mixed
$productid
Methods
__construct()
public
__construct() : mixed
Return values
mixed —__serialize()
public
__serialize() : mixed
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —__unserialize()
public
__unserialize(mixed $serialized) : mixed
Parameters
- $serialized : mixed
Return values
mixed —__wakeup()
public
__wakeup() : mixed
Return values
mixed —clearCache()
public
static clearCache() : mixed
Return values
mixed —createLoginLibraryId()
public
final createLoginLibraryId([mixed $productid = "" ][, mixed $class = "" ]) : mixed
Parameters
- $productid : mixed = ""
- $class : mixed = ""
Return values
mixed —formatPersonalDataForExport()
Given userauth record & the loginlibrary data, fetch any additional personal data stored for the user & format it for export.
public
formatPersonalDataForExport( $userauth) : array<string|int, mixed>
Parameters
- $userauth :
-
array
userauthandloginlibrarydata for the user, including the following data:- int userid
- string external_userid
- array additional_params
- string token
- string token_secret
- int loginlibraryid
- int productid
- string class
Return values
array<string|int, mixed> —each key should be a phrase title, and value should be the stored data
getContentInstance()
public
static getContentInstance(mixed $contenttypeid) : mixed
Parameters
- $contenttypeid : mixed
Return values
mixed —getPersonalData()
public
final getPersonalData(mixed $userid) : mixed
Parameters
- $userid : mixed
Return values
mixed —getSessionAuthRecord()
public
final getSessionAuthRecord([mixed $token = null ]) : mixed
Parameters
- $token : mixed = null
Return values
mixed —getUserAuthRecord()
public
final getUserAuthRecord([mixed $external_userid = null ][, mixed $token = null ][, mixed $userid = null ]) : mixed
Parameters
- $external_userid : mixed = null
- $token : mixed = null
- $userid : mixed = null
Return values
mixed —instance()
Returns singleton instance of self.
public
static instance(mixed $class) : vB_PageCache
Parameters
- $class : mixed
Return values
vB_PageCache —- Reference to singleton instance of the cache handler
linkCurrentUserWithApp()
public
linkCurrentUserWithApp([mixed $params = array() ]) : mixed
Parameters
- $params : mixed = array()
Return values
mixed —loginUser()
public
final loginUser(mixed $vbuserid) : mixed
Parameters
- $vbuserid : mixed
Return values
mixed —monitorWords()
Checks if the text contains monitored words, and if so, sends notifications to admins and moderators if the setting is on.
public
monitorWords(mixed $text, mixed $type, mixed $nodeid[, mixed $userid = null ][, mixed $insertNotifications = true ], mixed $currentuserid) : mixed
Parameters
- $text : mixed
- $type : mixed
- $nodeid : mixed
- $userid : mixed = null
- $insertNotifications : mixed = true
- $currentuserid : mixed
Return values
mixed —postUserDelete()
public
postUserDelete(mixed $userid) : mixed
Parameters
- $userid : mixed
Return values
mixed —saveUserLink()
public
saveUserLink(mixed $userAuth) : mixed
Parameters
- $userAuth : mixed
Return values
mixed —unlinkCurrentUserFromApp()
public
unlinkCurrentUserFromApp([mixed $params = array() ]) : mixed
Parameters
- $params : mixed = array()
Return values
mixed —checkExternalUseridAvailability()
protected
final checkExternalUseridAvailability(mixed $external_userid) : mixed
Parameters
- $external_userid : mixed
Return values
mixed —checkLinkSuccess()
protected
checkLinkSuccess(mixed $newUserAuth) : mixed
Parameters
- $newUserAuth : mixed
Return values
mixed —deleteSessionAuthRecord()
protected
final deleteSessionAuthRecord() : mixed
Return values
mixed —deleteUserAuthRecord()
protected
final deleteUserAuthRecord() : mixed
Return values
mixed —getLibraryClassNameInternal()
protected
static getLibraryClassNameInternal(mixed $controller) : mixed
Parameters
- $controller : mixed
Return values
mixed —getLoginLibraryId()
protected
final getLoginLibraryId([mixed $productid = "" ]) : mixed
Parameters
- $productid : mixed = ""
Return values
mixed —getNonce()
protected
getNonce([mixed $length = 32 ][, mixed $chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567' ]) : mixed
Parameters
- $length : mixed = 32
- $chars : mixed = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567'
Return values
mixed —removeExpiredSessionAuths()
protected
final removeExpiredSessionAuths() : mixed
Return values
mixed —updateSessionAuthRecord()
protected
final updateSessionAuthRecord(mixed $data) : mixed
Parameters
- $data : mixed
Return values
mixed —updateUserAuthRecord()
protected
final updateUserAuthRecord(mixed $data) : mixed
Parameters
- $data : mixed