Référence de la classe JMediawikiCategories

Graphe d'héritage de JMediawikiCategories:

Graphe de collaboration de JMediawikiCategories:

Liste de tous les membres

Fonctions membres publiques
	getCategories (array $titles, array $clprop=null, array $clshow=null, $cllimit=null, $clcontinue=false, array $clcategories=null, $cldir=null)
	getCategoriesUsed (array $titles)
	getCategoriesInfo (array $titles, $clcontinue=false)
	enumerateCategories ($acfrom=null, $acto=null, $acprefix=null, $acdir=null, $acmin=null, $acmax=null, $aclimit=null, array $acprop=null)
	getChangeTags (array $tgprop=null, $tglimit=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 categories.php.

---

Documentation des fonctions membres

JMediawikiCategories::enumerateCategories	(		$acfrom = null,
			$acto = null,
			$acprefix = null,
			$acdir = null,
			$acmin = null,
			$acmax = null,
			$aclimit = null,
		array	$acprop = null
	)

Method to enumerate all categories.

Paramètres:

string	$acfrom	The category to start enumerating from.
string	$acto	The category to stop enumerating at.
string	$acprefix	Search for all category titles that begin with this value.
string	$acdir	Direction to sort in.
integer	$acmin	Minimum number of category members.
integer	$acmax	Maximum number of category members.
integer	$aclimit	How many categories to return.
array	$acprop	Which properties to get.

Renvoie:

object

Depuis:

12.3

Définition à la ligne 149 du fichier categories.php.

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

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

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

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

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

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

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

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

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

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

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

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

JMediawikiCategories::getCategories	(	array	$titles,
		array	$clprop = null,
		array	$clshow = null,
			$cllimit = null,
			$clcontinue = false,
		array	$clcategories = null,
			$cldir = null
	)

Method to list all categories the page(s) belong to.

Paramètres:

array	$titles	Page titles to retrieve categories.
array	$clprop	List of additional properties to get.
array	$clshow	Type of categories to show.
integer	$cllimit	Number of categories to return.
boolean	$clcontinue	Continue when more results are available.
array	$clcategories	Only list these categories.
string	$cldir	Direction of listing.

Renvoie:

object

Depuis:

12.1

Définition à la ligne 36 du fichier categories.php.

        {
                // Build the request.
                $path = '?action=query&prop=categories';

                // Append titles to the request.
                $path .= '&titles=' . $this->buildParameter($titles);

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

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

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

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

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

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

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

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

JMediawikiCategories::getCategoriesInfo	(	array	$titles,
			$clcontinue = false
	)

Method to get information about the given categories.

Paramètres:

array	$titles	Page titles to retrieve categories.
boolean	$clcontinue	Continue when more results are available.

Renvoie:

object

Depuis:

12.3

Définition à la ligne 114 du fichier categories.php.

        {
                // Build the request.
                $path = '?action=query&prop=categoryinfo';

                // Append titles to the request
                $path .= '&titles=' . $this->buildParameter($titles);

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

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

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

JMediawikiCategories::getCategoriesUsed

(

array

$titles

)

Method to get information about all categories used.

Paramètres:

array

$titles

Page titles to retrieve categories.

Renvoie:

object

Depuis:

12.3

Définition à la ligne 90 du fichier categories.php.

        {
                // Build the request
                $path = '?action=query&generator=categories&prop=info';

                // Append titles to the request
                $path .= '&titles=' . $this->buildParameter($titles);

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

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

JMediawikiCategories::getChangeTags	(	array	$tgprop = null,
			$tglimit = null
	)

Method to list change tags.

Paramètres:

array	$tgprop	List of properties to get.
string	$tglimit	The maximum number of tags to limit.

Renvoie:

object

Depuis:

12.3

Définition à la ligne 216 du fichier categories.php.

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

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

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

                // @TODO add support for $tgcontinue

                // 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/categories.php