vBulletin v6.1.0

vB_Api_Facebook extends vB_Api
in package

vB_Api_Facebook

Tags
access

public

Table of Contents

Methods

__serialize()  : array<string|int, mixed>
__sleep()  : array<string|int, mixed>
__unserialize()  : void
__wakeup()  : void
callNamed()  : The
Call the given api function by name with a named arguments list.
checkApiState()  : mixed
This method checks whether the API method is enabled.
clearCache()  : mixed
Clears all previously loaded API objects.
clearSession()  : mixed
connectCurrentUser()  : mixed
Connects the currently logged in user to the currently logged in Facebook user
disconnectUser()  : mixed
Disconnects the current user from facebook
getAllUserInfo()  : array<string|int, mixed>
Get the results from several functions in one call.
getApiClassName()  : mixed
getFbProfilePicUrl()  : string|false
Get the logged in user's profile picture url.
getFbProfileUrl()  : string|false
Get the logged in user's profile url.
getFbUserInfo()  : mixed
Grabs logged in user info from faceboook if user is logged in
getLoggedInFbUserId()  : mixed
Checks for a currrently logged in user through facebook api
getVbUseridFromFbUserid()  : mixed
Checks if current facebook user is associated with a vb user, and returns vb userid if so
instance()  : vB_Api
Returns an instance of the API object which translates exceptions to an array Use this method for API clients.
instanceInternal()  : vB_Api
Returns an instance of the API object which doesn't handle exceptions This should only be used in other API objects, not for clients of the API
isFacebookEnabled()  : bool
Is facebook enabled on this site.
map_vb4_input_to_vb5()  : string
Returns vb5 api method name.
map_vb5_errors_to_vb4()  : mixed
Alters the error array in any way necessary to interface correctly with vb4.
map_vb5_output_to_vb4()  : mixed
Alters the output array in any way necessary to interface correctly with vb4.
userIsLoggedIn()  : bool
Checks if the current user is logged into facebook

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>

callNamed()

Call the given api function by name with a named arguments list.

public callNamed() : The

Used primarily to translate REST requests into API calls.

Return values
The —

return of the method or an error if the method doesn't exist, or is static, a constructor or destructor, or otherwise shouldn't be callable as and API method. It is also an error if the value of a paramater is not provided and that parameter doesn't have a default value.

checkApiState()

This method checks whether the API method is enabled.

public checkApiState(mixed $method) : mixed

For extensions check make sure $controller property is already set.

Parameters
$method : mixed

clearCache()

Clears all previously loaded API objects.

public static clearCache() : mixed

Intended for use in tests where the loading pattern can cause issues with objects that cache thier own data.

clearSession()

public clearSession() : mixed

connectCurrentUser()

Connects the currently logged in user to the currently logged in Facebook user

public connectCurrentUser([string $accessToken = null ]) : mixed

Note that we don't allow connection of a non logged in account because we need to validate the FB login. Connecting somebody else's account to a FB just doesn't make sense as an action.

Parameters
$accessToken : string = null

. The facebook access token to verify the FB login. if not given use the internal stored session.

Tags
@return

-- standard success array when successful, otherwise will throw an exception

disconnectUser()

Disconnects the current user from facebook

public disconnectUser(int $userid) : mixed

User must either be the current user or an administrator with permissions to manage users.

Parameters
$userid : int

-- The id of the user to disconnect

Tags
@return

-- standard success array when successful, otherwise will throw an exception

getAllUserInfo()

Get the results from several functions in one call.

public getAllUserInfo() : array<string|int, mixed>

This is a cover function to make it easier to access all of the fb related information for the current Facebook user in a single call. This is an inefficient way of getting the information if you aren't going to use most of it, but convenient if you are.

Return values
array<string|int, mixed> —

'profileurl' => result of getFbProfileUrl 'profilepicurl' => result of getFbProfilePicUrl 'vbuserid' => result of getVbUseridFromFbUserid 'user' = > result of getFbUserInfo

getApiClassName()

public static getApiClassName(mixed $controller) : mixed
Parameters
$controller : mixed

getFbProfilePicUrl()

Get the logged in user's profile picture url.

public getFbProfilePicUrl() : string|false
Return values
string|false —

facebook profile picture url or false on failure (forex, there is no logged in FB user)

getFbProfileUrl()

Get the logged in user's profile url.

public getFbProfileUrl() : string|false
Return values
string|false —

facebook profile url or false on failure (forex, there is no logged in FB user)

getFbUserInfo()

Grabs logged in user info from faceboook if user is logged in

public getFbUserInfo() : mixed
Tags
@return

array, fb userinfo array if logged in, false otherwise, see the facebook '/me' docs for details

getLoggedInFbUserId()

Checks for a currrently logged in user through facebook api

public getLoggedInFbUserId() : mixed
Tags
@return

mixed, fb userid if logged in, false otherwise

getVbUseridFromFbUserid()

Checks if current facebook user is associated with a vb user, and returns vb userid if so

public getVbUseridFromFbUserid() : mixed
Tags
@return

mixed, vb userid if one is associated, false if not

instance()

Returns an instance of the API object which translates exceptions to an array Use this method for API clients.

public static instance(string $controller[, bool $refresh_cache = false ]) : vB_Api
Parameters
$controller : string

-- name of the API controller to load

$refresh_cache : bool = false

-- true if we want to force the cache to update with a new api object primarily intended for testing

Return values
vB_Api

instanceInternal()

Returns an instance of the API object which doesn't handle exceptions This should only be used in other API objects, not for clients of the API

public static instanceInternal(string $controller[, bool $refresh_cache = false ]) : vB_Api
Parameters
$controller : string

-- name of the API controller to load

$refresh_cache : bool = false

-- true if we want to force the cache to update with a new api object primarily intended for testing

Return values
vB_Api

isFacebookEnabled()

Is facebook enabled on this site.

public isFacebookEnabled() : bool
Return values
bool —

true if the facebook system initialized properly, false otherwise note that if we get an error this may be false even if facebook is configured in the admincp.

map_vb4_input_to_vb5()

Returns vb5 api method name.

public static map_vb4_input_to_vb5(string $method, array<string|int, mixed> &$request) : string

May alter request array.

Parameters
$method : string

-- vb4 method name

$request : array<string|int, mixed>

-- $_REQUEST array for this api request

Return values
string

map_vb5_errors_to_vb4()

Alters the error array in any way necessary to interface correctly with vb4.

public static map_vb5_errors_to_vb4(string $method, array<string|int, mixed> &$data) : mixed
Parameters
$method : string

-- vb4 method name

$data : array<string|int, mixed>

-- error array from vb5

map_vb5_output_to_vb4()

Alters the output array in any way necessary to interface correctly with vb4.

public static map_vb5_output_to_vb4(string $method, array<string|int, mixed> &$data) : mixed
Parameters
$method : string

-- vb4 method name

$data : array<string|int, mixed>

-- output array from vb5

userIsLoggedIn()

Checks if the current user is logged into facebook

public userIsLoggedIn([bool $ping = false ]) : bool
Parameters
$ping : bool = false

Whether to ping Facebook (unused)

Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results