Campustream 1.0
A social network MQP for WPI
OAuthRequest Class Reference

Public Member Functions

 __construct ($http_method, $http_url, $parameters=NULL)
 set_parameter ($name, $value, $allow_duplicates=true)
 get_parameter ($name)
 get_parameters ()
 unset_parameter ($name)
 get_signable_parameters ()
 get_signature_base_string ()
 get_normalized_http_method ()
 get_normalized_http_url ()
 to_url ()
 to_postdata ()
 to_header ($realm=null)
 __toString ()
 sign_request ($signature_method, $consumer, $token)
 build_signature ($signature_method, $consumer, $token)

Static Public Member Functions

static from_request ($http_method=NULL, $http_url=NULL, $parameters=NULL)
static from_consumer_and_token ($consumer, $token, $http_method, $http_url, $parameters=NULL)

Data Fields

 $base_string

Static Public Attributes

static $version = '1.0'
static $POST_INPUT = 'php://input'

Detailed Description

Definition at line 220 of file OAuth.php.


Constructor & Destructor Documentation

__construct ( http_method,
http_url,
parameters = NULL 
)

Definition at line 229 of file OAuth.php.


Member Function Documentation

__toString ( )

Definition at line 443 of file OAuth.php.

build_signature ( signature_method,
consumer,
token 
)

Definition at line 458 of file OAuth.php.

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

pretty much a helper function to set up the request

Definition at line 292 of file OAuth.php.

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

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

Definition at line 241 of file OAuth.php.

get_normalized_http_method ( )

just uppercases the http method

Definition at line 372 of file OAuth.php.

get_normalized_http_url ( )

parses the url and rebuilds it to be scheme://host/path

Definition at line 380 of file OAuth.php.

get_parameter ( name)

Definition at line 321 of file OAuth.php.

get_parameters ( )

Definition at line 325 of file OAuth.php.

get_signable_parameters ( )

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

Returns:
string

Definition at line 337 of file OAuth.php.

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 &.

Definition at line 357 of file OAuth.php.

set_parameter ( name,
value,
allow_duplicates = true 
)

Definition at line 306 of file OAuth.php.

sign_request ( signature_method,
consumer,
token 
)

Definition at line 448 of file OAuth.php.

to_header ( realm = null)

builds the Authorization: header

Definition at line 419 of file OAuth.php.

to_postdata ( )

builds the data one would send in a POST request

Definition at line 412 of file OAuth.php.

to_url ( )

builds a url usable for a GET request

Definition at line 400 of file OAuth.php.

unset_parameter ( name)

Definition at line 329 of file OAuth.php.


Field Documentation

$base_string

Definition at line 225 of file OAuth.php.

$POST_INPUT = 'php://input' [static]

Definition at line 227 of file OAuth.php.

$version = '1.0' [static]

Definition at line 226 of file OAuth.php.


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