Référence de la classe JMediawikiObject

Graphe d'héritage de JMediawikiObject:

Liste de tous les membres

Fonctions membres publiques
	__construct (JRegistry $options=null, JMediawikiHttp $client=null)
	buildParameter (array $params)
	validateResponse ($response)

Fonctions membres protégées
	fetchUrl ($path)

Attributs protégés
	$options
	$client

---

Description détaillée

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

---

Documentation des constructeurs et destructeur

JMediawikiObject::__construct	(	JRegistry	$options = null,
		JMediawikiHttp	$client = null
	)

Constructor.

Paramètres:

JRegistry	$options	Mediawiki options object.
JMediawikiHttp	$client	The HTTP client object.

Depuis:

12.3

Définition à la ligne 42 du fichier object.php.

        {
                $this->options = isset($options) ? $options : new JRegistry;
                $this->client = isset($client) ? $client : new JMediawikiHttp($this->options);
        }

---

Documentation des fonctions membres

JMediawikiObject::buildParameter

(

array

$params

)

Method to build request parameters from a string array.

Paramètres:

array

$params

string array that contains the parameters

Renvoie:

string request parameter

Depuis:

12.3

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

        {
                $path = '';

                foreach ($params as $param)
                {
                        $path .= $param;

                        if (next($params) == true)
                        {
                                $path .= '|';
                        }
                }

                return $path;
        }

JMediawikiObject::fetchUrl (   $path )

protected

Method to build and return a full request URL for the request.

Paramètres:

string

$path

URL to inflect

Renvoie:

string The request URL.

Depuis:

12.3

Définition à la ligne 57 du fichier object.php.

Références JUri\setUser().

        {
                // Append the path with output format
                $path .= '&format=xml';

                $uri = new JUri($this->options->get('api.url') . '/api.php' . $path);

                if ($this->options->get('api.username', false))
                {
                        $uri->setUser($this->options->get('api.username'));
                }

                if ($this->options->get('api.password', false))
                {
                        $uri->setPass($this->options->get('api.password'));
                }

                return (string) $uri;
        }

Voici le graphe d'appel pour cette fonction :

JMediawikiObject::validateResponse

(

$response

)

Method to validate response for errors

Paramètres:

JHttpresponse

$response

reponse from the mediawiki server

Renvoie:

Object

Depuis:

12.3

Définition à la ligne 112 du fichier object.php.

        {
                $xml = simplexml_load_string($response->body);

                if (isset($xml->warnings))
                {
                        throw new DomainException($xml->warnings->info);
                }

                if (isset($xml->error))
                {
                        throw new DomainException($xml->error['info']);
                }

                return $xml;
        }

---

Documentation des données membres

JMediawikiObject::$client

protected

Définition à la ligne 32 du fichier object.php.

JMediawikiObject::$options

protected

Définition à la ligne 26 du fichier object.php.

---

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

• jplatform-13.1/joomla/mediawiki/object.php