Gitee
\
EasyWeChat
BasicService
ContentSecurity
Jssdk
Media
QrCode
Url
Kernel
Clauses
Contracts
Decorators
Exceptions
Http
Log
Messages
Providers
Support
Traits
MiniProgram
AppCode
Auth
CustomerService
DataCube
OpenData
Server
Store
TemplateMessage
OfficialAccount
Auth
AutoReply
Base
Broadcasting
Card
Comment
CustomerService
DataCube
Device
Material
Menu
OAuth
POI
Semantic
Server
Handlers
ShakeAround
TemplateMessage
User
OpenPlatform
Auth
Authorizer
Aggregate
Account
Auth
MiniProgram
Auth
Code
Domain
Tester
OfficialAccount
Account
MiniProgram
OAuth
Server
Base
CodeTemplate
Server
Handlers
OpenWork
Auth
Corp
Provider
Server
Handlers
SuiteAuth
Work
Auth
Payment
Base
Bill
Coupon
Jssdk
Kernel
Exceptions
Merchant
Notify
Order
Redpack
Refund
Reverse
Sandbox
Security
Transfer
Work
Agent
Auth
Base
Chat
Crm
Department
Invoice
Jssdk
Media
Menu
Message
MiniProgram
Auth
OA
OAuth
Server
Handlers
User

\EasyWeChat\OpenPlatform\Authorizer\AuthAccessToken

Class AccessToken.

Summary

Methods
Properties
Constants
__construct()
getRefreshedToken()
getToken()
setToken()
refresh()
requestToken()
applyToRequest()
getEndpoint()
setDefaultOptions()
getDefaultOptions()
setHttpClient()
getHttpClient()
pushMiddleware()
getMiddlewares()
request()
setHandlerStack()
getHandlerStack()
getCache()
setCache()
No public properties found
No constants found
sendRequest()
getCacheKey()
getQuery()
getCredentials()
fixJsonIssue()
createDefaultCache()
$app
$requestMethod
$endpointToGetToken
$queryName
$token
$safeSeconds
$tokenKey
$cachePrefix
$httpClient
$middlewares
$handlerStack
$defaults
$cache
$component
N/A
No private methods found
No private properties found
N/A

Properties

$app

$app : \Pimple\Container

Type

\Pimple\Container

$requestMethod

$requestMethod : string

Type

string

$endpointToGetToken

$endpointToGetToken : string

Type

string

$queryName

$queryName : string

Type

string

$token

$token : array

Type

array

$safeSeconds

$safeSeconds : integer

Type

integer

$tokenKey

$tokenKey : string

{@inheritdoc}.

Type

string

$cachePrefix

$cachePrefix : string

Type

string

$httpClient

$httpClient : \GuzzleHttp\ClientInterface

Type

\GuzzleHttp\ClientInterface

$middlewares

$middlewares : array

Type

array

$handlerStack

$handlerStack : \GuzzleHttp\HandlerStack

Type

\GuzzleHttp\HandlerStack

$defaults

$defaults : array

Type

array

$cache

$cache : \Psr\SimpleCache\CacheInterface

Type

\Psr\SimpleCache\CacheInterface

Methods

__construct()

__construct(\Pimple\Container  $app, \EasyWeChat\OpenPlatform\Application  $component)

AuthorizerAccessToken constructor.

Parameters

\Pimple\Container $app
\EasyWeChat\OpenPlatform\Application $component

getRefreshedToken()

getRefreshedToken() : array

Throws

\EasyWeChat\Kernel\Exceptions\HttpException
\Psr\SimpleCache\InvalidArgumentException
\EasyWeChat\Kernel\Exceptions\InvalidConfigException
\EasyWeChat\Kernel\Exceptions\InvalidArgumentException

Returns

array

getToken()

getToken(boolean  $refresh = false) : array

Parameters

boolean $refresh

Throws

\EasyWeChat\Kernel\Exceptions\HttpException
\Psr\SimpleCache\InvalidArgumentException
\EasyWeChat\Kernel\Exceptions\InvalidConfigException
\EasyWeChat\Kernel\Exceptions\InvalidArgumentException

Returns

array

setToken()

setToken(string  $token, integer  $lifetime = 7200) : \EasyWeChat\Kernel\Contracts\AccessTokenInterface

Parameters

string $token
integer $lifetime

Throws

\Psr\SimpleCache\InvalidArgumentException

Returns

\EasyWeChat\Kernel\Contracts\AccessTokenInterface

refresh()

refresh() : \EasyWeChat\Kernel\Contracts\AccessTokenInterface

Throws

\EasyWeChat\Kernel\Exceptions\HttpException
\Psr\SimpleCache\InvalidArgumentException
\EasyWeChat\Kernel\Exceptions\InvalidConfigException
\EasyWeChat\Kernel\Exceptions\InvalidArgumentException

Returns

\EasyWeChat\Kernel\Contracts\AccessTokenInterface

requestToken()

requestToken(array  $credentials, boolean  $toArray = false) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Parameters

array $credentials
boolean $toArray

Throws

\EasyWeChat\Kernel\Exceptions\HttpException
\EasyWeChat\Kernel\Exceptions\InvalidConfigException
\EasyWeChat\Kernel\Exceptions\InvalidArgumentException

Returns

\Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

applyToRequest()

applyToRequest(\Psr\Http\Message\RequestInterface  $request, array  $requestOptions = array()) : \Psr\Http\Message\RequestInterface

Parameters

\Psr\Http\Message\RequestInterface $request
array $requestOptions

Throws

\EasyWeChat\Kernel\Exceptions\HttpException
\Psr\SimpleCache\InvalidArgumentException
\EasyWeChat\Kernel\Exceptions\InvalidConfigException
\EasyWeChat\Kernel\Exceptions\InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

getEndpoint()

getEndpoint() : string

Returns

string

setDefaultOptions()

setDefaultOptions(array  $defaults = array())

Set guzzle default settings.

Parameters

array $defaults

getDefaultOptions()

getDefaultOptions() : array

Return current guzzle default settings.

Returns

array

setHttpClient()

setHttpClient(\GuzzleHttp\ClientInterface  $httpClient) : $this

Set GuzzleHttp\Client.

Parameters

\GuzzleHttp\ClientInterface $httpClient

Returns

$this

getHttpClient()

getHttpClient() : \GuzzleHttp\ClientInterface

Return GuzzleHttp\ClientInterface instance.

Returns

\GuzzleHttp\ClientInterface

pushMiddleware()

pushMiddleware(callable  $middleware, null|string  $name = null) : $this

Add a middleware.

Parameters

callable $middleware
null|string $name

Returns

$this

getMiddlewares()

getMiddlewares() : array

Return all middlewares.

Returns

array

request()

request(string  $url, string  $method = 'GET', array  $options = array()) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Make a request.

Parameters

string $url
string $method
array $options

Returns

\Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

setHandlerStack()

setHandlerStack(\GuzzleHttp\HandlerStack  $handlerStack) : $this

Parameters

\GuzzleHttp\HandlerStack $handlerStack

Returns

$this

getHandlerStack()

getHandlerStack() : \GuzzleHttp\HandlerStack

Build a handler stack.

Returns

\GuzzleHttp\HandlerStack

getCache()

getCache() : \Psr\SimpleCache\CacheInterface

Get cache instance.

Returns

\Psr\SimpleCache\CacheInterface

setCache()

setCache(\Psr\SimpleCache\CacheInterface  $cache) : $this

Set cache instance.

Parameters

\Psr\SimpleCache\CacheInterface $cache

Returns

$this

sendRequest()

sendRequest(array  $credentials) : \Psr\Http\Message\ResponseInterface

Send http request.

Parameters

array $credentials

Throws

\EasyWeChat\Kernel\Exceptions\InvalidArgumentException

Returns

\Psr\Http\Message\ResponseInterface

getCacheKey()

getCacheKey() : string

Returns

string

getQuery()

getQuery() : array

The request query will be used to add to the request.

Throws

\EasyWeChat\Kernel\Exceptions\HttpException
\Psr\SimpleCache\InvalidArgumentException
\EasyWeChat\Kernel\Exceptions\InvalidConfigException
\EasyWeChat\Kernel\Exceptions\InvalidArgumentException

Returns

array

getCredentials()

getCredentials() : array

{@inheritdoc}.

Returns

array

fixJsonIssue()

fixJsonIssue(array  $options) : array

Parameters

array $options

Returns

array

createDefaultCache()

createDefaultCache() : \Symfony\Component\Cache\Simple\FilesystemCache

Returns

\Symfony\Component\Cache\Simple\FilesystemCache