SemanticMediaWiki / SemanticExternalQueryLookup

SemanticExternalQueryLookup.php

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 23 and the first side effect is on line 11.

use SEQL\HookRegistry;

/**
 * @see https://github.com/SemanticMediaWiki/SemanticExternalQueryLookup/
 *
 * @defgroup SEQL Semantic External Query Lookup
 */
if ( !defined( 'MEDIAWIKI' ) ) {
	die( 'This file is part of the SemanticExternalQueryLookup extension, it is not a valid entry point.' );
}

if ( version_compare( $GLOBALS[ 'wgVersion' ], '1.23', 'lt' ) ) {
	die( '<b>Error:</b> This version of <a href="https://github.com/SemanticMediaWiki/SemanticExternalQueryLookup/">SemanticExternalQueryLookup</a> is only compatible with MediaWiki 1.23 or above. You need to upgrade MediaWiki first.' );
}

if ( defined( 'SEQL_VERSION' ) ) {
	// Do not initialize more than once.
	return 1;
}

define( 'SEQL_VERSION', '1.0.0-alpha' );

/**
 * @codeCoverageIgnore
 */
call_user_func( function () {

	// Register extension info
	$GLOBALS['wgExtensionCredits']['semantic'][] = array(
		'path'           => __FILE__,
		'name'           => 'Semantic External Query Lookup',
		'author'         => array( 'James Hong Kong' ),
		'url'            => 'https://github.com/SemanticMediaWiki/SemanticExternalQueryLookup/',
		'descriptionmsg' => 'seql-desc',
		'version'        => SEQL_VERSION,
		'license-name'   => 'GPL-2.0+',
	);

	// Alias to keep LocalSettings independent from the internal NS usage
	class_alias( 'SEQL\ByAskApiHttpRequestQueryLookup', 'SMWExternalQueryLookup' ); // deprecated
	class_alias( 'SEQL\ByAskApiHttpRequestQueryLookup', 'SMWExternalAskQueryLookup' );

	// Register message files
	$GLOBALS['wgMessagesDirs']['semantic-external-query-lookup'] = __DIR__ . '/i18n';

	/**
	 * Specifies how long a response is cached before a new request is routed
	 * to the endpoint. This avoids that repeated requests with the same signature
	 * are made to an endpoint.
	 *
	 * This is important if the endpoint has an API access request limitation.
	 */
	$GLOBALS['seqlgHttpResponseCacheLifetime'] = 60 * 5; // in seconds

	/**
	 * Type of the cache to be used, using CACHE_NONE will disable the caching
	 * and reroutes every request to the endpoint.
	 *
	 * @see https://www.mediawiki.org/wiki/Manual:$wgMainCacheType
	 */
	$GLOBALS['seqlgHttpResponseCacheType'] = CACHE_ANYTHING;

	$GLOBALS['seqlgExternalRepositoryEndpoints'] = array();

	// Finalize extension setup
	$GLOBALS['wgExtensionFunctions'][] = function() {

		$options = array(
			'externalRepositoryEndpoints' => $GLOBALS['seqlgExternalRepositoryEndpoints']
		);

		$hookRegistry = new HookRegistry(
			$options
		);

		$hookRegistry->register();
	};

} );