PHP Класс PayPal\Auth\Oauth\OAuthRequest

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$POST_INPUT
$base_string for debug purposes
$parameters
$version

Защищенные свойства (Protected)

Свойство Тип Описание
$http_method
$http_url

Открытые методы

Метод Описание
__construct ( $http_method, $http_url, $parameters = null )
__toString ( )
build_signature ( $signature_method, $consumer, $token )
from_consumer_and_token ( $consumer, $token, $http_method, $http_url, $parameters = null ) pretty much a helper function to set up the request
from_request ( $http_method = null, $http_url = null, $parameters = null ) 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_parameter ( $name )
get_parameters ( )
get_signable_parameters ( ) : string The request parameters, sorted and concatenated into a normalized string.
get_signature_base_string ( ) Returns the base string of this request
set_parameter ( $name, $value, $allow_duplicates = true )
sign_request ( $signature_method, $consumer, $token )
to_header ( $realm = null ) builds the Authorization: header
to_postdata ( ) builds the data one would send in a POST request
to_url ( ) builds a url usable for a GET request
unset_parameter ( $name )

Приватные методы

Метод Описание
generate_nonce ( ) util function: current nonce
generate_timestamp ( ) util function: current timestamp

Описание методов

__construct() публичный Метод

public __construct ( $http_method, $http_url, $parameters = null )

__toString() публичный Метод

public __toString ( )

build_signature() публичный Метод

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

from_consumer_and_token() публичный статический Метод

pretty much a helper function to set up the request
public static from_consumer_and_token ( $consumer, $token, $http_method, $http_url, $parameters = null )

from_request() публичный статический Метод

attempt to build up a request from what was passed to the server
public static from_request ( $http_method = null, $http_url = null, $parameters = null )

get_normalized_http_method() публичный Метод

just uppercases the http method
public get_normalized_http_method ( )

get_normalized_http_url() публичный Метод

parses the url and rebuilds it to be scheme://host/path
public get_normalized_http_url ( )

get_parameter() публичный Метод

public get_parameter ( $name )

get_parameters() публичный Метод

public get_parameters ( )

get_signable_parameters() публичный Метод

The request parameters, sorted and concatenated into a normalized string.
public get_signable_parameters ( ) : string
Результат string

get_signature_base_string() публичный Метод

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

set_parameter() публичный Метод

public set_parameter ( $name, $value, $allow_duplicates = true )

sign_request() публичный Метод

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

to_header() публичный Метод

builds the Authorization: header
public to_header ( $realm = null )

to_postdata() публичный Метод

builds the data one would send in a POST request
public to_postdata ( )

to_url() публичный Метод

builds a url usable for a GET request
public to_url ( )

unset_parameter() публичный Метод

public unset_parameter ( $name )

Описание свойств

$POST_INPUT публичное статическое свойство

public static $POST_INPUT

$base_string публичное свойство

for debug purposes
public $base_string

$http_method защищенное свойство

protected $http_method

$http_url защищенное свойство

protected $http_url

$parameters публичное свойство

public $parameters

$version публичное статическое свойство

public static $version