phpDocumentor plugins
Twitter
[ class tree: plugins ] [ index: plugins ] [ all elements ]

Class: TwitterOAuth

Source Location: /qp_plugins/twitter_plugin/twitteroauth/twitteroauth.php

Class TwitterOAuth

Property Summary
mixed   $connecttimeout  
mixed   $decode_json  
mixed   $format  
mixed   $host  
mixed   $http_code  
mixed   $http_info  
mixed   $ssl_verifypeer  
mixed   $timeout  
mixed   $url  
mixed   $useragent  

[ Top ]
Method Summary
TwitterOAuth   __construct()   construct TwitterOAuth object
void   accessTokenURL()   Set API URLS
void   authenticateURL()   Set API URLS
void   authorizeURL()   Set API URLS
void   delete()   DELETE wrapper for oAuthReqeust.
void   get()   GET wrapper for oAuthRequest.
array("oauth_token"   getAccessToken()   Exchange request token and secret for an access token and secret, to sign API calls.
a   getAuthorizeURL()   Get the authorize URL
void   getHeader()   Get the header info to store.
a   getRequestToken()   Get a request_token from Twitter
API   http()   Make an HTTP request
void   lastAPICall()   Debug helper
void   lastStatusCode()   Debug helper
void   oAuthRequest()   Format and sign an OAuth / API request
void   post()   POST wrapper for oAuthRequest.
void   requestTokenURL()   Set API URLS

[ Top ]
Properties
mixed   $connecttimeout = 30 [line 42]
API Tags:
Access:  public


[ Top ]
mixed   $decode_json = TRUE [line 48]
API Tags:
Access:  public


[ Top ]
mixed   $format = 'json' [line 46]
API Tags:
Access:  public


[ Top ]
mixed   $host = "https://api.twitter.com/1/" [line 38]
API Tags:
Access:  public


[ Top ]
mixed   $http_code [line 34]
API Tags:
Access:  public


[ Top ]
mixed   $http_info [line 50]
API Tags:
Access:  public


[ Top ]
mixed   $ssl_verifypeer = FALSE [line 44]
API Tags:
Access:  public


[ Top ]
mixed   $timeout = 30 [line 40]
API Tags:
Access:  public


[ Top ]
mixed   $url [line 36]
API Tags:
Access:  public


[ Top ]
mixed   $useragent = 'TwitterOAuth v0.2.0-beta2' [line 52]
API Tags:
Access:  public


[ Top ]
Methods
Constructor __construct  [line 96]

  TwitterOAuth __construct( $consumer_key, $consumer_secret, [ $oauth_token = NULL], [ $oauth_token_secret = NULL]  )

construct TwitterOAuth object

Parameters:
   $consumer_key: 
   $consumer_secret: 
   $oauth_token: 
   $oauth_token_secret: 


[ Top ]
accessTokenURL  [line 60]

  void accessTokenURL( )

Set API URLS



[ Top ]
authenticateURL  [line 66]

  void authenticateURL( )

Set API URLS



[ Top ]
authorizeURL  [line 72]

  void authorizeURL( )

Set API URLS



[ Top ]
delete  [line 206]

  void delete( $url, [ $parameters = array()]  )

DELETE wrapper for oAuthReqeust.

Parameters:
   $url: 
   $parameters: 


[ Top ]
get  [line 178]

  void get( $url, [ $parameters = array()]  )

GET wrapper for oAuthRequest.

Parameters:
   $url: 
   $parameters: 


[ Top ]
getAccessToken  [line 161]

  array("oauth_token" getAccessToken( [ $oauth_verifier = FALSE]  )

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

Parameters:
   $oauth_verifier: 

API Tags:
Return:  => "the-access-token", "oauth_token_secret" => "the-access-secret", "user_id" => "9436992", "screen_name" => "abraham")


[ Top ]
getAuthorizeURL  [line 135]

  a getAuthorizeURL( $token, [ $sign_in_with_twitter = TRUE]  )

Get the authorize URL

Parameters:
   $token: 
   $sign_in_with_twitter: 

API Tags:
Return:  string


[ Top ]
getHeader  [line 288]

  void getHeader( $ch, $header  )

Get the header info to store.

Parameters:
   $ch: 
   $header: 


[ Top ]
getRequestToken  [line 116]

  a getRequestToken( [ $oauth_callback = NULL]  )

Get a request_token from Twitter

Parameters:
   $oauth_callback: 

API Tags:
Return:  key/value array containing oauth_token and oauth_token_secret


[ Top ]
http  [line 243]

  API http( $url, $method, [ $postfields = NULL]  )

Make an HTTP request

Parameters:
   $url: 
   $method: 
   $postfields: 

API Tags:
Return:  results


[ Top ]
lastAPICall  [line 90]

  void lastAPICall( )

Debug helper



[ Top ]
lastStatusCode  [line 84]

  void lastStatusCode( )

Debug helper



[ Top ]
oAuthRequest  [line 220]

  void oAuthRequest( $url, $method, $parameters  )

Format and sign an OAuth / API request

Parameters:
   $url: 
   $method: 
   $parameters: 


[ Top ]
post  [line 192]

  void post( $url, [ $parameters = array()]  )

POST wrapper for oAuthRequest.

Parameters:
   $url: 
   $parameters: 


[ Top ]
requestTokenURL  [line 78]

  void requestTokenURL( )

Set API URLS



[ Top ]