PHP Класс Mailgun\Connection\RestClient

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

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

Свойство Тип Описание
$apiHost string
$apiVersion string The version of the API to use.
$httpClient Http\Client\HttpClient
$sslEnabled boolean If we should use SSL or not.

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

Метод Описание
__construct ( string $apiKey, string $apiHost, Http\Client\HttpClient $httpClient = null )
delete ( string $endpointUrl ) : stdClass
get ( string $endpointUrl, array $queryString = [] ) : stdClass
post ( string $endpointUrl, array $postData = [], array $files = [] ) : stdClass
put ( string $endpointUrl, mixed $putData ) : stdClass
responseHandler ( Psr\Http\Message\ResponseInterface $responseObj ) : stdClass
setApiVersion ( string $apiVersion ) : RestClient
setSslEnabled ( boolean $sslEnabled ) : RestClient

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

Метод Описание
getHttpClient ( ) : Http\Client\HttpClient
getResponseExceptionMessage ( Psr\Http\Message\ResponseInterface $responseObj ) : string
prepareFile ( string $fieldName, string | array $filePath, integer $fileIndex ) : array Prepare a file for the postBody.
send ( string $method, string $uri, mixed $body = null, array $files = [], array $headers = [] ) : stdClass

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

Метод Описание
generateEndpoint ( string $apiEndpoint, string $apiVersion, boolean $ssl ) : string
getApiUrl ( $uri ) : string

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

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

public __construct ( string $apiKey, string $apiHost, Http\Client\HttpClient $httpClient = null )
$apiKey string
$apiHost string
$httpClient Http\Client\HttpClient

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

public delete ( string $endpointUrl ) : stdClass
$endpointUrl string
Результат stdClass

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

public get ( string $endpointUrl, array $queryString = [] ) : stdClass
$endpointUrl string
$queryString array
Результат stdClass

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

protected getHttpClient ( ) : Http\Client\HttpClient
Результат Http\Client\HttpClient

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

protected getResponseExceptionMessage ( Psr\Http\Message\ResponseInterface $responseObj ) : string
$responseObj Psr\Http\Message\ResponseInterface
Результат string

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

public post ( string $endpointUrl, array $postData = [], array $files = [] ) : stdClass
$endpointUrl string
$postData array
$files array
Результат stdClass

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

Prepare a file for the postBody.
protected prepareFile ( string $fieldName, string | array $filePath, integer $fileIndex ) : array
$fieldName string
$filePath string | array
$fileIndex integer
Результат array

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

public put ( string $endpointUrl, mixed $putData ) : stdClass
$endpointUrl string
$putData mixed
Результат stdClass

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

public responseHandler ( Psr\Http\Message\ResponseInterface $responseObj ) : stdClass
$responseObj Psr\Http\Message\ResponseInterface
Результат stdClass

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

protected send ( string $method, string $uri, mixed $body = null, array $files = [], array $headers = [] ) : stdClass
$method string
$uri string
$body mixed
$files array
$headers array
Результат stdClass

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

public setApiVersion ( string $apiVersion ) : RestClient
$apiVersion string
Результат RestClient

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

Устаревший: To be removed in 3.0
public setSslEnabled ( boolean $sslEnabled ) : RestClient
$sslEnabled boolean
Результат RestClient

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

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

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

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

The version of the API to use.
protected string $apiVersion
Результат string

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

protected HttpClient,Http\Client $httpClient
Результат Http\Client\HttpClient

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

If we should use SSL or not.
Устаревший: To be removed in 3.0
protected bool $sslEnabled
Результат boolean