vB_Library_ExternalLogin
extends vB_Library
in package
uses
vB_Trait_NoSerialize
vB_Library
Table of Contents
Methods
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- clearCache() : mixed
- createLoginLibraryId() : mixed
- deleteSessionAuthRecord() : 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() : static
- 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
Methods
__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>
__wakeup()
public
__wakeup() : void
clearCache()
public
static clearCache() : mixed
createLoginLibraryId()
public
final createLoginLibraryId([mixed $productid = "" ][, mixed $class = "" ]) : mixed
Parameters
- $productid : mixed = ""
- $class : mixed = ""
deleteSessionAuthRecord()
public
final deleteSessionAuthRecord() : mixed
formatPersonalDataForExport()
Given userauth record & the loginlibrary data, fetch any additional personal data stored for the user & format it for export.
public
formatPersonalDataForExport(mixed $userauth) : array<string|int, mixed>
Parameters
- $userauth : mixed
-
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
getPersonalData()
public
final getPersonalData(mixed $userid) : mixed
Parameters
- $userid : mixed
getSessionAuthRecord()
public
final getSessionAuthRecord([mixed $token = null ]) : mixed
Parameters
- $token : mixed = null
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
instance()
Returns singleton instance of self.
public
static instance(mixed $class) : static
Parameters
- $class : mixed
Return values
static —- Reference to singleton instance of the requested library class
linkCurrentUserWithApp()
public
linkCurrentUserWithApp([mixed $params = [] ]) : mixed
Parameters
- $params : mixed = []
loginUser()
public
final loginUser(mixed $vbuserid) : mixed
Parameters
- $vbuserid : 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 = 0 ]) : mixed
use the functions from the notification library directly.
Parameters
- $text : mixed
- $type : mixed
- $nodeid : mixed
- $userid : mixed = null
- $insertNotifications : mixed = true
- $currentuserid : mixed = 0
postUserDelete()
public
postUserDelete(mixed $userid) : mixed
Parameters
- $userid : mixed
saveUserLink()
public
saveUserLink(mixed $userAuth) : mixed
Parameters
- $userAuth : mixed
unlinkCurrentUserFromApp()
public
unlinkCurrentUserFromApp([mixed $params = array() ]) : mixed
Parameters
- $params : mixed = array()