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 () |
| | __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' |
Constructor & Destructor Documentation
| __construct |
( |
$ |
http_method, |
|
|
$ |
http_url, |
|
|
$ |
parameters = NULL | |
|
) |
| | |
Member Function Documentation
| build_signature |
( |
$ |
signature_method, |
|
|
$ |
consumer, |
|
|
$ |
token | |
|
) |
| | |
| static from_consumer_and_token |
( |
$ |
consumer, |
|
|
$ |
token, |
|
|
$ |
http_method, |
|
|
$ |
http_url, |
|
|
$ |
parameters = NULL | |
|
) |
| | [static] |
pretty much a helper function to set up the request
| 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
| get_normalized_http_method |
( |
|
) |
|
just uppercases the http method
| get_normalized_http_url |
( |
|
) |
|
parses the url and rebuilds it to be scheme://host/path
| get_signable_parameters |
( |
|
) |
|
The request parameters, sorted and concatenated into a normalized string.
- Returns:
- string
| 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 &.
| set_parameter |
( |
$ |
name, |
|
|
$ |
value, |
|
|
$ |
allow_duplicates = true | |
|
) |
| | |
| sign_request |
( |
$ |
signature_method, |
|
|
$ |
consumer, |
|
|
$ |
token | |
|
) |
| | |
builds the Authorization: header
builds the data one would send in a POST request
builds a url usable for a GET request
| unset_parameter |
( |
$ |
name |
) |
|
Field Documentation
$POST_INPUT = 'php://input' [static] |
$version = '1.0' [static] |
The documentation for this class was generated from the following file:
- C:/Projekte/web/wayati.com/httpdocs/OAuth.php
