[ class tree: core ] [ index: core ] [ all elements ]

Class: TwitterOAuth

Source Location: /zp-extensions/tweet_news/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()  
void   authorizeURL()  
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
array("oauth_token"   getXAuthToken()   One time exchange of username and password for access token and secret.
API   http()   Make an HTTP request
void   lastAPICall()  
void   lastStatusCode()   Debug helpers
void   oAuthRequest()   Format and sign an OAuth / API request
void   post()   POST wrapper for oAuthRequest.
void   requestTokenURL()  

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


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


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


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


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


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


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


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


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


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


[ Top ]
Methods
Constructor __construct  [line 59]

  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 45]

  void accessTokenURL( )

Set API URLS



[ Top ]
authenticateURL  [line 46]

  void authenticateURL( )



[ Top ]
authorizeURL  [line 47]

  void authorizeURL( )



[ Top ]
delete  [line 167]

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

DELETE wrapper for oAuthReqeust.

Parameters:
   $url: 
   $parameters: 


[ Top ]
get  [line 145]

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

GET wrapper for oAuthRequest.

Parameters:
   $url: 
   $parameters: 


[ Top ]
getAccessToken  [line 111]

  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 91]

  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 236]

  void getHeader( $ch, $header  )

Get the header info to store.

Parameters:
   $ch: 
   $header: 


[ Top ]
getRequestToken  [line 75]

  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 ]
getXAuthToken  [line 131]

  array("oauth_token" getXAuthToken( $username, $password  )

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

Parameters:
   $username: 
   $password: 

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


[ Top ]
http  [line 197]

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

Make an HTTP request

Parameters:
   $url: 
   $method: 
   $postfields: 

API Tags:
Return:  results


[ Top ]
lastAPICall  [line 54]

  void lastAPICall( )



[ Top ]
lastStatusCode  [line 53]

  void lastStatusCode( )

Debug helpers



[ Top ]
oAuthRequest  [line 178]

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

Format and sign an OAuth / API request

Parameters:
   $url: 
   $method: 
   $parameters: 


[ Top ]
post  [line 156]

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

POST wrapper for oAuthRequest.

Parameters:
   $url: 
   $parameters: 


[ Top ]
requestTokenURL  [line 48]

  void requestTokenURL( )



[ Top ]

Documentation generated on Tue, 20 Dec 2011 16:08:17 +0100 by phpDocumentor 1.4.3