vB_Library_ExternalLogin_OAuth
extends vB_Library_ExternalLogin
in package
vB_Library_Auth
Tags
Table of Contents
- __construct() : mixed
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- 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
- getLinkedVBUseridFromRequestTokens() : mixed
- getPersonalData() : mixed
- getSessionAuthRecord() : mixed
- getUserAuthRecord() : mixed
- instance() : vB_PageCache
- Returns singleton instance of self.
- linkCurrentUserWithApp() : mixed
- Convert request token to access token, fetch external userid (using plugin implemented fetchAndSetExternalUserid() function) and update userauth record to link the app with the current user.
- 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
Methods
__construct()
public
__construct() : mixed
Return values
mixed —__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —__sleep()
public
__sleep() : array<string|int, mixed>
Return values
array<string|int, mixed> —__unserialize()
public
__unserialize(array<string|int, mixed> $serialized) : void
Parameters
- $serialized : array<string|int, mixed>
Return values
void —__wakeup()
public
__wakeup() : void
Return values
void —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 —getLinkedVBUseridFromRequestTokens()
public
getLinkedVBUseridFromRequestTokens(mixed $params) : mixed
Parameters
- $params : 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()
Convert request token to access token, fetch external userid (using plugin implemented fetchAndSetExternalUserid() function) and update userauth record to link the app with the current user.
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()