Class Facebook - echiong/testRepo GitHub Wiki

##Class Facebook

Extends the BaseFacebook class with the intent of using PHP sessions to store user ids and access tokens.

Package: [[application<a href="Package application.libraries.md">libraries]]
Located at application/libraries/facebook.php

##Methods summary

public __construct ( )

Identical to the parent constructor, except that we start a PHP session to store the user ID and access token if during the course of execution we discover them.

See BaseFacebook::__construct-in-facebook.php

###Overrides BaseFacebook::__construct()

protected setPersistentData ( string $key, array $value )

Provides the implementations of the inherited abstract methods. The implementation uses PHP sessions to maintain a store for authorization codes, user ids, CSRF states, and access tokens.

Parameters

$key string
$key Key

$value array
$value Value

protected mixed getPersistentData ( string $key, boolean $default = false )

Retrieves the persistent data.

Parameters

$key string
$key The key

$default boolean

Returns mixed

protected clearPersistentData ( string $key )

Clears the persistent data.

Parameters

$key string
$key The key

protected clearAllPersistentData ( )

Clears all persistent data.

protected string constructSessionVariableName ( string $key )

Constructs session varaible names.

Parameters

$key string
$key The key

Returns string

Methods inherited from BaseFacebook

_graph()

_oauthRequest()

_restserver()

api()

base64UrlDecode()

destroySession()

errorLog()

establishCSRFTokenState()

getAccessToken()

getAccessTokenFromCode()

getApiUrl()

getAppId()

getAppSecret()

getApplicationAccessToken()

getCode()

getCurrentUrl()

getFileUploadSupport()

getLoginStatusUrl()

getLoginUrl()

getLogoutUrl()

getMetadataCookie()

getMetadataCookieName()

getSignedRequest()

getSignedRequestCookieName()

getUrl()

getUser()

getUserAccessToken()

getUserFromAccessToken()

getUserFromAvailableData()

isVideoPost()

makeRequest()

parseSignedRequest()

setAccessToken()

setAppId()

setAppSecret()

setFileUploadSupport()

shouldRetainParam()

throwAPIException()

useFileUploadSupport()

<table class="summary inherited">
<caption>Constants inherited from <a href="Class BaseFacebook.md#constants">BaseFacebook</a></caption>
<tr>
	<td><code>
		<a href="Class BaseFacebook.md#VERSION"><b>VERSION</b></a>
	</code></td>
</tr>
</table>



<table class="summary" id="properties">
<caption>Properties summary</caption>
<tr data-order="kSupportedKeys" id="$kSupportedKeys">
	<td class="attributes"><code>
		protected static 
		array
	</code></td>

	<td class="name">

$kSupportedKeys

		<div class="description detailed">
			

		</div>
	</div></td>
</tr>
</table>

<table class="summary inherited">
<caption>Properties inherited from <a href="Class BaseFacebook.md#properties">BaseFacebook</a></caption>
<tr>
	<td><code>
		<a href="Class BaseFacebook.md#$CURL_OPTS"><var>$CURL_OPTS</var></a>, 
		<a href="Class BaseFacebook.md#$DOMAIN_MAP"><var>$DOMAIN_MAP</var></a>, 
		<a href="Class BaseFacebook.md#$DROP_QUERY_PARAMS"><var>$DROP_QUERY_PARAMS</var></a>, 
		<a href="Class BaseFacebook.md#$accessToken"><var>$accessToken</var></a>, 
		<a href="Class BaseFacebook.md#$appId"><var>$appId</var></a>, 
		<a href="Class BaseFacebook.md#$appSecret"><var>$appSecret</var></a>, 
		<a href="Class BaseFacebook.md#$fileUploadSupport"><var>$fileUploadSupport</var></a>, 
		<a href="Class BaseFacebook.md#$signedRequest"><var>$signedRequest</var></a>, 
		<a href="Class BaseFacebook.md#$state"><var>$state</var></a>, 
		<a href="Class BaseFacebook.md#$user"><var>$user</var></a>
	</code></td>
</tr>
</table>