Campustream 1.0
A social network MQP for WPI
TwitterOAuth Class Reference

Public Member Functions

 accessTokenURL ()
 authenticateURL ()
 authorizeURL ()
 requestTokenURL ()
 lastStatusCode ()
 lastAPICall ()
 __construct ($consumer_key, $consumer_secret, $oauth_token=NULL, $oauth_token_secret=NULL)
 getRequestToken ($oauth_callback=NULL)
 getAuthorizeURL ($token, $sign_in_with_twitter=TRUE)
 getAccessToken ($oauth_verifier=FALSE)
 getXAuthToken ($username, $password)
 get ($url, $parameters=array())
 post ($url, $parameters=array())
 delete ($url, $parameters=array())
 oAuthRequest ($url, $method, $parameters)
 http ($url, $method, $postfields=NULL)
 getHeader ($ch, $header)

Data Fields

 $http_code
 $url
 $host = "https://api.twitter.com/1/"
 $timeout = 30
 $connecttimeout = 30
 $ssl_verifypeer = FALSE
 $format = 'json'
 $decode_json = TRUE
 $http_info
 $useragent = 'TwitterOAuth v0.2.0-beta2'

Detailed Description

Twitter OAuth class

Definition at line 15 of file twitteroauth.php.


Constructor & Destructor Documentation

__construct ( consumer_key,
consumer_secret,
oauth_token = NULL,
oauth_token_secret = NULL 
)

construct TwitterOAuth object

Definition at line 59 of file twitteroauth.php.


Member Function Documentation

accessTokenURL ( )

Set API URLS

Definition at line 45 of file twitteroauth.php.

authenticateURL ( )

Definition at line 46 of file twitteroauth.php.

authorizeURL ( )

Definition at line 47 of file twitteroauth.php.

delete ( url,
parameters = array() 
)

DELETE wrapper for oAuthReqeust.

Definition at line 167 of file twitteroauth.php.

get ( url,
parameters = array() 
)

GET wrapper for oAuthRequest.

Definition at line 145 of file twitteroauth.php.

getAccessToken ( oauth_verifier = FALSE)

Exchange request token and secret for an access token and secret, to sign API calls.

Returns:
array("oauth_token" => "the-access-token", "oauth_token_secret" => "the-access-secret", "user_id" => "9436992", "screen_name" => "abraham")

Definition at line 111 of file twitteroauth.php.

getAuthorizeURL ( token,
sign_in_with_twitter = TRUE 
)

Get the authorize URL

Returns:
a string

Definition at line 91 of file twitteroauth.php.

getHeader ( ch,
header 
)

Get the header info to store.

Definition at line 236 of file twitteroauth.php.

getRequestToken ( oauth_callback = NULL)

Get a request_token from Twitter

Returns:
a key/value array containing oauth_token and oauth_token_secret

Definition at line 75 of file twitteroauth.php.

getXAuthToken ( username,
password 
)

One time exchange of username and password for access token and secret.

Returns:
array("oauth_token" => "the-access-token", "oauth_token_secret" => "the-access-secret", "user_id" => "9436992", "screen_name" => "abraham", "x_auth_expires" => "0")

Definition at line 131 of file twitteroauth.php.

http ( url,
method,
postfields = NULL 
)

Make an HTTP request

Returns:
API results

Definition at line 197 of file twitteroauth.php.

lastAPICall ( )

Definition at line 54 of file twitteroauth.php.

lastStatusCode ( )

Debug helpers

Definition at line 53 of file twitteroauth.php.

oAuthRequest ( url,
method,
parameters 
)

Format and sign an OAuth / API request

Definition at line 178 of file twitteroauth.php.

post ( url,
parameters = array() 
)

POST wrapper for oAuthRequest.

Definition at line 156 of file twitteroauth.php.

requestTokenURL ( )

Definition at line 48 of file twitteroauth.php.


Field Documentation

$connecttimeout = 30

Definition at line 25 of file twitteroauth.php.

$decode_json = TRUE

Definition at line 31 of file twitteroauth.php.

$format = 'json'

Definition at line 29 of file twitteroauth.php.

$host = "https://api.twitter.com/1/"

Definition at line 21 of file twitteroauth.php.

$http_code

Definition at line 17 of file twitteroauth.php.

$http_info

Definition at line 33 of file twitteroauth.php.

$ssl_verifypeer = FALSE

Definition at line 27 of file twitteroauth.php.

$timeout = 30

Definition at line 23 of file twitteroauth.php.

$url

Definition at line 19 of file twitteroauth.php.

$useragent = 'TwitterOAuth v0.2.0-beta2'

Definition at line 35 of file twitteroauth.php.


The documentation for this class was generated from the following file: