Page MenuHomeWickedGov Phorge
Files F1430410

ApiULSLocalization.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

ApiULSLocalization.php
View Options

<?php
/**
* Localization API for ULS
*
* Copyright (C) 2013 Alolita Sharma, Amir Aharoni, Arun Ganesh, Brandon Harris,
* Niklas Laxström, Pau Giner, Santhosh Thottingal, Siebrand Mazeland and other
* contributors. See CREDITS for a list.
*
* UniversalLanguageSelector is dual licensed GPLv2 or later and MIT. You don't
* have to do anything special to choose one license or the other and you don't
* have to notify anyone which license you are using. You are free to use
* UniversalLanguageSelector in commercial projects as long as the copyright
* header is left intact. See files GPL-LICENSE and MIT-LICENSE for details.
*
* @file
* @ingroup Extensions
* @license GPL-2.0-or-later
* @license MIT
*/
namespace UniversalLanguageSelector\Api;
use ApiBase;
use ApiFormatRaw;
use ApiMain;
use MediaWiki\Languages\LanguageNameUtils;
use UniversalLanguageSelector\ULSJsonMessageLoader;
use Wikimedia\ParamValidator\ParamValidator;
/**
* @ingroup API
*/
class ApiULSLocalization extends ApiBase {
/** @var LanguageNameUtils */
private $languageNameUtils;
/**
* @param ApiMain $main
* @param string $action
* @param LanguageNameUtils $languageNameUtils
*/
public function __construct(
ApiMain $main,
$action,
LanguageNameUtils $languageNameUtils
) {
parent::__construct( $main, $action );
$this->languageNameUtils = $languageNameUtils;
}
/**
* @inheritDoc
*/
public function execute() {
$this->getMain()->setCacheMode( 'public' );
$this->getMain()->setCacheMaxAge( 2419200 );
$params = $this->extractRequestParams();
$language = $params['language'];
if ( !$this->languageNameUtils->isValidCode( $language ) ) {
$this->dieWithError( [ 'apierror-invalidlang', 'language' ], 'invalidlanguage' );
}
$contents = ULSJsonMessageLoader::getMessages( $language );
// Output the file's contents raw
$this->getResult()->addValue( null, 'text', json_encode( $contents ) );
$this->getResult()->addValue( null, 'mime', 'application/json' );
}
/**
* @inheritDoc
*/
public function getCustomPrinter() {
return new ApiFormatRaw(
$this->getMain(),
$this->getMain()->createPrinterByName( 'json' )
);
}
/**
* @inheritDoc
*/
public function getAllowedParams() {
return [
'language' => [
ParamValidator::PARAM_REQUIRED => true,
ParamValidator::PARAM_TYPE => 'string',
],
];
}
/**
* @inheritDoc
*/
protected function getExamplesMessages() {
return [
'action=ulslocalization&language=ta'
=> 'apihelp-ulslocalization-example-1',
'action=ulslocalization&language=hi'
=> 'apihelp-ulslocalization-example-2',
];
}
/**
* @inheritDoc
*/
public function isInternal() {
// Try to scare people away from using this externally
return true;
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 18:43 (4 h, 51 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
9f/f2/fb8bc6ec950385146729f79ff690
Default Alt Text
ApiULSLocalization.php (2 KB)

Event Timeline