Référence de la classe JOpenstreetmapUser

Graphe d'héritage de JOpenstreetmapUser:

Graphe de collaboration de JOpenstreetmapUser:

Liste de tous les membres

Fonctions membres publiques
	getDetails ()
	getPreferences ()
	replacePreferences ($preferences)
	changePreference ($key, $preference)
Fonctions membres publiques inherited from JOpenstreetmapObject
	__construct (JRegistry &$options=null, JHttp $client=null, JOpenstreetmapOauth $oauth=null)
	getOption ($key)
	setOption ($key, $value)
	sendRequest ($path, $method= 'GET', $headers=array(), $data= '')

Additional Inherited Members
Attributs protégés inherited from JOpenstreetmapObject
	$options
	$client
	$oauth

---

Description détaillée

Définition à la ligne 19 du fichier user.php.

---

Documentation des fonctions membres

JOpenstreetmapUser::changePreference	(		$key,
			$preference
	)

Method to change user preferences

Paramètres:

string	$key	Key of the preference
string	$preference	New value for preference

Renvoie:

array The XML response

Depuis:

13.1

Définition à la ligne 137 du fichier user.php.

        {
                $token = $this->oauth->getToken();

                // Set parameters.
                $parameters = array(
                        'oauth_token' => $token['key']
                );

                // Set the API base
                $base = 'user/preferences/' . $key;

                // Build the request path.
                $path = $this->getOption('api.url') . $base;

                // Send the request.
                $response = $this->oauth->oauthRequest($path, 'PUT', $parameters, $preference);

                return $response->body;
        }

JOpenstreetmapUser::getDetails

(

)

Method to get user details

Renvoie:

array The XML response

Depuis:

13.1

Définition à la ligne 28 du fichier user.php.

        {
                $token = $this->oauth->getToken();

                // Set parameters.
                $parameters = array(
                        'oauth_token' => $token['key']
                );

                // Set the API base
                $base = 'user/details';

                // Build the request path.
                $path = $this->getOption('api.url') . $base;

                // Send the request.
                $response = $this->oauth->oauthRequest($path, 'GET', $parameters);

                return $response->body;
        }

JOpenstreetmapUser::getPreferences

(

)

Method to get preferences

Renvoie:

array The XML response

Depuis:

13.1

Définition à la ligne 56 du fichier user.php.

        {
                $token = $this->oauth->getToken();

                // Set parameters.
                $parameters = array(
                        'oauth_token' => $token['key']
                );

                // Set the API base
                $base = 'user/preferences';

                // Build the request path.
                $path = $this->getOption('api.url') . $base;

                // Send the request.
                $response = $this->oauth->oauthRequest($path, 'GET', $parameters);

                return $response->body;
        }

JOpenstreetmapUser::replacePreferences

(

$preferences

)

Method to replace user preferences

Paramètres:

array

$preferences

Array of new preferences

Renvoie:

array The XML response

Depuis:

13.1

Définition à la ligne 86 du fichier user.php.

        {
                $token = $this->oauth->getToken();

                // Set parameters.
                $parameters = array(
                        'oauth_token' => $token['key']
                );

                // Set the API base
                $base = 'user/preferences';

                // Build the request path.
                $path = $this->getOption('api.url') . $base;

                // Create a list of preferences
                $preference_list = '';

                if (!empty($preferences))
                {
                        foreach ($preferences as $key => $value)
                        {
                                $preference_list .= '<preference k="' . $key . '" v="' . $value . '"/>';
                        }
                }

                $xml = '<?xml version="1.0" encoding="UTF-8"?>
                        <osm version="0.6" generator="JOpenstreetmap">
                                <preferences>'
                                . $preference_list .
                                '</preferences>
                        </osm>';

                $header['Content-Type'] = 'text/xml';

                // Send the request.
                $response = $this->oauth->oauthRequest($path, 'PUT', $parameters, $xml, $header);

                return $response->body;
        }

---

La documentation de cette classe a été générée à partir du fichier suivant :

• jplatform-13.1/joomla/openstreetmap/user.php