API: fix copyright symbol, coding style cleanup, more braces

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

diff --git a/includes/api/ApiOpenSearch.php b/includes/api/ApiOpenSearch.php
index 4a673c2..397d715 100644 (file)
--- a/includes/api/ApiOpenSearch.php
+++ b/includes/api/ApiOpenSearch.php
@@ -1,11 +1,11 @@
 <?php
 
-/*
+/**
  * Created on Oct 13, 2006
  *
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 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
@@ -23,9 +23,9 @@
  * http://www.gnu.org/copyleft/gpl.html
  */
 
-if (!defined('MEDIAWIKI')) {
+if ( !defined( 'MEDIAWIKI' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ("ApiBase.php");
+       require_once( "ApiBase.php" );
 }
 
 /**
@@ -33,54 +33,65 @@ if (!defined('MEDIAWIKI')) {
  */
 class ApiOpenSearch extends ApiBase {
 
-       public function __construct($main, $action) {
-               parent :: __construct($main, $action);
+       public function __construct( $main, $action ) {
+               parent::__construct( $main, $action );
        }
 
        public function getCustomPrinter() {
-               return $this->getMain()->createPrinterByName('json');
+               return $this->getMain()->createPrinterByName( 'json' );
        }
 
        public function execute() {
+               global $wgEnableOpenSearchSuggest, $wgSearchSuggestCacheExpiry;
                $params = $this->extractRequestParams();
                $search = $params['search'];
                $limit = $params['limit'];
                $namespaces = $params['namespace'];
-               
-               // Open search results may be stored for a very long time
-               $this->getMain()->setCacheMaxAge(1200);
+               $suggest = $params['suggest'];
 
-               $srchres = PrefixSearch::titleSearch( $search, $limit, $namespaces );
+               // MWSuggest or similar hit
+               if ( $suggest && !$wgEnableOpenSearchSuggest ) {
+                       $srchres = array();
+               } else {
+                       // Open search results may be stored for a very long
+                       // time
+                       $this->getMain()->setCacheMaxAge( $wgSearchSuggestCacheExpiry );
+                       $this->getMain()->setCacheControl( array( 'must-revalidate' => false ) );
 
+                       $srchres = PrefixSearch::titleSearch( $search, $limit,
+                               $namespaces );
+               }
                // Set top level elements
                $result = $this->getResult();
-               $result->addValue(null, 0, $search);
-               $result->addValue(null, 1, $srchres);
+               $result->addValue( null, 0, $search );
+               $result->addValue( null, 1, $srchres );
        }
 
        public function getAllowedParams() {
-               return array (
+               return array(
                        'search' => null,
-                       'limit' => array (
-                               ApiBase :: PARAM_DFLT => 10,
-                               ApiBase :: PARAM_TYPE => 'limit',
-                               ApiBase :: PARAM_MIN => 1,
-                               ApiBase :: PARAM_MAX => 100,
-                               ApiBase :: PARAM_MAX2 => 100
+                       'limit' => array(
+                               ApiBase::PARAM_DFLT => 10,
+                               ApiBase::PARAM_TYPE => 'limit',
+                               ApiBase::PARAM_MIN => 1,
+                               ApiBase::PARAM_MAX => 100,
+                               ApiBase::PARAM_MAX2 => 100
                        ),
                        'namespace' => array(
-                               ApiBase :: PARAM_DFLT => NS_MAIN,
-                               ApiBase :: PARAM_TYPE => 'namespace',
-                               ApiBase :: PARAM_ISMULTI => true
+                               ApiBase::PARAM_DFLT => NS_MAIN,
+                               ApiBase::PARAM_TYPE => 'namespace',
+                               ApiBase::PARAM_ISMULTI => true
                        ),
+                       'suggest' => false,
                );
        }
 
        public function getParamDescription() {
-               return array (
+               return array(
                        'search' => 'Search string',
                        'limit' => 'Maximum amount of results to return',
                        'namespace' => 'Namespaces to search',
+                       'suggest' => 'Do nothing if $wgEnableOpenSearchSuggest is false',
                );
        }
 
@@ -89,7 +100,7 @@ class ApiOpenSearch extends ApiBase {
        }
 
        protected function getExamples() {
-               return array (
+               return array(
                        'api.php?action=opensearch&search=Te'
                );
        }