JOpenstreetmapOauth
Extends \JOAuth1ClientJoomla Platform class for generating Openstreetmap API access token.
since |
3.2.0 |
---|---|
deprecated |
4.0 Use the |
package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JHttp $client = null, \JInput $input = null, \JApplicationWeb $application = null, string $version = null)
since |
3.2.0 |
---|
Arguments
- $options
\Joomla\Registry\Registry
OAuth1Client options object.- $client
\JHttp
The HTTP client object.- $input
\JInput
The input object- $application
\JApplicationWeb
The application object- $version
string
Specify the OAuth version. By default we are using 1.0a.
_authorise
Method used to authorise the application.
_authorise() : void
since |
3.2.0 |
---|
_baseString
Prepare the signature base string.
_baseString(string $url, string $method, array $parameters) : string
since |
3.2.0 |
---|
Arguments
- $url
string
The URL to sign.- $method
string
The request method.- $parameters
array
Array containing request parameters.
Response
string
The base string.
_createHeader
Method used to create the header for the POST request.
_createHeader(array $parameters) : string
since |
3.2.0 |
---|
Arguments
- $parameters
array
Array containing request parameters.
Response
string
The header.
_generateAccessToken
Method used to get an access token.
_generateAccessToken() : void
since |
3.2.0 |
---|
_generateRequestToken
Method used to get a request token.
_generateRequestToken() : void
since |
3.2.0 |
---|---|
throws |
|
_prepareSigningKey
Prepares the OAuth signing key.
_prepareSigningKey() : string
since |
3.2.0 |
---|
Response
string
The prepared signing key.
_signRequest
Method used to sign requests.
_signRequest(string $url, string $method, array $parameters) : array
since |
3.2.0 |
---|
Arguments
- $url
string
The URL to sign.- $method
string
The request method.- $parameters
array
Array containing request parameters.
Response
array
authenticate
Method to for the oauth flow.
authenticate() : array
since |
3.2.0 |
---|---|
throws |
|
Response
array
Contains access token key, secret and verifier.
generateNonce
Method used to generate the current nonce.
generateNonce() : string
since |
3.2.0 |
---|
Response
string
The current nonce.
getOption
Get an option from the JOauth1aClient instance.
getOption(string $key) : mixed
since |
3.2.0 |
---|
Arguments
- $key
string
The name of the option to get
Response
mixed
The option value
getToken
Get the oauth token key or secret.
getToken() : array
since |
3.2.0 |
---|
Response
array
The oauth token key and secret.
oauthRequest
Method used to make an OAuth request.
oauthRequest(string $url, string $method, array $parameters, mixed $data = array(), array $headers = array()) : \JHttpResponse
since |
3.2.0 |
---|---|
throws |
|
Arguments
- $url
string
The request URL.- $method
string
The request method.- $parameters
array
Array containing request parameters.- $data
mixed
The POST request data.- $headers
array
An array of name-value pairs to include in the header of the request
Response
\JHttpResponse
safeEncode
Encodes the string or array passed in a way compatible with OAuth.
safeEncode(mixed $data) : string
If an array is passed each array value will will be encoded.
since |
3.2.0 |
---|
Arguments
- $data
mixed
The scalar or array to encode.
Response
string
$data encoded in a way compatible with OAuth.
setOption
Set an option for the JOauth1aClient instance.
setOption(string $key, mixed $value) : \JOAuth1Client
since |
3.2.0 |
---|
Arguments
- $key
string
The name of the option to set- $value
mixed
The option value to set
Response
\JOAuth1Client
This object for method chaining
setToken
Set the oauth token.
setToken(array $token) : \JOAuth1Client
since |
3.2.0 |
---|
Arguments
- $token
array
The access token key and secret.
Response
\JOAuth1Client
This object for method chaining.
toUrl
Method to create the URL formed string with the parameters.
toUrl(string $url, array $parameters) : string
since |
3.2.0 |
---|
Arguments
- $url
string
The request URL.- $parameters
array
Array containing request parameters.
Response
string
The formed URL.
validateResponse
Method to validate a response.
validateResponse(string $url, \JHttpResponse $response) : void
since |
3.2.0 |
---|---|
throws |
|
Arguments
- $url
string
The request URL.- $response
\JHttpResponse
The response to validate.
verifyCredentials
Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not.
verifyCredentials() : array
since |
3.2.0 |
---|
Response
array
The decoded JSON response
Properties
options
Options for the JOAuth1Client object.
token
Contains access token key, secret and verifier.
since |
3.2.0 |
---|
Type(s)
array
client
The HTTP client object to use in sending HTTP requests.
since |
3.2.0 |
---|
Type(s)
\JHttp
input
The input object to use in retrieving GET/POST data.
since |
3.2.0 |
---|
Type(s)
\JInput
application
The application object to send HTTP headers for redirects.
since |
3.2.0 |
---|
Type(s)
\JApplicationWeb
version
Selects which version of OAuth to use: 1.0 or 1.0a.
since |
3.2.0 |
---|
Type(s)
string