BlackbaudSKY
extends AbstractProvider
in package
uses
ArrayAccessorTrait
Table of Contents
Constants
- ACCESS_KEY = 'Bb-Api-Subscription-Key'
- ACCESS_TOKEN = 'access_token'
- ARG_AUTH_CODE = 'authorization_code'
- OPT_ACCESS_TOKEN_CALLBACK = 'access_token_callback'
- OPT_AUTH_CODE_CALLBACK = 'authorization_code_callback'
- OPT_ERROR_CALLBACK = 'error_callback'
- OPT_PARAMS = 'params'
- OPT_REDIRECT_URI = 'redirect_uri'
- PARAM_CODE = 'code'
- PARAM_STATE = 'state'
- SESSION_STATE = 'oauth2_state'
Properties
- $accessToken : AccessToken
- $accessKey : mixed
Methods
- __construct() : mixed
- endpoint() : SkyAPIEndpoint
- getAccessToken() : mixed
- getBaseAccessTokenUrl() : mixed
- getBaseApiUrl() : mixed
- getBaseAuthorizationUrl() : mixed
- getResourceOwnerDetailsUrl() : mixed
- setAccessToken() : mixed
- checkResponse() : mixed
- createResourceOwner() : mixed
- getAuthorizationHeaders() : array<string|int, mixed>
- Returns authorization headers for the 'bearer' grant.
- getDefaultScopes() : mixed
Constants
ACCESS_KEY
public
mixed
ACCESS_KEY
= 'Bb-Api-Subscription-Key'
ACCESS_TOKEN
public
mixed
ACCESS_TOKEN
= 'access_token'
ARG_AUTH_CODE
public
mixed
ARG_AUTH_CODE
= 'authorization_code'
OPT_ACCESS_TOKEN_CALLBACK
public
mixed
OPT_ACCESS_TOKEN_CALLBACK
= 'access_token_callback'
OPT_AUTH_CODE_CALLBACK
public
mixed
OPT_AUTH_CODE_CALLBACK
= 'authorization_code_callback'
OPT_ERROR_CALLBACK
public
mixed
OPT_ERROR_CALLBACK
= 'error_callback'
OPT_PARAMS
public
mixed
OPT_PARAMS
= 'params'
OPT_REDIRECT_URI
public
mixed
OPT_REDIRECT_URI
= 'redirect_uri'
PARAM_CODE
public
mixed
PARAM_CODE
= 'code'
PARAM_STATE
public
mixed
PARAM_STATE
= 'state'
SESSION_STATE
public
mixed
SESSION_STATE
= 'oauth2_state'
Properties
$accessToken
protected
AccessToken
$accessToken
$accessKey
private
mixed
$accessKey
Methods
__construct()
public
__construct([array<string|int, mixed> $options = [] ][, array<string|int, mixed> $collaborators = [] ]) : mixed
Parameters
- $options : array<string|int, mixed> = []
- $collaborators : array<string|int, mixed> = []
endpoint()
public
endpoint(string $path[, AccessToken|null $token = null ]) : SkyAPIEndpoint
externalized to groton-school/appengine-sky-api
Parameters
- $path : string
- $token : AccessToken|null = null
Return values
SkyAPIEndpointgetAccessToken()
public
getAccessToken([mixed $grant = '' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $grant : mixed = ''
- $options : array<string|int, mixed> = []
getBaseAccessTokenUrl()
public
getBaseAccessTokenUrl(array<string|int, mixed> $params) : mixed
Parameters
- $params : array<string|int, mixed>
getBaseApiUrl()
public
getBaseApiUrl() : mixed
getBaseAuthorizationUrl()
public
getBaseAuthorizationUrl() : mixed
getResourceOwnerDetailsUrl()
public
getResourceOwnerDetailsUrl(AccessToken $token) : mixed
Parameters
- $token : AccessToken
setAccessToken()
public
setAccessToken(AccessToken $accessToken) : mixed
Parameters
- $accessToken : AccessToken
checkResponse()
protected
checkResponse(ResponseInterface $response, mixed $data) : mixed
Parameters
- $response : ResponseInterface
- $data : mixed
createResourceOwner()
protected
createResourceOwner(array<string|int, mixed> $response, AccessToken $token) : mixed
Parameters
- $response : array<string|int, mixed>
- $token : AccessToken
getAuthorizationHeaders()
Returns authorization headers for the 'bearer' grant.
protected
getAuthorizationHeaders([AccessTokenInterface|string|null $token = null ]) : array<string|int, mixed>
Parameters
- $token : AccessTokenInterface|string|null = null
-
Either a string or an access token instance
Return values
array<string|int, mixed>getDefaultScopes()
protected
getDefaultScopes() : mixed