escape HTML elements in docblock with double quotes

[lhc/web/wiklou.git] / includes / api / ApiOpenSearch.php

diff --git a/includes/api/ApiOpenSearch.php b/includes/api/ApiOpenSearch.php
index de919b4..5a78354 100644 (file)
--- a/includes/api/ApiOpenSearch.php
+++ b/includes/api/ApiOpenSearch.php
@@ -4,7 +4,7 @@
  *
  * Created on Oct 13, 2006
  *
- * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
  *
  * 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
@@ -24,11 +24,6 @@
  * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once( "ApiBase.php" );
-}
-
 /**
  * @ingroup API
  */
@@ -52,28 +47,30 @@ class ApiOpenSearch extends ApiBase {
 
                // MWSuggest or similar hit
                if ( $suggest && !$wgEnableOpenSearchSuggest ) {
-                       $srchres = array();
+                       $searches = array();
                } else {
-                       // Open search results may be stored for a very long
-                       // time
+                       // Open search results may be stored for a very long time
                        $this->getMain()->setCacheMaxAge( $wgSearchSuggestCacheExpiry );
                        $this->getMain()->setCacheMode( 'public' );
 
-                       $srchres = PrefixSearch::titleSearch( $search, $limit,
+                       $searches = PrefixSearch::titleSearch( $search, $limit,
                                $namespaces );
-                       
+
                        // if the content language has variants, try to retrieve fallback results
-                       $fblimit = $limit - count( $srchres );
-                       if ( $fblimit > 0 ) {
+                       $fallbackLimit = $limit - count( $searches );
+                       if ( $fallbackLimit > 0 ) {
                                global $wgContLang;
-                               $fbsearchs = $wgContLang->autoConvertToAllVariants( $search );
-                               $fbsearchs = array_diff( array_unique( $fbsearchs ), ( array ) $search );
-                               foreach ( $fbsearchs as $fbsearch ) {
-                                       $_srchres = PrefixSearch::titleSearch( $fbsearch, $fblimit,
+
+                               $fallbackSearches = $wgContLang->autoConvertToAllVariants( $search );
+                               $fallbackSearches = array_diff( array_unique( $fallbackSearches ), array( $search ) );
+
+                               foreach ( $fallbackSearches as $fbs ) {
+                                       $fallbackSearchResult = PrefixSearch::titleSearch( $fbs, $fallbackLimit,
                                                $namespaces );
-                                       $srchres = array_merge( $srchres, $_srchres );
-                                       $fblimit -= - count( $_srchres );
-                                       if ( $fblimit == 0 ) {
+                                       $searches = array_merge( $searches, $fallbackSearchResult );
+                                       $fallbackLimit -= count( $fallbackSearchResult );
+
+                                       if ( $fallbackLimit == 0 ) {
                                                break;
                                        }
                                }
@@ -82,7 +79,7 @@ class ApiOpenSearch extends ApiBase {
                // Set top level elements
                $result = $this->getResult();
                $result->addValue( null, 0, $search );
-               $result->addValue( null, 1, $srchres );
+               $result->addValue( null, 1, $searches );
        }
 
        public function getAllowedParams() {
@@ -114,15 +111,19 @@ class ApiOpenSearch extends ApiBase {
        }
 
        public function getDescription() {
-               return 'This module implements OpenSearch protocol';
+               return 'Search the wiki using the OpenSearch protocol';
        }
 
-       protected function getExamples() {
+       public function getExamples() {
                return array(
                        'api.php?action=opensearch&search=Te'
                );
        }
 
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/API:Opensearch';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }