JOpenstreetmapUser
Extends \JOpenstreetmapObjectOpenstreetmap API User class for the Joomla Platform
| since |
3.2.0 |
|---|---|
| deprecated |
4.0 Use the |
| package |
Joomla.Platform |
Methods
__construct
Constructor
__construct(\Joomla\Registry\Registry &$options = null, \JHttp $client = null, \JOpenstreetmapOauth $oauth = null)
| since |
3.2.0 |
|---|
Arguments
- $options
- $client
\JHttpThe HTTP client object.- $oauth
\JOpenstreetmapOauthOpenstreetmap oauth client
changePreference
Method to change user preferences
changePreference(string $key, string $preference) : array
| since |
3.2.0 |
|---|
Arguments
- $key
stringKey of the preference- $preference
stringNew value for preference
Response
arrayThe XML response
getDetails
Method to get user details
getDetails() : array
| since |
3.2.0 |
|---|
Response
arrayThe XML response
getOption
Get an option from the JOpenstreetmapObject instance.
getOption(string $key) : mixed
| since |
3.2.0 |
|---|
Arguments
- $key
stringThe name of the option to get.
Response
mixedThe option value.
getPreferences
Method to get preferences
getPreferences() : array
| since |
3.2.0 |
|---|
Response
arrayThe XML response
replacePreferences
Method to replace user preferences
replacePreferences(array $preferences) : array
| since |
3.2.0 |
|---|
Arguments
- $preferences
arrayArray of new preferences
Response
arrayThe XML response
sendRequest
Method to send the request which does not require authentication.
sendRequest(string $path, string $method = 'GET', array $headers = array(), mixed $data = '') : \SimpleXMLElement
| since |
3.2.0 |
|---|---|
| throws |
|
Arguments
- $path
stringThe path of the request to make- $method
stringThe request method.- $headers
arrayThe headers passed in the request.- $data
mixedEither an associative array or a string to be sent with the post request.
Response
\SimpleXMLElementThe XML response
setOption
Set an option for the JOpenstreetmapObject instance.
setOption(string $key, mixed $value) : \JOpenstreetmapObject
| since |
3.2.0 |
|---|
Arguments
- $key
stringThe name of the option to set.- $value
mixedThe option value to set.
Response
\JOpenstreetmapObjectThis object for method chaining.
Properties
options
Options for the Openstreetmap object.
client
The HTTP client object to use in sending HTTP requests.
| since |
3.2.0 |
|---|
Type(s)
\JHttp