PHP Класс Bitpay\Client\Client

Наследование: implements Bitpay\Client\ClientInterface
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$adapter Bitpay\Client\Adapter\AdapterInterface
$network Bitpay\Network\NetworkInterface
$privateKey Bitpay\PrivateKey
$publicKey Bitpay\PublicKey
$request Bitpay\Client\RequestInterface
$response Bitpay\Client\ResponseInterface
$token Bitpay\TokenInterface

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

Метод Описание
createInvoice ( Bitpay\InvoiceInterface $invoice )
createPayout ( Bitpay\PayoutInterface $payout )
createToken ( array $payload = [] )
deletePayout ( Bitpay\PayoutInterface $payout )
getCurrencies ( )
getInvoice ( $invoiceId )
getPayout ( $payoutId )
getPayouts ( $status = null )
getRequest ( ) : Bitpay\Client\RequestInterface Returns the request object that was sent to BitPay
getResponse ( ) : Bitpay\Client\ResponseInterface Returns the Response object that BitPay returned from the request that was sent
getTokens ( )
sendRequest ( Bitpay\Client\RequestInterface $request ) : Bitpay\Client\ResponseInterface
setAdapter ( Bitpay\Client\Adapter\AdapterInterface $adapter )
setNetwork ( Bitpay\Network\NetworkInterface $network ) The network is either livenet or testnet and tells the client where to send the requests.
setPrivateKey ( PrivateKey $key ) Set the Private Key to use, this is used when signing request strings
setPublicKey ( PublicKey $key ) Set the Public Key to use to help identify who you are to BitPay. Please note that you must first pair your keys and get a token in return to use.
setToken ( Bitpay\TokenInterface $token ) : Bitpay\Client\ClientInterface

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

Метод Описание
addIdentityHeader ( Bitpay\Client\RequestInterface $request )
addSignatureHeader ( Bitpay\Client\RequestInterface $request )
checkPriceAndCurrency ( $price, $currency )
createNewRequest ( ) : Bitpay\Client\RequestInterface
prepareRequestHeaders ( Bitpay\Client\RequestInterface $request ) Prepares the request object by adding additional headers

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

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

protected addIdentityHeader ( Bitpay\Client\RequestInterface $request )
$request Bitpay\Client\RequestInterface

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

protected addSignatureHeader ( Bitpay\Client\RequestInterface $request )
$request Bitpay\Client\RequestInterface

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

protected checkPriceAndCurrency ( $price, $currency )

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

public createInvoice ( Bitpay\InvoiceInterface $invoice )
$invoice Bitpay\InvoiceInterface

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

protected createNewRequest ( ) : Bitpay\Client\RequestInterface
Результат Bitpay\Client\RequestInterface

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

public createPayout ( Bitpay\PayoutInterface $payout )
$payout Bitpay\PayoutInterface

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

public createToken ( array $payload = [] )
$payload array

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

public deletePayout ( Bitpay\PayoutInterface $payout )
$payout Bitpay\PayoutInterface

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

public getCurrencies ( )

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

public getInvoice ( $invoiceId )

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

public getPayout ( $payoutId )

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

public getPayouts ( $status = null )

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

Returns the request object that was sent to BitPay
public getRequest ( ) : Bitpay\Client\RequestInterface
Результат Bitpay\Client\RequestInterface

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

Returns the Response object that BitPay returned from the request that was sent
public getResponse ( ) : Bitpay\Client\ResponseInterface
Результат Bitpay\Client\ResponseInterface

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

public getTokens ( )

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

Prepares the request object by adding additional headers
protected prepareRequestHeaders ( Bitpay\Client\RequestInterface $request )
$request Bitpay\Client\RequestInterface

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

public sendRequest ( Bitpay\Client\RequestInterface $request ) : Bitpay\Client\ResponseInterface
$request Bitpay\Client\RequestInterface
Результат Bitpay\Client\ResponseInterface

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

public setAdapter ( Bitpay\Client\Adapter\AdapterInterface $adapter )
$adapter Bitpay\Client\Adapter\AdapterInterface

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

The network is either livenet or testnet and tells the client where to send the requests.
public setNetwork ( Bitpay\Network\NetworkInterface $network )
$network Bitpay\Network\NetworkInterface

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

Set the Private Key to use, this is used when signing request strings
public setPrivateKey ( PrivateKey $key )
$key Bitpay\PrivateKey

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

Set the Public Key to use to help identify who you are to BitPay. Please note that you must first pair your keys and get a token in return to use.
public setPublicKey ( PublicKey $key )
$key Bitpay\PublicKey

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

public setToken ( Bitpay\TokenInterface $token ) : Bitpay\Client\ClientInterface
$token Bitpay\TokenInterface
Результат Bitpay\Client\ClientInterface

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

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

protected AdapterInterface,Bitpay\Client\Adapter $adapter
Результат Bitpay\Client\Adapter\AdapterInterface

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

protected NetworkInterface,Bitpay\Network $network
Результат Bitpay\Network\NetworkInterface

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

protected PrivateKey,Bitpay $privateKey
Результат Bitpay\PrivateKey

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

protected PublicKey,Bitpay $publicKey
Результат Bitpay\PublicKey

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

protected RequestInterface,Bitpay\Client $request
Результат Bitpay\Client\RequestInterface

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

protected ResponseInterface,Bitpay\Client $response
Результат Bitpay\Client\ResponseInterface

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

protected TokenInterface,Bitpay $token
Результат Bitpay\TokenInterface