Documentation

OpenCaching extends OAuth1Provider
in package

Application

Opencaching OAuth1

Constants

MAGIC_PROPERTIES = ['apiDocs', 'apiURL', 'applicationURL', 'serviceName', 'userRevokeURL']
USER_FIELDS = ['uuid', 'username', 'profile_url', 'internal_id', 'date_registered', 'caches_found', 'caches_notfound', 'caches_hidden', 'rcmds_given', 'rcmds_left', 'rcmd_founds_needed', 'home_location']

Properties

$accessTokenURL : string
$apiDocs : string|null
$apiURL : string
$applicationURL : string|null
$authURL : string
$http : ClientInterface
$logger : LoggerInterface
$options : OAuthOptions|SettingsContainerInterface
$requestFactory : RequestFactoryInterface
$requestTokenURL : string: The request OAuth1 token URL
$revokeURL : string: an optional URL for application side token revocation
$serviceName : string: the name of the provider/class (magic)
$storage : OAuthStorageInterface
$streamFactory : StreamFactoryInterface
$uriFactory : UriFactoryInterface
$userRevokeURL : string|null

Methods

__construct() : mixed: OAuthProvider constructor.
__get() : string|null: Magic getter for the properties specified in self::ALLOWED_PROPERTIES
getAccessToken() : AccessToken: Obtains an OAuth1 access token with the given $token and $verifier and returns an AccessToken object.
getAccessTokenFromStorage() : AccessToken: Gets an access token from the current OAuthStorageInterface (shorthand/convenience)
getAuthURL() : UriInterface
getRequestAuthorization() : RequestInterface
getStorage() : OAuthStorageInterface: Returns the current OAuthStorageInterface
InvalidateAccessToken() : bool
me() : ResponseInterface
request() : ResponseInterface: Prepares an API request to $path with the given parameters, gets authorization, fires the request and returns a PSR-7 ResponseInterface with the corresponding API response
sendRequest() : ResponseInterface
setLogger() : static: Sets an optional PSR-3 LoggerInterface
setRequestFactory() : static: Sets an optional PSR-17 RequestFactoryInterface
setStorage() : static: Sets an optional OAuthStorageInterface
setStreamFactory() : static: Sets an optional PSR-17 StreamFactoryInterface
setUriFactory() : static: Sets an optional PSR-17 UriFactoryInterface
storeAccessToken() : static: Sets an access token in the current OAuthStorageInterface (shorthand/convenience)
cleanBodyParams() : array<string|int, mixed>: Cleans an array of body parameters
cleanQueryParams() : array<string|int, mixed>: Cleans an array of query parameters
construct() : void: A replacement constructor that you can call in extended classes, so that you don't have to implement the monstrous original `__construct()`
createAccessToken() : AccessToken: Creates an access token with the provider set to $this->serviceName
getRequestBody() : StreamInterface: Prepares the request body
getRequestHeaders() : array<string|int, mixed>: Prepare request headers
getRequestTarget() : string: Determine the request target from the given URI (path segment or URL) with respect to $apiURL, anything except host and path will be ignored, scheme will always be set to "https".
getRequestTokenRequestParams() : array<string|int, mixed>: prepares the parameters for the request token request header
getRequestURL() : string: Prepares the request URL
getSignature() : string: Generates a request signature
nonce() : string: returns a 32 byte random string (in hexadecimal representation) for use as a nonce
parseTokenResponse() : AccessToken: Parses the response from a request to the token endpoint
sendAccessTokenRequest() : ResponseInterface: Sends the access token request
sendRequestTokenRequest() : ResponseInterface: Sends a request to the request token endpoint

MAGIC_PROPERTIES


    protected
        array<string|int, string>
    MAGIC_PROPERTIES
    = ['apiDocs', 'apiURL', 'applicationURL', 'serviceName', 'userRevokeURL']

USER_FIELDS


    protected
        mixed
    USER_FIELDS
    = ['uuid', 'username', 'profile_url', 'internal_id', 'date_registered', 'caches_found', 'caches_notfound', 'caches_hidden', 'rcmds_given', 'rcmds_left', 'rcmd_founds_needed', 'home_location']

$accessTokenURL


    protected
        string
    $accessTokenURL
     = 'https://www.opencaching.de/okapi/services/oauth/access_token'

$apiDocs


    protected
        string|null
    $apiDocs
     = 'https://www.opencaching.de/okapi/'

$apiURL


    protected
        string
    $apiURL
     = 'https://www.opencaching.de/okapi/services'

$applicationURL


    protected
        string|null
    $applicationURL
     = 'https://www.opencaching.de/okapi/signup.html'

$authURL


    protected
        string
    $authURL
     = 'https://www.opencaching.de/okapi/services/oauth/authorize'

$http


    protected
        ClientInterface
    $http

$logger


    protected
        LoggerInterface
    $logger
     = new NullLogger()

$options


    protected
        OAuthOptions|SettingsContainerInterface
    $options

$requestFactory


    protected
        RequestFactoryInterface
    $requestFactory

$requestTokenURL

The request OAuth1 token URL


    protected
        string
    $requestTokenURL
     = 'https://www.opencaching.de/okapi/services/oauth/request_token'

$revokeURL

an optional URL for application side token revocation


    protected
        string
    $revokeURL

$serviceName

the name of the provider/class (magic)


    protected
        string
    $serviceName

$storage


    protected
        OAuthStorageInterface
    $storage
     = new MemoryStorage()

$streamFactory


    protected
        StreamFactoryInterface
    $streamFactory

$uriFactory


    protected
        UriFactoryInterface
    $uriFactory

$userRevokeURL


    protected
        string|null
    $userRevokeURL
     = 'https://www.opencaching.de/okapi/apps/'

__construct()

OAuthProvider constructor.


    public
                    __construct(OAuthOptions|SettingsContainerInterface $options, ClientInterface $http, RequestFactoryInterface $requestFactory, StreamFactoryInterface $streamFactory, UriFactoryInterface $uriFactory[, OAuthStorageInterface $storage = new MemoryStorage() ][, LoggerInterface $logger = new NullLogger() ]) : mixed

Parameters

$options : OAuthOptions|SettingsContainerInterface
$http : ClientInterface
$requestFactory : RequestFactoryInterface
$streamFactory : StreamFactoryInterface
$uriFactory : UriFactoryInterface
$storage : OAuthStorageInterface = new MemoryStorage()
$logger : LoggerInterface = new NullLogger()

__get()

Magic getter for the properties specified in self::ALLOWED_PROPERTIES


    public
        final            __get(string $name) : string|null

Parameters

$name : string

Return values

string|null

getAccessToken()

Obtains an OAuth1 access token with the given $token and $verifier and returns an AccessToken object.


    public
                    getAccessToken(string $requestToken, string $verifier) : AccessToken

Parameters

$requestToken : string
$verifier : string

Return values

AccessToken

getAccessTokenFromStorage()

Gets an access token from the current OAuthStorageInterface (shorthand/convenience)


    public
                    getAccessTokenFromStorage() : AccessToken

Return values

AccessToken

getAuthURL()


    public
                    getAuthURL([array<string|int, mixed>|null $params = null ][, array<string|int, mixed>|null $scopes = null ]) : UriInterface

Parameters

$params : array<string|int, mixed>|null = null
$scopes : array<string|int, mixed>|null = null

Return values

UriInterface

getRequestAuthorization()


    public
                    getRequestAuthorization(RequestInterface $request[, AccessToken|null $token = null ]) : RequestInterface

Parameters

$request : RequestInterface
$token : AccessToken|null = null

Return values

RequestInterface

getStorage()

Returns the current OAuthStorageInterface


    public
        final            getStorage() : OAuthStorageInterface

Return values

OAuthStorageInterface

InvalidateAccessToken()


    public
                    InvalidateAccessToken([AccessToken|null $token = null ]) : bool

Parameters

$token : AccessToken|null = null

Return values

bool

me()


    public
                    me() : ResponseInterface

Return values

ResponseInterface

request()

Prepares an API request to $path with the given parameters, gets authorization, fires the request and returns a PSR-7 ResponseInterface with the corresponding API response


    public
                    request(string $path[, array<string|int, mixed>|null $params = null ][, string|null $method = null ][, StreamInterface|array<string|int, mixed>|string|null $body = null ][, array<string|int, mixed>|null $headers = null ][, string|null $protocolVersion = null ]) : ResponseInterface

Parameters

$path : string
$params : array<string|int, mixed>|null = null
$method : string|null = null
$body : StreamInterface|array<string|int, mixed>|string|null = null
$headers : array<string|int, mixed>|null = null
$protocolVersion : string|null = null

Return values

ResponseInterface

sendRequest()


    public
        final            sendRequest(RequestInterface $request) : ResponseInterface

Parameters

$request : RequestInterface

Return values

ResponseInterface

setLogger()

Sets an optional PSR-3 LoggerInterface


    public
        final            setLogger(LoggerInterface $logger) : static

Parameters

$logger : LoggerInterface

Return values

static

setRequestFactory()

Sets an optional PSR-17 RequestFactoryInterface


    public
        final            setRequestFactory(RequestFactoryInterface $requestFactory) : static

Parameters

$requestFactory : RequestFactoryInterface

Return values

static

setStorage()

Sets an optional OAuthStorageInterface


    public
        final            setStorage(OAuthStorageInterface $storage) : static

Parameters

$storage : OAuthStorageInterface

Return values

static

setStreamFactory()

Sets an optional PSR-17 StreamFactoryInterface


    public
        final            setStreamFactory(StreamFactoryInterface $streamFactory) : static

Parameters

$streamFactory : StreamFactoryInterface

Return values

static

setUriFactory()

Sets an optional PSR-17 UriFactoryInterface


    public
        final            setUriFactory(UriFactoryInterface $uriFactory) : static

Parameters

$uriFactory : UriFactoryInterface

Return values

static

storeAccessToken()

Sets an access token in the current OAuthStorageInterface (shorthand/convenience)


    public
                    storeAccessToken(AccessToken $token) : static

Parameters

$token : AccessToken

Return values

static

cleanBodyParams()

Cleans an array of body parameters


    protected
                    cleanBodyParams(iterable<string|int, mixed> $params) : array<string|int, mixed>

Parameters

$params : iterable<string|int, mixed>

Return values

array<string|int, mixed>

cleanQueryParams()

Cleans an array of query parameters


    protected
                    cleanQueryParams(iterable<string|int, mixed> $params) : array<string|int, mixed>

Parameters

$params : iterable<string|int, mixed>

Return values

array<string|int, mixed>

construct()

A replacement constructor that you can call in extended classes, so that you don't have to implement the monstrous original `__construct()`


    protected
                    construct() : void

createAccessToken()

Creates an access token with the provider set to $this->serviceName


    protected
                    createAccessToken() : AccessToken

Return values

AccessToken

getRequestBody()

Prepares the request body


    protected
                    getRequestBody(StreamInterface|array<string|int, mixed>|string $body, RequestInterface $request) : StreamInterface

Parameters

$body : StreamInterface|array<string|int, mixed>|string
$request : RequestInterface

Return values

StreamInterface

getRequestHeaders()

Prepare request headers


    protected
                    getRequestHeaders([array<string|int, mixed>|null $headers = null ]) : array<string|int, mixed>

Parameters

$headers : array<string|int, mixed>|null = null

Return values

array<string|int, mixed>

getRequestTarget()

Determine the request target from the given URI (path segment or URL) with respect to $apiURL, anything except host and path will be ignored, scheme will always be set to "https".


    protected
                    getRequestTarget(string $uri) : string

Throws if the host of a given URL does not match the host of $apiURL.

Parameters

$uri : string

Return values

string

getRequestTokenRequestParams()

prepares the parameters for the request token request header


    protected
                    getRequestTokenRequestParams() : array<string|int, mixed>

Return values

array<string|int, mixed>

getRequestURL()

Prepares the request URL


    protected
                    getRequestURL(string $path[, array<string|int, mixed>|null $params = null ]) : string

Parameters

$path : string
$params : array<string|int, mixed>|null = null

Return values

string

getSignature()

Generates a request signature


    protected
                    getSignature(UriInterface|string $url, array<string|int, mixed> $params, string $method[, string|null $accessTokenSecret = null ]) : string

Parameters

$url : UriInterface|string
$params : array<string|int, mixed>
$method : string
$accessTokenSecret : string|null = null

Return values

string

nonce()

returns a 32 byte random string (in hexadecimal representation) for use as a nonce


    protected
                    nonce([int $bytes = 32 ]) : string

Parameters

$bytes : int = 32

Return values

string

parseTokenResponse()

Parses the response from a request to the token endpoint


    protected
                    parseTokenResponse(ResponseInterface $response[, bool $confirmCallback = false ]) : AccessToken

Note: "oauth_callback_confirmed" is only sent in request token response

Parameters

$response : ResponseInterface
$confirmCallback : bool = false

Return values

AccessToken

sendAccessTokenRequest()

Sends the access token request


    protected
                    sendAccessTokenRequest(string $verifier) : ResponseInterface

Parameters

$verifier : string

Return values

ResponseInterface

sendRequestTokenRequest()

Sends a request to the request token endpoint


    protected
                    sendRequestTokenRequest(string $url) : ResponseInterface

Parameters

$url : string

Return values

ResponseInterface

OpenCaching extends OAuth1Provider in package Application

Tags

Table of Contents

Constants

Properties

Methods

Constants

MAGIC_PROPERTIES

USER_FIELDS

Properties

$accessTokenURL

$apiDocs

$apiURL

$applicationURL

$authURL

$http

$logger

$options

$requestFactory

$requestTokenURL

$revokeURL

Tags

$serviceName

$storage

$streamFactory

$uriFactory

$userRevokeURL

Methods

__construct()

Parameters

__get()

Parameters

Return values

getAccessToken()

Parameters

Tags

Return values

getAccessTokenFromStorage()

Tags

Return values

getAuthURL()

Parameters

Tags

Return values

getRequestAuthorization()

Parameters

Tags

Return values

getStorage()

Tags

Return values

InvalidateAccessToken()

Parameters

Tags

Return values

me()

Tags

Return values

request()

Parameters

Tags

Return values

sendRequest()

Parameters

Tags

Return values

setLogger()

Parameters

Tags

Return values

setRequestFactory()

Parameters

Tags

Return values

setStorage()

Parameters

Tags

Return values

setStreamFactory()

Parameters

OpenCaching extends OAuth1Provider
in package

Application