MediaWiki  master
opensearch_desc.php File Reference

The web entry point for generating an OpenSearch description document. More...

Go to the source code of this file.

Variables

 $expiryTime = 600
 
 $fullName = wfMessage( 'opensearch-desc' )->inContentLanguage()->text()
 
 $response = $wgRequest->response()
 
 $searchPage = SpecialPage::getTitleFor( 'Search' )
 
 $urls = []
 
 $urls []
 
if( $wgRequest->getVal( 'ctype')=='application/xml') else
 
const MW_ENTRY_POINT 'opensearch_desc'
 
const MW_NO_SESSION 1
 
 print
 

Detailed Description

The web entry point for generating an OpenSearch description document.

See http://www.opensearch.org/ for the specification of the OpenSearch "description" document. In a nut shell, this tells browsers how and where to submit submit search queries to get a search results page back, as well as how to get typeahead suggestions (see ApiOpenSearch).

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Definition in file opensearch_desc.php.

Variable Documentation

◆ $expiryTime

◆ $fullName

$fullName = wfMessage( 'opensearch-desc' )->inContentLanguage()->text()

◆ $response

$response = $wgRequest->response()

Definition at line 44 of file opensearch_desc.php.

Referenced by MediaWiki\Rest\ConditionalHeaderUtil\applyResponseHeaders(), ApiMain\checkMaxLag(), MediaWiki\Rest\Handler\checkPreconditions(), MediaWiki\Block\BlockManager\clearBlockCookie(), MediaWiki\Block\DatabaseBlock\clearCookie(), MediaWiki\Rest\ResponseFactory\createFromException(), MediaWiki\Rest\ResponseFactory\createFromReturnValue(), MediaWiki\Rest\ResponseFactory\createHttpError(), MediaWiki\Rest\ResponseFactory\createJson(), MediaWiki\Rest\ResponseFactory\createLegacyTemporaryRedirect(), MediaWiki\Rest\ResponseFactory\createNoContent(), MediaWiki\Rest\ResponseFactory\createNotModified(), MediaWiki\Rest\ResponseFactory\createPermanentRedirect(), MediaWiki\Rest\ResponseFactory\createRedirectBase(), MediaWiki\Rest\ResponseFactory\createSeeOther(), MediaWiki\Rest\ResponseFactory\createTemporaryRedirect(), SpecialUnlinkAccounts\execute(), SpecialLinkAccounts\execute(), SpecialChangeCredentials\execute(), MediaWiki\Rest\Handler\CompareHandler\execute(), RunJobs\execute(), MediaWiki\Rest\Handler\ActionModuleBasedHandler\execute(), GuzzleHttpRequest\execute(), MediaWiki\Rest\EntryPoint\execute(), LoginSignupSpecialPage\execute(), MediaWiki\Rest\Router\execute(), MediaWiki\Rest\Handler\SearchHandler\execute(), MediaWiki\Rest\Router\executeHandler(), EtcdConfig\fetchAllFromEtcd(), EtcdConfig\fetchAllFromEtcdServer(), ApiLogin\getAuthenticationResponseLogData(), ApiMain\handleCORS(), ApiMain\handleException(), SpecialUnlinkAccounts\handleFormSubmit(), SpecialChangeCredentials\handleFormSubmit(), AuthManagerSpecialPage\handleFormSubmit(), BotPassword\loginHook(), MediaWiki\Rest\Handler\CreationHandler\mapActionModuleResponse(), MediaWiki\Rest\Handler\EditHandler\mapActionModuleResponse(), MediaWiki\HookContainer\HookRunner\onAuthManagerLoginAuthenticateAudit(), RawAction\onView(), OutputPage\output(), MediaWiki\outputResponsePayload(), MediaWiki\Session\ImmutableSessionProviderWithCookie\persistSession(), MediaWiki\Session\CookieSessionProvider\persistSession(), MediaWiki\Auth\ThrottlePreAuthenticationProvider\postAuthentication(), MediaWiki\Rest\Handler\MediaLinksHandler\processDbResults(), MediaWiki\Rest\Handler\PageHistoryHandler\processDbResults(), ResourceLoader\respond(), MediaWiki\Rest\Handler\PageSourceHandler\run(), MediaWiki\Rest\Handler\MediaLinksHandler\run(), MediaWiki\Rest\Handler\MediaFileHandler\run(), MediaWiki\Rest\Handler\PageHistoryHandler\run(), MediaWiki\Rest\Handler\PageHTMLHandler\run(), MediaWiki\Rest\Handler\PageHistoryCountHandler\run(), JobRunner\run(), MediaWiki\Logger\Monolog\KafkaHandler\send(), OutputPage\sendCacheControl(), ApiMain\sendCacheHeaders(), MediaWiki\Block\BlockManager\setBlockCookie(), MediaWiki\Block\DatabaseBlock\setCookie(), MediaWiki\Session\CookieSessionProvider\setForceHTTPSCookie(), EditPage\setPostEditCookie(), SpecialUndelete\showFile(), MediaWiki\Block\BlockManager\trackBlockWithCookie(), ResourceLoader\tryRespondFromFileCache(), MediaWiki\Session\ImmutableSessionProviderWithCookie\unpersistSession(), MediaWiki\Session\CookieSessionProvider\unpersistSession(), and wfStreamThumb().

◆ $searchPage

$searchPage = SpecialPage::getTitleFor( 'Search' )

◆ $urls [1/2]

◆ $urls [2/2]

$urls[]
Initial value:
= [
'type' => 'text/html',
'method' => 'get',
'template' => $searchPage->getCanonicalURL( 'search={searchTerms}' ) ]

Definition at line 88 of file opensearch_desc.php.

◆ else

if ($wgRequest->getVal('ctype')=='application/xml') else
Initial value:
{
$ctype = 'application/opensearchdescription+xml'

Definition at line 40 of file opensearch_desc.php.

◆ MW_ENTRY_POINT

const MW_ENTRY_POINT 'opensearch_desc'

Definition at line 33 of file opensearch_desc.php.

◆ MW_NO_SESSION

const MW_NO_SESSION 1

Definition at line 31 of file opensearch_desc.php.

◆ print

$searchPage
$searchPage
Definition: opensearch_desc.php:87