Référence de la classe JMediawikiSites

Graphe d'héritage de JMediawikiSites:

Graphe de collaboration de JMediawikiSites:

Liste de tous les membres

Fonctions membres publiques
	getSiteInfo (array $siprop=null, $sifilteriw=null, $sishowalldb=false, $sinumberingroup=false, array $siinlanguagecode=null)
	getEvents (array $leprop=null, $letype=null, $leaction=null, $letitle=null, $leprefix=null, $letag=null, $leuser=null, $lestart=null, $leend=null, $ledir=null, $lelimit=null)
	getRecentChanges ($rcstart=null, $rcend=null, $rcdir=null, array $rcnamespace=null, $rcuser=null, $rcexcludeuser=null, $rctag=null, array $rcprop=null, array $rctoken=null, array $rcshow=null, $rclimit=null, $rctype=null, $rctoponly=null)
	getProtectedTitles (array $ptnamespace=null, array $ptlevel=null, $ptlimit=null, $ptdir=null, $ptstart=null, $ptend=null, array $ptprop=null)
Fonctions membres publiques inherited from JMediawikiObject
	__construct (JRegistry $options=null, JMediawikiHttp $client=null)
	buildParameter (array $params)
	validateResponse ($response)

Additional Inherited Members
Fonctions membres protégées inherited from JMediawikiObject
	fetchUrl ($path)
Attributs protégés inherited from JMediawikiObject
	$options
	$client

---

Description détaillée

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

---

Documentation des fonctions membres

JMediawikiSites::getEvents	(	array	$leprop = null,
			$letype = null,
			$leaction = null,
			$letitle = null,
			$leprefix = null,
			$letag = null,
			$leuser = null,
			$lestart = null,
			$leend = null,
			$ledir = null,
			$lelimit = null
	)

Method to get events from logs.

Paramètres:

array	$leprop	List of properties to get.
string	$letype	Filter log actions to only this type.
string	$leaction	Filter log actions to only this type.
string	$letitle	Filter entries to those related to a page.
string	$leprefix	Filter entries that start with this prefix.
string	$letag	Filter entries with tag.
string	$leuser	Filter entries made by the given user.
string	$lestart	Starting timestamp.
string	$leend	Ending timestamp.
string	$ledir	Direction of enumeration.
integer	$lelimit	Event limit to return.

Renvoie:

object

Depuis:

12.3

Définition à la ligne 89 du fichier sites.php.

        {
                // Build the request
                $path = '?action=query&list=logevents';

                if (isset($leprop))
                {
                        $path .= '&leprop=' . $this->buildParameter($leprop);
                }

                if (isset($letype))
                {
                        $path .= '&letype=' . $letype;
                }

                if (isset($leaction))
                {
                        $path .= '&leaction=' . $leaction;
                }

                if (isset($letitle))
                {
                        $path .= '&letitle=' . $letitle;
                }

                if (isset($leprefix))
                {
                        $path .= '&leprefix=' . $leprefix;
                }

                if (isset($letag))
                {
                        $path .= '&letag=' . $letag;
                }

                if (isset($leuser))
                {
                        $path .= '&leuser=' . $leuser;
                }

                if (isset($lestart))
                {
                        $path .= '&lestart=' . $lestart;
                }

                if (isset($leend))
                {
                        $path .= '&leend=' . $leend;
                }

                if (isset($ledir))
                {
                        $path .= '&ledir=' . $ledir;
                }

                if (isset($lelimit))
                {
                        $path .= '&lelimit=' . $lelimit;
                }

                // Send the request.
                $response = $this->client->get($this->fetchUrl($path));

                return $this->validateResponse($response);
        }

JMediawikiSites::getProtectedTitles	(	array	$ptnamespace = null,
		array	$ptlevel = null,
			$ptlimit = null,
			$ptdir = null,
			$ptstart = null,
			$ptend = null,
		array	$ptprop = null
	)

Method to get protected titles on a site.

Paramètres:

array	$ptnamespace	Only list titles in this namespace.
array	$ptlevel	Only list titles with these protection level.
integer	$ptlimit	Limit of pages to return.
string	$ptdir	Direction of enumeration.
string	$ptstart	Starting timestamp.
string	$ptend	Ending timestamp.
array	$ptprop	List of properties to get.

Renvoie:

object

Depuis:

12.3

Définition à la ligne 269 du fichier sites.php.

        {
                // Build the request.
                $path = '?action=query&list=protectedtitles';

                if (isset($ptnamespace))
                {
                        $path .= '&ptnamespace=' . $this->buildParameter($ptnamespace);
                }

                if (isset($ptlevel))
                {
                        $path .= '&ptlevel=' . $this->buildParameter($ptlevel);
                }

                if (isset($ptlimit))
                {
                        $path .= '&ptlimit=' . $ptlimit;
                }

                if (isset($ptdir))
                {
                        $path .= '&ptdir=' . $ptdir;
                }

                if (isset($ptstart))
                {
                        $path .= '&ptstart=' . $ptstart;
                }

                if (isset($ptend))
                {
                        $path .= '&ptend=' . $ptend;
                }

                if (isset($ptprop))
                {
                        $path .= '&ptprop=' . $this->buildParameter($ptprop);
                }

                // Send the request.
                $response = $this->client->get($this->fetchUrl($path));

                return $this->validateResponse($response);
        }

JMediawikiSites::getRecentChanges	(		$rcstart = null,
			$rcend = null,
			$rcdir = null,
		array	$rcnamespace = null,
			$rcuser = null,
			$rcexcludeuser = null,
			$rctag = null,
		array	$rcprop = null,
		array	$rctoken = null,
		array	$rcshow = null,
			$rclimit = null,
			$rctype = null,
			$rctoponly = null
	)

Method to get recent changes on a site.

Paramètres:

string	$rcstart	Starting timestamp.
string	$rcend	Ending timestamp.
string	$rcdir	Direction of enumeration.
array	$rcnamespace	Filter changes to only this namespace(s).
string	$rcuser	Filter changes by this user.
string	$rcexcludeuser	Filter changes to exclude changes by this user.
string	$rctag	Filter changes by this tag.
array	$rcprop	Filter log actions to only this type.
array	$rctoken	Which token to obtain for each change.
array	$rcshow	Filter changes by this criteria.
string	$rclimit	Changes limit to return.
string	$rctype	Filter event by type of changes.
string	$rctoponly	Filter changes which are latest revision.

Renvoie:

object

Depuis:

12.3

Définition à la ligne 177 du fichier sites.php.

        {
                // Build the request.
                $path = '?action=query&list=recentchanges';

                if (isset($rcstart))
                {
                        $path .= '&rcstart=' . $rcstart;
                }

                if (isset($rcend))
                {
                        $path .= '&rcend=' . $rcend;
                }

                if (isset($rcdir))
                {
                        $path .= '&rcdir=' . $rcdir;
                }

                if (isset($rcnamespace))
                {
                        $path .= '&rcnamespaces=' . $this->buildParameter($rcnamespace);
                }

                if (isset($rcuser))
                {
                        $path .= '&rcuser=' . $rcuser;
                }

                if (isset($rcexcludeuser))
                {
                        $path .= '&rcexcludeuser=' . $rcexcludeuser;
                }

                if (isset($rctag))
                {
                        $path .= '&rctag=' . $rctag;
                }

                if (isset($rcprop))
                {
                        $path .= '&rcprop=' . $this->buildParameter($rcprop);
                }

                if (isset($rctoken))
                {
                        $path .= '&rctoken=' . $this->buildParameter($rctoken);
                }

                if (isset($rcshow))
                {
                        $path .= '&rcshow=' . $this->buildParameter($rcshow);
                }

                if (isset($rclimit))
                {
                        $path .= '&rclimit=' . $rclimit;
                }

                if (isset($rctype))
                {
                        $path .= '&rctype=' . $rctype;
                }

                if (isset($rctoponly))
                {
                        $path .= '&rctoponly=' . $rctoponly;
                }

                // Send the request.
                $response = $this->client->get($this->fetchUrl($path));

                return $this->validateResponse($response);
        }

JMediawikiSites::getSiteInfo	(	array	$siprop = null,
			$sifilteriw = null,
			$sishowalldb = false,
			$sinumberingroup = false,
		array	$siinlanguagecode = null
	)

Method to get site information.

Paramètres:

array	$siprop	The sysinfo properties to get.
string	$sifilteriw	Only local or only non local entries to return.
boolean	$sishowalldb	List all database servers.
boolean	$sinumberingroup	List the number of users in usergroups.
array	$siinlanguagecode	Language code for localized languages.

Renvoie:

object

Depuis:

12.3

Définition à la ligne 34 du fichier sites.php.

        {
                // Build the request.
                $path = '?action=query&meta=siteinfo';

                if (isset($siprop))
                {
                        $path .= '&siprop=' . $this->buildParameter($siprop);
                }

                if (isset($sifilteriw))
                {
                        $path .= '&sifilteriw=' . $sifilteriw;
                }

                if ($sishowalldb)
                {
                        $path .= '&sishowalldb=';
                }

                if ($sinumberingroup)
                {
                        $path .= '&sinumberingroup=';
                }

                if (isset($siinlanguagecode))
                {
                        $path .= '&siinlanguagecode=' . $this->buildParameter($siinlanguagecode);
                }

                // Send the request.
                $response = $this->client->get($this->fetchUrl($path));

                return $this->validateResponse($response);
        }

---

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

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