Joomla Platform class for generating Openstreetmap API access token.

• since: 13.1

Located in /libraries/joomla/openstreetmap/oauth.php (line 19)

JOAuth1Client
   |
   --JOpenstreetmapOauth

JRegistry $options (line 27)

Options for the JOpenstreetmapOauth object.

• since: 13.1
• access: protected

---

Redefinition of:

JOAuth1Client::$options

Inherited Variables

Inherited from JOAuth1Client

JOAuth1Client::$application
JOAuth1Client::$client
JOAuth1Client::$input
JOAuth1Client::$token
JOAuth1Client::$version

Constructor __construct (line 38)

Constructor.

• since: 13.1
• access: public

JOpenstreetmapOauth __construct ([JRegistry $options = null], [JHttp $client = null], [JInput $input = null])

• JRegistry $options: JOpenstreetmapOauth options object.
• JHttp $client: The HTTP client object.
• JInput $input: The input object

---

Redefinition of:

JOAuth1Client::__construct()

Constructor.

validateResponse (line 79)

Method to validate a response.

• since: 13.1
• throws: DomainException
• access: public

void validateResponse (string $url, JHttpResponse $response)

• string $url: The request URL.
• JHttpResponse $response: The response to validate.

---

Redefinition of:

JOAuth1Client::validateResponse()

Method to validate a response.

verifyCredentials (line 63)

Method to verify if the access token is valid by making a request to an API endpoint.

• return: Returns true if the access token is valid and false otherwise.
• since: 13.1
• access: public

boolean verifyCredentials ()

---

Redefinition of:

JOAuth1Client::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.

Inherited Methods

Inherited From JOAuth1Client

JOAuth1Client::__construct()
JOAuth1Client::authenticate()
JOAuth1Client::generateNonce()
JOAuth1Client::getOption()
JOAuth1Client::getToken()
JOAuth1Client::oauthRequest()
JOAuth1Client::safeEncode()
JOAuth1Client::setOption()
JOAuth1Client::setToken()
JOAuth1Client::toUrl()
JOAuth1Client::validateResponse()
JOAuth1Client::verifyCredentials()