[ 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 26]
API Tags:
Access:  public


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


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


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


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


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


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


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


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


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


[ Top ]
Methods
Constructor __construct  [line 74]

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

  void accessTokenURL( )

Set API URLS



[ Top ]
authenticateURL  [line 48]

  void authenticateURL( )



[ Top ]
authorizeURL  [line 52]

  void authorizeURL( )



[ Top ]
delete  [line 177]

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

DELETE wrapper for oAuthReqeust.

Parameters:
   $url: 
   $parameters: 


[ Top ]
get  [line 155]

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

GET wrapper for oAuthRequest.

Parameters:
   $url: 
   $parameters: 


[ Top ]
getAccessToken  [line 123]

  array("oauth_token" getAccessToken( $oauth_verifier  )

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

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

  void getHeader( $ch, $header  )

Get the header info to store.

Parameters:
   $ch: 
   $header: 


[ Top ]
getRequestToken  [line 89]

  a getRequestToken( $oauth_callback  )

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

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

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

Make an HTTP request

Parameters:
   $url: 
   $method: 
   $postfields: 

API Tags:
Return:  results


[ Top ]
lastAPICall  [line 67]

  void lastAPICall( )



[ Top ]
lastStatusCode  [line 63]

  void lastStatusCode( )

Debug helpers



[ Top ]
oAuthRequest  [line 188]

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

Format and sign an OAuth / API request

Parameters:
   $url: 
   $method: 
   $parameters: 


[ Top ]
post  [line 166]

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

POST wrapper for oAuthRequest.

Parameters:
   $url: 
   $parameters: 


[ Top ]
requestTokenURL  [line 56]

  void requestTokenURL( )



[ Top ]

Documentation generated on Sat, 07 Jun 2014 18:03:48 +0200 by phpDocumentor 1.4.3