OAuthRequest
in package
Table of Contents
- $base_string : mixed
- $POST_INPUT : mixed
- $version : mixed
- $http_method : mixed
- $http_url : mixed
- $parameters : mixed
- __construct() : mixed
- __toString() : mixed
- build_signature() : mixed
- from_consumer_and_token() : mixed
- pretty much a helper function to set up the request
- from_request() : mixed
- attempt to build up a request from what was passed to the server
- get_normalized_http_method() : mixed
- just uppercases the http method
- get_normalized_http_url() : mixed
- parses the url and rebuilds it to be scheme://host/path
- get_parameter() : mixed
- get_parameters() : mixed
- get_signable_parameters() : string
- The request parameters, sorted and concatenated into a normalized string.
- get_signature_base_string() : mixed
- Returns the base string of this request
- set_parameter() : mixed
- sign_request() : mixed
- to_header() : mixed
- builds the Authorization: header
- to_postdata() : mixed
- builds the data one would send in a POST request
- to_url() : mixed
- builds a url usable for a GET request
- unset_parameter() : mixed
- generate_nonce() : mixed
- util function: current nonce
- generate_timestamp() : mixed
- util function: current timestamp
Properties
$base_string
public
mixed
$base_string
$POST_INPUT
public
static mixed
$POST_INPUT
= 'php://input'
$version
public
static mixed
$version
= '1.0'
$http_method
private
mixed
$http_method
$http_url
private
mixed
$http_url
$parameters
private
mixed
$parameters
Methods
__construct()
public
__construct(mixed $http_method, mixed $http_url[, mixed $parameters = NULL ]) : mixed
Parameters
- $http_method : mixed
- $http_url : mixed
- $parameters : mixed = NULL
Return values
mixed —__toString()
public
__toString() : mixed
Return values
mixed —build_signature()
public
build_signature(mixed $signature_method, mixed $consumer, mixed $token) : mixed
Parameters
- $signature_method : mixed
- $consumer : mixed
- $token : mixed
Return values
mixed —from_consumer_and_token()
pretty much a helper function to set up the request
public
static from_consumer_and_token(mixed $consumer, mixed $token, mixed $http_method, mixed $http_url[, mixed $parameters = NULL ]) : mixed
Parameters
- $consumer : mixed
- $token : mixed
- $http_method : mixed
- $http_url : mixed
- $parameters : mixed = NULL
Return values
mixed —from_request()
attempt to build up a request from what was passed to the server
public
static from_request([mixed $http_method = NULL ][, mixed $http_url = NULL ][, mixed $parameters = NULL ]) : mixed
Parameters
- $http_method : mixed = NULL
- $http_url : mixed = NULL
- $parameters : mixed = NULL
Return values
mixed —get_normalized_http_method()
just uppercases the http method
public
get_normalized_http_method() : mixed
Return values
mixed —get_normalized_http_url()
parses the url and rebuilds it to be scheme://host/path
public
get_normalized_http_url() : mixed
Return values
mixed —get_parameter()
public
get_parameter(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —get_parameters()
public
get_parameters() : mixed
Return values
mixed —get_signable_parameters()
The request parameters, sorted and concatenated into a normalized string.
public
get_signable_parameters() : string
Return values
string —get_signature_base_string()
Returns the base string of this request
public
get_signature_base_string() : mixed
The base string defined as the method, the url and the parameters (normalized), each urlencoded and the concated with &.
Return values
mixed —set_parameter()
public
set_parameter(mixed $name, mixed $value[, mixed $allow_duplicates = true ]) : mixed
Parameters
- $name : mixed
- $value : mixed
- $allow_duplicates : mixed = true
Return values
mixed —sign_request()
public
sign_request(mixed $signature_method, mixed $consumer, mixed $token) : mixed
Parameters
- $signature_method : mixed
- $consumer : mixed
- $token : mixed
Return values
mixed —to_header()
builds the Authorization: header
public
to_header([mixed $realm = null ]) : mixed
Parameters
- $realm : mixed = null
Return values
mixed —to_postdata()
builds the data one would send in a POST request
public
to_postdata() : mixed
Return values
mixed —to_url()
builds a url usable for a GET request
public
to_url() : mixed
Return values
mixed —unset_parameter()
public
unset_parameter(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —generate_nonce()
util function: current nonce
private
static generate_nonce() : mixed
Return values
mixed —generate_timestamp()
util function: current timestamp
private
static generate_timestamp() : mixed