PHP Класс Postmark\PostmarkClientBase

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

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

Свойство	Тип	Описание
$BASE_URL	string	You may modify this value to disable SSL support, but it is not recommended.
$VERIFY_SSL		In some PHP configurations, SSL/TLS certificates cannot be verified. Rather than disabling SSL/TLS entirely in these circumstances, you may disable certificate verification. This is dramatically better than disabling connecting to the Postmark API without TLS, as it's still encrypted, but the risk is that if your connection has been compromised, your application could be subject to a Man-in-the-middle attack. However, this is still a better outcome than using no encryption at all. If possible, you should try to resolve your PHP install's certificate issues as outline here: https://github.com/wildbit/postmark-php/wiki/SSL%20Errors%20on%20Windows

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

Свойство	Тип	Описание
$authorization_header
$authorization_token
$client	GuzzleHttp\Client
$os
$timeout
$version

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

Метод	Описание
setClient ( Client $client )	Provide a custom GuzzleHttp\Client to be used for HTTP requests

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

Метод	Описание
__construct ( $token, $header, $timeout = 30 )
getClient ( ) : Client	Return the injected GuzzleHttp\Client or create a default instance
processRestRequest ( string $method = NULL, string $path = NULL, array $body = [] ) : object	The base request method for all API access.

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

__construct() защищенный метод

protected __construct ( $token, $header, $timeout = 30 )

getClient() защищенный метод

Return the injected GuzzleHttp\Client or create a default instance

protected getClient ( ) : Client
Результат	GuzzleHttp\Client

processRestRequest() защищенный метод

The base request method for all API access.

protected processRestRequest ( string $method = NULL, string $path = NULL, array $body = [] ) : object
$method	string	The request VERB to use (GET, POST, PUT, DELETE)
$path	string	The API path.
$body	array	The content to be used (either as the query, or the json post/put body)
Результат	object

setClient() публичный метод

Provide a custom GuzzleHttp\Client to be used for HTTP requests

См. также: http://docs.guzzlephp.org/en/latest/ for a full list of configuration options The following options will be ignored: - http_errors - headers - query - json

public setClient ( Client $client )
$client	GuzzleHttp\Client

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

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

You may modify this value to disable SSL support, but it is not recommended.

public static string $BASE_URL
Результат	string

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

In some PHP configurations, SSL/TLS certificates cannot be verified. Rather than disabling SSL/TLS entirely in these circumstances, you may disable certificate verification. This is dramatically better than disabling connecting to the Postmark API without TLS, as it's still encrypted, but the risk is that if your connection has been compromised, your application could be subject to a Man-in-the-middle attack. However, this is still a better outcome than using no encryption at all. If possible, you should try to resolve your PHP install's certificate issues as outline here: https://github.com/wildbit/postmark-php/wiki/SSL%20Errors%20on%20Windows

public static $VERIFY_SSL

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

protected $authorization_header

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

protected $authorization_token

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

protected Client,GuzzleHttp $client
Результат	GuzzleHttp\Client

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

protected $os

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

protected $timeout

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

protected $version