oauth.php
2.46 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
<?php
/**
* @package Joomla.Platform
* @subpackage Openstreetmap
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
use Joomla\Registry\Registry;
/**
* Joomla Platform class for generating Openstreetmap API access token.
*
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/openstreetmap` package via Composer instead
*/
class JOpenstreetmapOauth extends JOAuth1Client
{
/**
* Options for the JOpenstreetmapOauth object.
*
* @var Registry
* @since 3.2.0
*/
protected $options;
/**
* Constructor.
*
* @param Registry $options JOpenstreetmapOauth options object.
* @param JHttp $client The HTTP client object.
* @param JInput $input The input object
*
* @since 3.2.0
*/
public function __construct(Registry $options = null, JHttp $client = null, JInput $input = null)
{
$this->options = isset($options) ? $options : new Registry;
$this->options->def('accessTokenURL', 'https://www.openstreetmap.org/oauth/access_token');
$this->options->def('authoriseURL', 'https://www.openstreetmap.org/oauth/authorize');
$this->options->def('requestTokenURL', 'https://www.openstreetmap.org/oauth/request_token');
/*
$this->options->def('accessTokenURL', 'https://api06.dev.openstreetmap.org/oauth/access_token');
$this->options->def('authoriseURL', 'https://api06.dev.openstreetmap.org/oauth/authorize');
$this->options->def('requestTokenURL', 'https://api06.dev.openstreetmap.org/oauth/request_token');
*/
// Call the JOauth1Client constructor to setup the object.
parent::__construct($this->options, $client, $input, null, '1.0');
}
/**
* Method to verify if the access token is valid by making a request to an API endpoint.
*
* @return boolean Returns true if the access token is valid and false otherwise.
*
* @since 3.2.0
*/
public function verifyCredentials()
{
return true;
}
/**
* Method to validate a response.
*
* @param string $url The request URL.
* @param JHttpResponse $response The response to validate.
*
* @return void
*
* @since 3.2.0
* @throws DomainException
*/
public function validateResponse($url, $response)
{
if ($response->code != 200)
{
$error = htmlspecialchars($response->body, ENT_COMPAT, 'UTF-8');
throw new DomainException($error, $response->code);
}
}
}