Docs For Class HTTP_OAuth_Store_Consumer

__construct (Constructor) [line 72]

void __construct(
[array
$options = array()])

Instantiate Cache_Lite. Allows for options to be passed to Cache_Lite.

Access: public

Parameters:

array $options — Options for Cache_Lite constructor

[ Top ]

ensureDirectoryExists [line 224]

void ensureDirectoryExists(
string
$dir)

Make sure the given sub directory exists. If not, create it.

Access: protected

Parameters:

string $dir — The full path to the sub director we plan to write to

[ Top ]

getAccessToken [line 144]

HTTP_OAuth_Store_Data getAccessToken(
string
$consumerUserID, string
$providerName)

Gets access token data in the form of an HTTP_OAuth_Store_Data object

Access: public

Parameters:

string	`$consumerUserID`	—	The end user's ID at the consumer
string	`$providerName`	—	The provider name (i.e. 'twitter')

[ Top ]

getAccessTokenKey [line 192]

void getAccessTokenKey(
string
$consumerUserID, string
$providerName)

Gets an access token key for storage, based on the consumer user ID and the provider name

Access: protected

Parameters:

string	`$consumerUserID`	—	The end user's ID at the consumer
string	`$providerName`	—	The provider name (i.e. 'twitter')

[ Top ]

getRequestToken [line 113]

array getRequestToken(
string
$providerName, string
$sessionID)

Gets a request token as an array of the token, tokenSecret, providerName, and sessionID (array key names)

Return: on success, false on failure
Access: public

Parameters:

string	`$providerName`	—	The provider name (i.e. 'twitter')
string	`$sessionID`	—	A string representing this user's session

[ Top ]

getRequestTokenKey [line 131]

string getRequestTokenKey(
string
$providerName, string
$sessionID)

Gets a cache key for request tokens. It's an md5 hash of the provider name and sessionID

Access: protected

Parameters:

string	`$providerName`	—	The provider name (i.e. 'twitter')
string	`$sessionID`	—	A string representing this user's session

[ Top ]

removeAccessToken [line 175]

bool removeAccessToken(
HTTP_OAuth_Store_Data
$data)

Removes an access token

Return: true on success, false or PEAR_Error on failure
Access: public

Parameters:

HTTP_OAuth_Store_Data $data — The access token data

[ Top ]

setAccessToken [line 160]

bool setAccessToken(
HTTP_OAuth_Store_Data
$data)

Sets access token data from an HTTP_OAuth_Store_Data object

Return: true on success, false or PEAR_Error on failure
Access: public

Parameters:

HTTP_OAuth_Store_Data $data — The access token data

[ Top ]

setOptions [line 206]

void setOptions(
string
$key, [string
$expire = null])

Sets options for Cache_Lite based on the needs of the current method.

Options set include the subdirectory to be used, and the expiration.

Access: protected

Parameters:

string	`$key`	—	The sub-directory of the cacheDir
string	`$expire`	—	The cache lifetime (expire) to be used

[ Top ]

setRequestToken [line 88]

true setRequestToken(
string
$token, string
$tokenSecret, string
$providerName, string
$sessionID)

Sets a request token

Return: on success, false or PEAR_Error on failure
Access: public

Parameters:

string	`$token`	—	The request token
string	`$tokenSecret`	—	The request token secret
string	`$providerName`	—	The name of the provider (i.e. 'twitter')
string	`$sessionID`	—	A string representing this user's session

[ Top ]

Class: HTTP_OAuth_Store_Consumer_CacheLite

Class Overview

Author(s):

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$cache = null

$defaultOptions = array(
        'cacheDir'             => '/tmp',
        'lifeTime'             => 300,
        'hashedDirectoryLevel' => 2
    )

$options = array()

Method Detail

__construct (Constructor) [line 72]

Parameters:

ensureDirectoryExists [line 224]

Parameters:

getAccessToken [line 144]

Parameters:

getAccessTokenKey [line 192]

Parameters:

getRequestToken [line 113]

Parameters:

getRequestTokenKey [line 131]

Parameters:

removeAccessToken [line 175]

Parameters:

setAccessToken [line 160]

Parameters:

setOptions [line 206]

Parameters:

setRequestToken [line 88]

Parameters:

Class: HTTP_OAuth_Store_Consumer_CacheLite

Class Overview

Author(s):

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$cache = null

$defaultOptions = array( 'cacheDir' => '/tmp', 'lifeTime' => 300, 'hashedDirectoryLevel' => 2 )

$options = array()

Method Detail

__construct (Constructor) [line 72]

Parameters:

ensureDirectoryExists [line 224]

Parameters:

getAccessToken [line 144]

Parameters:

getAccessTokenKey [line 192]

Parameters:

getRequestToken [line 113]

Parameters:

getRequestTokenKey [line 131]

Parameters:

removeAccessToken [line 175]

Parameters:

setAccessToken [line 160]

Parameters:

setOptions [line 206]

Parameters:

setRequestToken [line 88]

Parameters:

$defaultOptions = array(
'cacheDir' => '/tmp',
'lifeTime' => 300,
'hashedDirectoryLevel' => 2
)