\Overtrue\EasySms\GatewaysBaiduGateway

Class BaiduGateway.

Summary

Methods

Properties

Constants

__construct()
getTimeout()
setTimeout()
getConfig()
setConfig()
setGuzzleOptions()
getGuzzleOptions()
getName()
send()

No public properties found

DEFAULT_TIMEOUT
ENDPOINT_HOST
ENDPOINT_URI
BCE_AUTH_VERSION
DEFAULT_EXPIRATION_IN_SECONDS
SUCCESS_CODE

get()
post()
postJson()
request()
getBaseOptions()
getHttpClient()
unwrapResponse()
buildEndpoint()
generateSign()
getCanonicalHeaders()
getHeadersToSign()

$config
$options
$timeout

N/A

No private methods found

No private properties found

N/A

File: vendor/overtrue/easy-sms/src/Gateways/BaiduGateway.php
Package: Application
Class hierarchy: Gateway

\Overtrue\EasySms\Gateways\BaiduGateway
Uses traits: \Overtrue\EasySms\Traits\HasHttpRequest
See also
Uses

Constants

DEFAULT_TIMEOUT

DEFAULT_TIMEOUT = 5.0

ENDPOINT_HOST

ENDPOINT_HOST = 'smsv3.bj.baidubce.com'

ENDPOINT_URI

ENDPOINT_URI = '/api/v3/sendSms'

BCE_AUTH_VERSION

BCE_AUTH_VERSION = 'bce-auth-v1'

DEFAULT_EXPIRATION_IN_SECONDS

DEFAULT_EXPIRATION_IN_SECONDS = 1800

SUCCESS_CODE

SUCCESS_CODE = 1000

Properties

$config

$config : \Overtrue\EasySms\Support\Config

Type

Config —

$options

$options : array

Type

array —

$timeout

$timeout : float

Type

float —

Methods

__construct()

__construct(array  $config) : mixed

Gateway constructor.

Parameters

array

$config

Returns

mixed —

getTimeout()

getTimeout() : int|mixed

Return timeout.

Returns

int|mixed —

setTimeout()

setTimeout(int  $timeout) : $this

Set timeout.

Parameters

int

$timeout

Returns

$this —

getConfig()

getConfig() : \Overtrue\EasySms\Support\Config

Returns

\Overtrue\EasySms\Support\Config —

setConfig()

setConfig(\Overtrue\EasySms\Support\Config  $config) : $this

Parameters

\Overtrue\EasySms\Support\Config

$config

Returns

$this —

setGuzzleOptions()

setGuzzleOptions( $options) : $this

Parameters

$options

Returns

$this —

getGuzzleOptions()

getGuzzleOptions() : array

Returns

array —

getName()

getName() : string

Get gateway name.

Returns

string —

send()

send(\Overtrue\EasySms\Contracts\PhoneNumberInterface  $to, \Overtrue\EasySms\Contracts\MessageInterface  $message, \Overtrue\EasySms\Support\Config  $config) : array

Send message.

Parameters

\Overtrue\EasySms\Contracts\PhoneNumberInterface	$to
\Overtrue\EasySms\Contracts\MessageInterface	$message
\Overtrue\EasySms\Support\Config	$config

Throws

\Overtrue\EasySms\Exceptions\GatewayErrorException: ;

Returns

array —

get()

get(string  $endpoint, array  $query = [], array  $headers = []) : \Psr\Http\Message\ResponseInterface|array|string

Make a get request.

Parameters

string	$endpoint
array	$query
array	$headers

Returns

\Psr\Http\Message\ResponseInterface|array|string —

post()

post(string  $endpoint, array  $params = [], array  $headers = []) : \Psr\Http\Message\ResponseInterface|array|string

Make a post request.

Parameters

string	$endpoint
array	$params
array	$headers

Returns

\Psr\Http\Message\ResponseInterface|array|string —

postJson()

postJson( $endpoint, array  $params = [], array  $headers = []) : \Psr\Http\Message\ResponseInterface|array|string

Make a post request with json params.

Parameters

	$endpoint
array	$params
array	$headers

Returns

\Psr\Http\Message\ResponseInterface|array|string —

request()

request(string  $method, string  $endpoint, array  $options = []) : \Psr\Http\Message\ResponseInterface|array|string

Make a http request.

Parameters

string	$method
string	$endpoint
array	$options	http://docs.guzzlephp.org/en/latest/request-options.html

Returns

\Psr\Http\Message\ResponseInterface|array|string —

getBaseOptions()

getBaseOptions() : array

Return base Guzzle options.

Returns

array —

getHttpClient()

getHttpClient(array  $options = []) : \GuzzleHttp\Client

Return http client.

Parameters

array

$options

Returns

\GuzzleHttp\Client —

Inherited from: \Overtrue\EasySms\Traits\HasHttpRequest
Uses

Tags

codeCoverageIgnore

unwrapResponse()

unwrapResponse(\Psr\Http\Message\ResponseInterface  $response) : \Psr\Http\Message\ResponseInterface|array|string

Convert response contents to json.

Parameters

\Psr\Http\Message\ResponseInterface

$response

Returns

\Psr\Http\Message\ResponseInterface|array|string —

buildEndpoint()

buildEndpoint(\Overtrue\EasySms\Support\Config  $config) : string

Build endpoint url.

Parameters

\Overtrue\EasySms\Support\Config

$config

Returns

string —

generateSign()

generateSign(array  $signHeaders, int  $datetime, \Overtrue\EasySms\Support\Config  $config) : string

Generate Authorization header.

Parameters

array	$signHeaders
int	$datetime
\Overtrue\EasySms\Support\Config	$config

Returns

string —

getCanonicalHeaders()

getCanonicalHeaders(array  $headers) : string

生成标准化 http 请求头串.

Parameters

array

$headers

Returns

string —

getHeadersToSign()

getHeadersToSign(array  $headers, array  $keys) : array

根据指定的 keys 过滤应该参与签名的 header.

Parameters

array	$headers
array	$keys

Returns

array —