diff options
author | Pierre Schmitz <pierre@archlinux.de> | 2008-03-21 11:49:34 +0100 |
---|---|---|
committer | Pierre Schmitz <pierre@archlinux.de> | 2008-03-21 11:49:34 +0100 |
commit | 086ae52d12011746a75f5588e877347bc0457352 (patch) | |
tree | e73263c7a29d0f94fafb874562610e16eb292ba8 /includes/api/ApiQueryAllmessages.php | |
parent | 749e7fb2bae7bbda855de3c9e319435b9f698ff7 (diff) |
Update auf MediaWiki 1.12.0
Diffstat (limited to 'includes/api/ApiQueryAllmessages.php')
-rw-r--r-- | includes/api/ApiQueryAllmessages.php | 129 |
1 files changed, 129 insertions, 0 deletions
diff --git a/includes/api/ApiQueryAllmessages.php b/includes/api/ApiQueryAllmessages.php new file mode 100644 index 00000000..b7c86a91 --- /dev/null +++ b/includes/api/ApiQueryAllmessages.php @@ -0,0 +1,129 @@ +<?php + +/* + * Created on Dec 1, 2007 + * + * API for MediaWiki 1.8+ + * + * Copyright (C) 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 + * 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., + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * http://www.gnu.org/copyleft/gpl.html + */ + +if (!defined('MEDIAWIKI')) { + // Eclipse helper - will be ignored in production + require_once ('ApiQueryBase.php'); +} + +/** + * A query action to return messages from site message cache + * + * @addtogroup API + */ +class ApiQueryAllmessages extends ApiQueryBase { + + public function __construct($query, $moduleName) { + parent :: __construct($query, $moduleName, 'am'); + } + + public function execute() { + global $wgMessageCache; + $params = $this->extractRequestParams(); + + if(!is_null($params['lang'])) + { + global $wgLang; + $wgLang = Language::factory($params['lang']); + } + + + //Determine which messages should we print + $messages_target = array(); + if( $params['messages'] == '*' ) { + $wgMessageCache->loadAllMessages(); + $message_names = array_keys( array_merge( Language::getMessagesFor( 'en' ), $wgMessageCache->getExtensionMessagesFor( 'en' ) ) ); + sort( $message_names ); + $messages_target = $message_names; + } else { + $messages_target = explode( '|', $params['messages'] ); + } + + //Filter messages + if( isset( $params['filter'] ) ) { + $messages_filtered = array(); + foreach( $messages_target as $message ) { + if( strpos( $message, $params['filter'] ) !== false ) { //!== is used because filter can be at the beginnig of the string + $messages_filtered[] = $message; + } + } + $messages_target = $messages_filtered; + } + + $wgMessageCache->disableTransform(); + + //Get all requested messages + $messages = array(); + foreach( $messages_target as $message ) { + $message = trim( $message ); //Message list can be formatted like "msg1 | msg2 | msg3", so let's trim() it + $messages[$message] = wfMsg( $message ); + } + + //Print the result + $result = $this->getResult(); + $messages_out = array(); + foreach( $messages as $name => $value ) { + $message = array(); + $message['name'] = $name; + $result->setContent( $message, $value ); + $messages_out[] = $message; + } + $result->setIndexedTagName( $messages_out, 'message' ); + $result->addValue( 'query', $this->getModuleName(), $messages_out ); + } + + public function getAllowedParams() { + return array ( + 'messages' => array ( + ApiBase :: PARAM_DFLT => '*', + ), + 'filter' => array(), + 'lang' => null, + ); + } + + public function getParamDescription() { + return array ( + 'messages' => 'Which messages to output. "*" means all messages', + 'filter' => 'Return only messages that contains specified string', + 'lang' => 'Language code', + ); + } + + public function getDescription() { + return 'Return messages from this site.'; + } + + protected function getExamples() { + return array( + 'api.php?action=query&meta=allmessages&amfilter=ipb-', + 'api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de', + ); + } + + public function getVersion() { + return __CLASS__ . ': $Id: ApiQueryAllmessages.php 30222 2008-01-28 19:05:26Z catrope $'; + } +} |