vB_Library_ExternalLogin_OAuth
extends vB_Library_ExternalLogin
in package
vB_Library_Auth
Tags
Table of Contents
- $debug_mode : mixed
- $do_log : mixed
- $error : mixed
- $http_method : mixed
- $instance : mixed
- $loginlibraryid : mixed
- $oauth_callback : mixed
- $oauth_consumer_key : mixed
- $oauth_consumer_secret : mixed
- $oauth_nonce : mixed
- $oauth_signature_method : mixed
- $oauth_timestamp : mixed
- $oauth_token : mixed
- $oauth_token_secret : mixed
- $oauth_version : mixed
- $package : mixed
- $productid : mixed
- $url_access_token : mixed
- $url_authenticate : mixed
- $url_request_token : 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
- 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
- checkExternalUseridAvailability() : mixed
- checkLinkSuccess() : mixed
- cleanUpUserauthAfterConvertingGuestToken() : mixed
- cleanUpUserauthBeforeLinking() : mixed
- clearError() : mixed
- clearOAuthTokenAndSecret() : mixed
- convertRequestTokenToAccessToken() : array<string|int, mixed>
- Convert a pair of request token+secret (linked to an app) to an "access" token+secret (linked to a 3rd-party/twitter user).
- deleteSessionAuthRecord() : mixed
- deleteUserAuthRecord() : mixed
- doGETRequest() : mixed
- doPOSTRequest() : mixed
- fetchExternalUserid() : mixed
- fetchRequestToken() : mixed
- getAndSetCurrentUserData() : mixed
- getLibraryClassNameInternal() : mixed
- getLoginLibraryId() : mixed
- getNonce() : mixed
- getParameterString() : mixed
- parseRequestError() : mixed
- parseResponseBody() : mixed
- removeExpiredSessionAuths() : mixed
- setOAuthTokenAndSecret() : mixed
- updateSessionAuthRecord() : mixed
- updateUserAuthRecord() : mixed
- generateAuthHeader() : mixed
Properties
$debug_mode
protected
mixed
$debug_mode
= alse
$do_log
protected
mixed
$do_log
= alse
$error
protected
mixed
$error
= ""
$http_method
protected
mixed
$http_method
= "POST"
$instance
protected
static mixed
$instance
= array()
$loginlibraryid
protected
mixed
$loginlibraryid
$oauth_callback
protected
mixed
$oauth_callback
$oauth_consumer_key
protected
mixed
$oauth_consumer_key
$oauth_consumer_secret
protected
mixed
$oauth_consumer_secret
$oauth_nonce
protected
mixed
$oauth_nonce
$oauth_signature_method
protected
mixed
$oauth_signature_method
= "HMAC-SHA1"
$oauth_timestamp
protected
mixed
$oauth_timestamp
$oauth_token
protected
mixed
$oauth_token
$oauth_token_secret
protected
mixed
$oauth_token_secret
$oauth_version
protected
mixed
$oauth_version
= "1.0"
$package
protected
mixed
$package
= "vB_OAuth"
$productid
protected
mixed
$productid
$url_access_token
protected
mixed
$url_access_token
$url_authenticate
protected
mixed
$url_authenticate
$url_request_token
protected
mixed
$url_request_token
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 —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()
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 —cleanUpUserauthAfterConvertingGuestToken()
protected
cleanUpUserauthAfterConvertingGuestToken(mixed &$userAuth) : mixed
Parameters
- $userAuth : mixed
Return values
mixed —cleanUpUserauthBeforeLinking()
protected
cleanUpUserauthBeforeLinking(mixed &$userAuth) : mixed
Parameters
- $userAuth : mixed
Return values
mixed —clearError()
protected
final clearError() : mixed
Return values
mixed —clearOAuthTokenAndSecret()
protected
clearOAuthTokenAndSecret() : mixed
Return values
mixed —convertRequestTokenToAccessToken()
Convert a pair of request token+secret (linked to an app) to an "access" token+secret (linked to a 3rd-party/twitter user).
protected
convertRequestTokenToAccessToken(array<string|int, mixed> $params) : array<string|int, mixed>
Note that this function "consumed" the sessionauth record.
Parameters
- $params : array<string|int, mixed>
-
Array with 'oauth_token' & 'oauth_verifier', which are usually supplied by the 3rd party (when they redirect the user back to us via the oauth_callback) as query params.
Return values
array<string|int, mixed> —- Bool 'success' if success is false:
- String 'error' error phrasetitle if success is true:
- Array 'postresponse' curl post response array
- String 'oauth_token'
- String 'oauth_token_secret'
- Array 'authrecord'
deleteSessionAuthRecord()
protected
final deleteSessionAuthRecord() : mixed
Return values
mixed —deleteUserAuthRecord()
protected
final deleteUserAuthRecord() : mixed
Return values
mixed —doGETRequest()
protected
doGETRequest(mixed $url, mixed $parameters) : mixed
Parameters
- $url : mixed
- $parameters : mixed
Return values
mixed —doPOSTRequest()
protected
doPOSTRequest(mixed $url, mixed $parameters) : mixed
Parameters
- $url : mixed
- $parameters : mixed
Return values
mixed —fetchExternalUserid()
protected
fetchExternalUserid(mixed $userAuth) : mixed
Parameters
- $userAuth : mixed
Return values
mixed —fetchRequestToken()
protected
fetchRequestToken(mixed $oauth_callback) : mixed
Parameters
- $oauth_callback : mixed
Return values
mixed —getAndSetCurrentUserData()
protected
getAndSetCurrentUserData() : 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 —getParameterString()
protected
getParameterString([mixed $params = array() ]) : mixed
Parameters
- $params : mixed = array()
Return values
mixed —parseRequestError()
protected
parseRequestError(mixed $statusCode, mixed $responseBody) : mixed
Parameters
- $statusCode : mixed
- $responseBody : mixed
Return values
mixed —parseResponseBody()
protected
parseResponseBody(mixed $body) : mixed
Parameters
- $body : mixed
Return values
mixed —removeExpiredSessionAuths()
protected
final removeExpiredSessionAuths() : mixed
Return values
mixed —setOAuthTokenAndSecret()
protected
setOAuthTokenAndSecret(mixed $userAuth) : mixed
Parameters
- $userAuth : 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
Return values
mixed —generateAuthHeader()
private
generateAuthHeader(mixed $url[, mixed $parameters = array() ]) : mixed
Parameters
- $url : mixed
- $parameters : mixed = array()