Gecko [ paroquia-rio-de-mouro.pt ]

Name	Size	Permission	Date
i18n	[ DIR ]	drwxr-xr-x	2016-11-28 20:20
ApiAMCreateAccount.php	4.17 KB	-rw-r--r--	2016-11-28 20:20
ApiAuthManagerHelper.php	12.14 KB	-rw-r--r--	2016-11-28 20:20
ApiBase.php	84.45 KB	-rw-r--r--	2016-11-28 20:20
ApiBlock.php	5.16 KB	-rw-r--r--	2016-11-28 20:20
ApiCSPReport.php	6.34 KB	-rw-r--r--	2016-11-28 20:20
ApiChangeAuthenticationData.php	2.95 KB	-rw-r--r--	2016-11-28 20:20
ApiCheckToken.php	2.24 KB	-rw-r--r--	2016-11-28 20:20
ApiClearHasMsg.php	1.62 KB	-rw-r--r--	2016-11-28 20:20
ApiClientLogin.php	4.39 KB	-rw-r--r--	2016-11-28 20:20
ApiComparePages.php	3.51 KB	-rw-r--r--	2016-11-28 20:20
ApiContinuationManager.php	8.03 KB	-rw-r--r--	2016-11-28 20:20
ApiDelete.php	6.38 KB	-rw-r--r--	2016-11-28 20:20
ApiDisabled.php	1.42 KB	-rw-r--r--	2016-11-28 20:20
ApiEditPage.php	18.94 KB	-rw-r--r--	2016-11-28 20:20
ApiEmailUser.php	2.79 KB	-rw-r--r--	2016-11-28 20:20
ApiErrorFormatter.php	9.31 KB	-rw-r--r--	2016-11-28 20:20
ApiExpandTemplates.php	7.05 KB	-rw-r--r--	2016-11-28 20:20
ApiFeedContributions.php	6.51 KB	-rw-r--r--	2016-11-28 20:20
ApiFeedRecentChanges.php	5.32 KB	-rw-r--r--	2016-11-28 20:20
ApiFeedWatchlist.php	8.96 KB	-rw-r--r--	2016-11-28 20:20
ApiFileRevert.php	3.86 KB	-rw-r--r--	2016-11-28 20:20
ApiFormatBase.php	8.3 KB	-rw-r--r--	2016-11-28 20:20
ApiFormatDbg.php	1.77 KB	-rw-r--r--	2010-12-22 21:52
ApiFormatDump.php	1.79 KB	-rw-r--r--	2011-01-10 23:36
ApiFormatFeedWrapper.php	3.51 KB	-rw-r--r--	2016-11-28 20:20
ApiFormatJson.php	3.86 KB	-rw-r--r--	2016-11-28 20:20
ApiFormatNone.php	1.07 KB	-rw-r--r--	2016-11-28 20:20
ApiFormatPhp.php	2.47 KB	-rw-r--r--	2016-11-28 20:20
ApiFormatRaw.php	3.02 KB	-rw-r--r--	2016-11-28 20:20
ApiFormatTxt.php	1.75 KB	-rw-r--r--	2010-12-22 21:52
ApiFormatWddx.php	4.07 KB	-rw-r--r--	2010-12-22 21:52
ApiFormatXml.php	8.96 KB	-rw-r--r--	2016-11-28 20:20
ApiFormatYaml.php	1.37 KB	-rw-r--r--	2011-04-18 13:42
ApiHelp.php	26.17 KB	-rw-r--r--	2016-11-28 20:20
ApiHelpParamValueMessage.php	1.95 KB	-rw-r--r--	2016-11-28 20:20
ApiImageRotate.php	5.19 KB	-rw-r--r--	2016-11-28 20:20
ApiImport.php	4.95 KB	-rw-r--r--	2016-11-28 20:20
ApiLinkAccount.php	3.83 KB	-rw-r--r--	2016-11-28 20:20
ApiLogin.php	9.22 KB	-rw-r--r--	2016-11-28 20:20
ApiLogout.php	2.04 KB	-rw-r--r--	2016-11-28 20:20
ApiMain.php	55.81 KB	-rw-r--r--	2016-11-28 20:20
ApiManageTags.php	3.24 KB	-rw-r--r--	2016-11-28 20:20
ApiMergeHistory.php	3.75 KB	-rw-r--r--	2016-11-28 20:20
ApiMessage.php	5.64 KB	-rw-r--r--	2016-11-28 20:20
ApiModuleManager.php	8.31 KB	-rw-r--r--	2016-11-28 20:20
ApiMove.php	7.22 KB	-rw-r--r--	2016-11-28 20:20
ApiOpenSearch.php	11.74 KB	-rw-r--r--	2016-11-28 20:20
ApiOptions.php	5.25 KB	-rw-r--r--	2016-11-28 20:20
ApiPageSet.php	44.37 KB	-rw-r--r--	2016-11-28 20:20
ApiParamInfo.php	14.88 KB	-rw-r--r--	2016-11-28 20:20
ApiParse.php	26.07 KB	-rw-r--r--	2016-11-28 20:20
ApiPatrol.php	2.99 KB	-rw-r--r--	2016-11-28 20:20
ApiProtect.php	5.54 KB	-rw-r--r--	2016-11-28 20:20
ApiPurge.php	5.83 KB	-rw-r--r--	2016-11-28 20:20
ApiQuery.php	17.13 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryAllCategories.php	5.79 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryAllDeletedRevisions.php	14.65 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryAllImages.php	11.64 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryAllLinks.php	8.69 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryAllMessages.php	7.26 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryAllPages.php	9.65 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryAllRevisions.php	8.78 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryAllUsers.php	11.5 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryAllimages.php	8.42 KB	-rw-r--r--	2011-11-28 16:52
ApiQueryAllmessages.php	7.59 KB	-rw-r--r--	2011-11-28 16:52
ApiQueryAllpages.php	10.24 KB	-rw-r--r--	2011-11-28 16:52
ApiQueryAuthManagerInfo.php	4.11 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryBacklinks.php	17.24 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryBacklinksprop.php	12.31 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryBase.php	17.33 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryBlocks.php	10.29 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryCategories.php	6.53 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryCategoryInfo.php	3.29 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryCategoryMembers.php	11.99 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryContributors.php	7.5 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryDeletedRevisions.php	9.64 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryDeletedrevs.php	16.42 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryDisabled.php	1.4 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryDuplicateFiles.php	5.38 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryExtLinksUsage.php	5.94 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryExternalLinks.php	3.79 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryFileRepoInfo.php	3.2 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryFilearchive.php	9.18 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryGeneratorBase.php	3.27 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryIWBacklinks.php	5.62 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryIWLinks.php	5.12 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryImageInfo.php	25.98 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryImages.php	4.88 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryInfo.php	27.38 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryLangBacklinks.php	5.55 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryLangLinks.php	5.44 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryLinks.php	6.63 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryLogEvents.php	14.02 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryMyStashedFiles.php	4.04 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryPagePropNames.php	2.96 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryPageProps.php	3.13 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryPagesWithProp.php	4.84 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryPrefixSearch.php	3.63 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryProtectedTitles.php	6.83 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryQueryPage.php	4.6 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryRandom.php	6.56 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryRecentChanges.php	21.5 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryRevisions.php	14.46 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryRevisionsBase.php	15.64 KB	-rw-r--r--	2016-11-28 20:20
ApiQuerySearch.php	10.87 KB	-rw-r--r--	2016-11-28 20:20
ApiQuerySiteinfo.php	26.94 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryStashImageInfo.php	4.25 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryTags.php	4.93 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryTokens.php	4 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryUserContributions.php	17.06 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryUserInfo.php	9.93 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryUsers.php	10.21 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryWatchlist.php	15.41 KB	-rw-r--r--	2016-11-28 20:20
ApiQueryWatchlistRaw.php	5.74 KB	-rw-r--r--	2016-11-28 20:20
ApiRemoveAuthenticationData.php	3.29 KB	-rw-r--r--	2016-11-28 20:20
ApiResetPassword.php	3.89 KB	-rw-r--r--	2016-11-28 20:20
ApiResult.php	36.21 KB	-rw-r--r--	2016-11-28 20:20
ApiRevisionDelete.php	6.42 KB	-rw-r--r--	2016-11-28 20:20
ApiRollback.php	6.02 KB	-rw-r--r--	2016-11-28 20:20
ApiRsd.php	4.71 KB	-rw-r--r--	2016-11-28 20:20
ApiSerializable.php	1.55 KB	-rw-r--r--	2016-11-28 20:20
ApiSetNotificationTimestamp.php	7.01 KB	-rw-r--r--	2016-11-28 20:20
ApiStashEdit.php	15.04 KB	-rw-r--r--	2016-11-28 20:20
ApiTag.php	4.6 KB	-rw-r--r--	2016-11-28 20:20
ApiTokens.php	3.11 KB	-rw-r--r--	2016-11-28 20:20
ApiUnblock.php	3.52 KB	-rw-r--r--	2016-11-28 20:20
ApiUndelete.php	3.9 KB	-rw-r--r--	2016-11-28 20:20
ApiUpload.php	30.6 KB	-rw-r--r--	2016-11-28 20:20
ApiUserrights.php	3.92 KB	-rw-r--r--	2016-11-28 20:20
ApiWatch.php	5.3 KB	-rw-r--r--	2016-11-28 20:20
SearchApi.php	6.16 KB	-rw-r--r--	2016-11-28 20:20

Rename

<?php
use MediaWiki\MediaWikiServices;

/**
 * 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
 *
 * @file
 * @since 1.28
 */

/**
 * Traits for API components that use a SearchEngine.
 * @ingroup API
 */
trait SearchApi {

/**
	 * When $wgSearchType is null, $wgSearchAlternatives[0] is null. Null isn't
	 * a valid option for an array for PARAM_TYPE, so we'll use a fake name
	 * that can't possibly be a class name and describes what the null behavior
	 * does
	 */
	private static $BACKEND_NULL_PARAM = 'database-backed';

/**
	 * The set of api parameters that are shared between api calls that
	 * call the SearchEngine. Primarily this defines parameters that
	 * are utilized by self::buildSearchEngine().
	 *
	 * @param bool $isScrollable True if the api offers scrolling
	 * @return array
	 */
	public function buildCommonApiParams( $isScrollable = true ) {
		$params = [
			'search' => [
				ApiBase::PARAM_TYPE => 'string',
				ApiBase::PARAM_REQUIRED => true,
			],
			'namespace' => [
				ApiBase::PARAM_DFLT => NS_MAIN,
				ApiBase::PARAM_TYPE => 'namespace',
				ApiBase::PARAM_ISMULTI => true,
			],
			'limit' => [
				ApiBase::PARAM_DFLT => 10,
				ApiBase::PARAM_TYPE => 'limit',
				ApiBase::PARAM_MIN => 1,
				ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
				ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2,
			],
		];
		if ( $isScrollable ) {
			$params['offset'] = [
				ApiBase::PARAM_DFLT => 0,
				ApiBase::PARAM_TYPE => 'integer',
				ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
			];
		}

$searchConfig = MediaWikiServices::getInstance()->getSearchEngineConfig();
		$alternatives = $searchConfig->getSearchTypes();
		if ( count( $alternatives ) > 1 ) {
			if ( $alternatives[0] === null ) {
				$alternatives[0] = self::$BACKEND_NULL_PARAM;
			}
			$this->allowedParams['backend'] = [
				ApiBase::PARAM_DFLT => $searchConfig->getSearchType(),
				ApiBase::PARAM_TYPE => $alternatives,
			];
			// @todo: support profile selection when multiple
			// backends are available. The solution could be to
			// merge all possible profiles and let ApiBase
			// subclasses do the check. Making ApiHelp and ApiSandbox
			// comprehensive might be more difficult.
		} else {
			$params += $this->buildProfileApiParam();
		}

return $params;
	}

/**
	 * Build the profile api param definitions. Makes bold assumption only one search
	 * engine is available, ensure that is true before calling.
	 *
	 * @return array array containing available additional api param definitions.
	 *  Empty if profiles are not supported by the searchEngine implementation.
	 */
	private function buildProfileApiParam() {
		$configs = $this->getSearchProfileParams();
		$searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
		$params = [];
		foreach ( $configs as $paramName => $paramConfig ) {
			$profiles = $searchEngine->getProfiles( $paramConfig['profile-type'],
				$this->getContext()->getUser() );
			if ( !$profiles ) {
				continue;
			}

$types = [];
			$helpMessages = [];
			$defaultProfile = null;
			foreach ( $profiles as $profile ) {
				$types[] = $profile['name'];
				if ( isset ( $profile['desc-message'] ) ) {
					$helpMessages[$profile['name']] = $profile['desc-message'];
				}
				if ( !empty( $profile['default'] ) ) {
					$defaultProfile = $profile['name'];
				}
			}

$params[$paramName] = [
				ApiBase::PARAM_TYPE => $types,
				ApiBase::PARAM_HELP_MSG => $paramConfig['help-message'],
				ApiBase::PARAM_HELP_MSG_PER_VALUE => $helpMessages,
				ApiBase::PARAM_DFLT => $defaultProfile,
			];
		}

return $params;
	}

/**
	 * Build the search engine to use.
	 * If $params is provided then the following searchEngine options
	 * will be set:
	 *  - backend: which search backend to use
	 *  - limit: mandatory
	 *  - offset: optional, if set limit will be incremented by
	 *    one ( to support the continue parameter )
	 *  - namespace: mandatory
	 *  - search engine profiles defined by SearchApi::getSearchProfileParams()
	 * @param string[]|null API request params (must be sanitized by
	 * ApiBase::extractRequestParams() before)
	 * @return SearchEngine the search engine
	 */
	public function buildSearchEngine( array $params = null ) {
		if ( $params != null ) {
			$type = isset( $params['backend'] ) ? $params['backend'] : null;
			if ( $type === self::$BACKEND_NULL_PARAM ) {
				$type = null;
			}
			$searchEngine = MediaWikiServices::getInstance()->getSearchEngineFactory()->create( $type );
			$limit = $params['limit'];
			$searchEngine->setNamespaces( $params['namespace'] );
			$offset = null;
			if ( isset( $params['offset'] ) ) {
				// If the API supports offset then it probably
				// wants to fetch limit+1 so it can check if
				// more results are available to properly set
				// the continue param
				$offset = $params['offset'];
				$limit += 1;
			}
			$searchEngine->setLimitOffset( $limit, $offset );

// Initialize requested search profiles.
			$configs = $this->getSearchProfileParams();
			foreach ( $configs as $paramName => $paramConfig ) {
				if ( isset( $params[$paramName] ) ) {
					$searchEngine->setFeatureData(
						$paramConfig['profile-type'],
						$params[$paramName]
					);
				}
			}
		} else {
			$searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
		}
		return $searchEngine;
	}

/**
	 * @return array[] array of arrays mapping from parameter name to a two value map
	 *  containing 'help-message' and 'profile-type' keys.
	 */
	abstract public function getSearchProfileParams();

/**
	 * @return IContextSource
	 */
	abstract public function getContext();
}