[ Index ]

PHP Cross Reference of phpBB-3.2.11-deutsch

title

Body

[close]

/vendor/lusitanian/oauth/src/OAuth/Common/Service/ -> ServiceInterface.php (summary)

(no description)

File Size: 49 lines (2 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ServiceInterface:: (4 methods):
  request()
  getAuthorizationUri()
  getAuthorizationEndpoint()
  getAccessTokenEndpoint()


Interface: ServiceInterface  - X-Ref

Defines methods common among all OAuth services.

request($path, $method = 'GET', $body = null, array $extraHeaders = array()   X-Ref
Sends an authenticated API request to the path provided.
If the path provided is not an absolute URI, the base API Uri (service-specific) will be used.

param: string|UriInterface $path
param: string              $method       HTTP method
param: array               $body         Request body if applicable (an associative array will
param: array               $extraHeaders Extra headers if applicable. These will override service-specific
return: string

getAuthorizationUri(array $additionalParameters = array()   X-Ref
Returns the url to redirect to for authorization purposes.

param: array $additionalParameters
return: UriInterface

getAuthorizationEndpoint()   X-Ref
Returns the authorization API endpoint.

return: UriInterface

getAccessTokenEndpoint()   X-Ref
Returns the access token API endpoint.

return: UriInterface



Generated: Wed Nov 11 20:33:01 2020 Cross-referenced by PHPXref 0.7.1