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

Class: OAuthRequest

Source Location: /zp-extensions/common/oAuth/OAuth.php

Class OAuthRequest

Property Summary
static mixed   $POST_INPUT  
static mixed   $version  
mixed   $base_string  

[ Top ]
Method Summary
static void   from_consumer_and_token()   pretty much a helper function to set up the request
static void   from_request()   attempt to build up a request from what was passed to the server
OAuthRequest   __construct()  
void   build_signature()  
void   get_normalized_http_method()   just uppercases the http method
void   get_normalized_http_url()   parses the url and rebuilds it to be
void   get_parameter()  
void   get_parameters()  
string   get_signable_parameters()   The request parameters, sorted and concatenated into a normalized string.
void   get_signature_base_string()   Returns the base string of this request
void   set_parameter()  
void   sign_request()  
void   to_header()   builds the Authorization: header
void   to_postdata()   builds the data one would send in a POST request
void   to_url()   builds a url usable for a GET request
void   unset_parameter()  
void   __toString()  

[ Top ]
Properties
static mixed   $POST_INPUT = 'php://input' [line 227]
API Tags:
Access:  public


[ Top ]
static mixed   $version = '1.0' [line 226]
API Tags:
Access:  public


[ Top ]
mixed   $base_string [line 225]
API Tags:
Access:  public


[ Top ]
Methods
static method from_consumer_and_token  [line 292]

  static void from_consumer_and_token( $consumer, $token, $http_method, $http_url, [ $parameters = NULL]  )

pretty much a helper function to set up the request

Parameters:
   $consumer: 
   $token: 
   $http_method: 
   $http_url: 
   $parameters: 

API Tags:
Access:  public


[ Top ]
static method from_request  [line 241]

  static void from_request( [ $http_method = NULL], [ $http_url = NULL], [ $parameters = NULL]  )

attempt to build up a request from what was passed to the server

Parameters:
   $http_method: 
   $http_url: 
   $parameters: 

API Tags:
Access:  public


[ Top ]
Constructor __construct  [line 229]

  OAuthRequest __construct( $http_method, $http_url, [ $parameters = NULL]  )

Parameters:
   $http_method: 
   $http_url: 
   $parameters: 


[ Top ]
build_signature  [line 458]

  void build_signature( $signature_method, $consumer, $token  )

Parameters:
   $signature_method: 
   $consumer: 
   $token: 

API Tags:
Access:  public


[ Top ]
get_normalized_http_method  [line 372]

  void get_normalized_http_method( )

just uppercases the http method


API Tags:
Access:  public


[ Top ]
get_normalized_http_url  [line 380]

  void get_normalized_http_url( )

parses the url and rebuilds it to be

scheme://host/path


API Tags:
Access:  public


[ Top ]
get_parameter  [line 321]

  void get_parameter( $name  )

Parameters:
   $name: 

API Tags:
Access:  public


[ Top ]
get_parameters  [line 325]

  void get_parameters( )


API Tags:
Access:  public


[ Top ]
get_signable_parameters  [line 337]

  string get_signable_parameters( )

The request parameters, sorted and concatenated into a normalized string.


API Tags:
Access:  public


[ Top ]
get_signature_base_string  [line 357]

  void get_signature_base_string( )

Returns the base string of this request

The base string defined as the method, the url and the parameters (normalized), each urlencoded and the concated with &.


API Tags:
Access:  public


[ Top ]
set_parameter  [line 306]

  void set_parameter( $name, $value, [ $allow_duplicates = true]  )

Parameters:
   $name: 
   $value: 
   $allow_duplicates: 

API Tags:
Access:  public


[ Top ]
sign_request  [line 448]

  void sign_request( $signature_method, $consumer, $token  )

Parameters:
   $signature_method: 
   $consumer: 
   $token: 

API Tags:
Access:  public


[ Top ]
to_header  [line 419]

  void to_header( [ $realm = null]  )

builds the Authorization: header

Parameters:
   $realm: 

API Tags:
Access:  public


[ Top ]
to_postdata  [line 412]

  void to_postdata( )

builds the data one would send in a POST request


API Tags:
Access:  public


[ Top ]
to_url  [line 400]

  void to_url( )

builds a url usable for a GET request


API Tags:
Access:  public


[ Top ]
unset_parameter  [line 329]

  void unset_parameter( $name  )

Parameters:
   $name: 

API Tags:
Access:  public


[ Top ]
__toString  [line 443]

  void __toString( )


API Tags:
Access:  public


[ Top ]

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