Référence de la classe JMediawikiSearch

Graphe d'héritage de JMediawikiSearch:

Graphe de collaboration de JMediawikiSearch:

Liste de tous les membres

Fonctions membres publiques
	search ($srsearch, array $srnamespace=null, $srwhat=null, array $srinfo=null, array $srprop=null, $srredirects=null, $sroffest=null, $srlimit=null)
	openSearch ($search, $limit=null, array $namespace=null, $suggest=null, $format=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 search.php.

---

Documentation des fonctions membres

JMediawikiSearch::openSearch	(		$search,
			$limit = null,
		array	$namespace = null,
			$suggest = null,
			$format = null
	)

Method to search the wiki using opensearch protocol.

Paramètres:

string	$search	Search string.
integer	$limit	Maximum amount of results to return.
array	$namespace	Namespaces to search.
string	$suggest	Do nothing if $wgEnableOpenSearchSuggest is false.
string	$format	Output format.

Renvoie:

object

Depuis:

12.3

Définition à la ligne 103 du fichier search.php.

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

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

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

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

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

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

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

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

JMediawikiSearch::search	(		$srsearch,
		array	$srnamespace = null,
			$srwhat = null,
		array	$srinfo = null,
		array	$srprop = null,
			$srredirects = null,
			$sroffest = null,
			$srlimit = null
	)

Method to perform a full text search.

Paramètres:

string	$srsearch	Search for all page titles (or content) that has this value.
array	$srnamespace	The namespace(s) to enumerate.
string	$srwhat	Search inside the text or titles.
array	$srinfo	What metadata to return.
array	$srprop	What properties to return.
boolean	$srredirects	Include redirect pages in the search.
integer	$sroffest	Use this value to continue paging.
integer	$srlimit	How many total pages to return.

Renvoie:

object

Depuis:

12.3

Définition à la ligne 38 du fichier search.php.

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

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

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

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

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

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

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

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

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

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