Référence de la classe JMediawiki

Liste de tous les membres

Fonctions membres publiques
	__construct (JRegistry $options=null, JMediawikiHttp $client=null)
	__get ($name)
	getOption ($key)
	setOption ($key, $value)

Attributs protégés
	$options
	$client
	$sites
	$pages
	$users
	$links
	$categories
	$images
	$search

---

Description détaillée

Définition à la ligne 27 du fichier mediawiki.php.

---

Documentation des constructeurs et destructeur

JMediawiki::__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 91 du fichier mediawiki.php.

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

---

Documentation des fonctions membres

JMediawiki::__get

(

$name

)

Magic method to lazily create API objects

Paramètres:

string

$name

Name of property to retrieve

Renvoie:

JMediaWikiObject MediaWiki API object (users, reviews, etc).

Depuis:

12.3

Exceptions:

InvalidArgumentException

Définition à la ligne 107 du fichier mediawiki.php.

        {
                $name = strtolower($name);
                $class = 'JMediawiki' . ucfirst($name);
                $accessible = array(
                        'categories',
                        'images',
                        'links',
                        'pages',
                        'search',
                        'sites',
                        'users'
                );

                if (class_exists($class) && in_array($name, $accessible))
                {
                        if (!isset($this->$name))
                        {
                                $this->$name = new $class($this->options, $this->client);
                        }

                        return $this->$name;
                }

                throw new InvalidArgumentException(sprintf('Property %s is not accessible.', $name));
        }

JMediawiki::getOption

(

$key

)

Get an option from the JMediawiki instance.

Paramètres:

string

$key

The name of the option to get.

Renvoie:

mixed The option value.

Depuis:

12.3

Définition à la ligne 143 du fichier mediawiki.php.

        {
                return $this->options->get($key);
        }

JMediawiki::setOption	(		$key,
			$value
	)

Set an option for the JMediawiki instance.

Paramètres:

string	$key	The name of the option to set.
mixed	$value	The option value to set.

Renvoie:

JMediawiki This object for method chaining.

Depuis:

12.3

Définition à la ligne 158 du fichier mediawiki.php.

        {
                $this->options->set($key, $value);

                return $this;
        }

---

Documentation des données membres

JMediawiki::$categories

protected

Définition à la ligne 69 du fichier mediawiki.php.

JMediawiki::$client

protected

Définition à la ligne 39 du fichier mediawiki.php.

JMediawiki::$images

protected

Définition à la ligne 75 du fichier mediawiki.php.

JMediawiki::$links

protected

Définition à la ligne 63 du fichier mediawiki.php.

JMediawiki::$options

protected

Définition à la ligne 33 du fichier mediawiki.php.

JMediawiki::$pages

protected

Définition à la ligne 51 du fichier mediawiki.php.

JMediawiki::$search

protected

Définition à la ligne 81 du fichier mediawiki.php.

JMediawiki::$sites

protected

Définition à la ligne 45 du fichier mediawiki.php.

JMediawiki::$users

protected

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

---

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

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