PHP Класс TTools\OAuthRequest

Показать файл Открыть проект

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

Свойство Тип Описание
$boundary string
$consumerKey Application consumer key
$consumerSecret Application consumer secret
$headers array
$requestBody string
$token Request Token
$tokenSecret Request Secret
$userAgent Curl User Agent

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

Метод Описание
__construct ( string $consumerKey, string $consumerSecret, string $token, string $tokenSecret ) Creates the OAuthRequest object
addHeader ( string $header )
buildHeaders ( $method, $url, $params = [], $multipart = false )
getConsumerKey ( ) : string
getConsumerSecret ( ) : string
getHeaders ( ) : mixed
getRequestBody ( ) : mixed
getToken ( ) : string
getTokenSecret ( ) : string
getUserAgent ( ) : string
request ( string $method, string $url, array $params = [], boolean $multipart = false ) : OAuthResponse Performs an authenticated OAuth Request
setConsumerKey ( string $consumerKey )
setConsumerSecret ( string $consumerSecret )
setHeaders ( mixed $headers )
setRequestBody ( mixed $requestBody )
setToken ( string $token )
setTokenSecret ( string $tokenSecret )
setUserAgent ( string $userAgent )

Защищенные методы

Метод Описание
buildMultipartContent ( $file )
curlRequest ( string $url, array $params = [], string $method = 'GET', boolean $multipart = false ) : OAuthResponse Performs a OAuth curl request.
encodeParams ( array $params = [], boolean $quoted = false ) : array Encodes parameters
formatQueryString ( array $params ) : string
getOAuthHeader ( string $method, string $url, array $params = [], boolean $multipart = false ) : string Gets the OAuth signed Authorization headers
urlencodeRfc3986 ( $input ) : array | mixed | string

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

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

Creates the OAuthRequest object
public __construct ( string $consumerKey, string $consumerSecret, string $token, string $tokenSecret )
$consumerKey string Application Consumer Key
$consumerSecret string Application Consumer Secret
$token string Request Token
$tokenSecret string Request Token Secret

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

public addHeader ( string $header )
$header string

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

public buildHeaders ( $method, $url, $params = [], $multipart = false )

buildMultipartContent() защищенный Метод

protected buildMultipartContent ( $file )

curlRequest() защищенный Метод

Performs a OAuth curl request.
protected curlRequest ( string $url, array $params = [], string $method = 'GET', boolean $multipart = false ) : OAuthResponse
$url string
$params array
$method string
$multipart boolean
Результат OAuthResponse

encodeParams() защищенный Метод

Encodes parameters
protected encodeParams ( array $params = [], boolean $quoted = false ) : array
$params array
$quoted boolean
Результат array

formatQueryString() защищенный Метод

protected formatQueryString ( array $params ) : string
$params array
Результат string

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

public getConsumerKey ( ) : string
Результат string

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

public getConsumerSecret ( ) : string
Результат string

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

public getHeaders ( ) : mixed
Результат mixed

getOAuthHeader() защищенный Метод

Gets the OAuth signed Authorization headers
protected getOAuthHeader ( string $method, string $url, array $params = [], boolean $multipart = false ) : string
$method string
$url string
$params array
$multipart boolean
Результат string

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

public getRequestBody ( ) : mixed
Результат mixed

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

public getToken ( ) : string
Результат string

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

public getTokenSecret ( ) : string
Результат string

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

public getUserAgent ( ) : string
Результат string

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

Performs an authenticated OAuth Request
public request ( string $method, string $url, array $params = [], boolean $multipart = false ) : OAuthResponse
$method string Request Method (GET / POST)
$url string Request endpoint (e.g: /1.1/account/verify_credentials.json)
$params array Params for the request
$multipart boolean If the request is multipart or not (defaults to false)
Результат OAuthResponse Returns an OAuthResponse object

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

public setConsumerKey ( string $consumerKey )
$consumerKey string

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

public setConsumerSecret ( string $consumerSecret )
$consumerSecret string

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

public setHeaders ( mixed $headers )
$headers mixed

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

public setRequestBody ( mixed $requestBody )
$requestBody mixed

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

public setToken ( string $token )
$token string

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

public setTokenSecret ( string $tokenSecret )
$tokenSecret string

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

public setUserAgent ( string $userAgent )
$userAgent string

urlencodeRfc3986() защищенный Метод

protected urlencodeRfc3986 ( $input ) : array | mixed | string
$input
Результат array | mixed | string

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

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

protected string $boundary
Результат string

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

Application consumer key
protected $consumerKey

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

Application consumer secret
protected $consumerSecret

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

protected array $headers
Результат array

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

protected string $requestBody
Результат string

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

Request Token
protected $token

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

Request Secret
protected $tokenSecret

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

Curl User Agent
protected $userAgent