4 * Created on Dec 1, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiQueryBase.php');
32 * A query action to return messages from site message cache
36 class ApiQueryAllmessages
extends ApiQueryBase
{
38 public function __construct($query, $moduleName) {
39 parent
:: __construct($query, $moduleName, 'am');
42 public function execute() {
43 global $wgMessageCache;
44 $params = $this->extractRequestParams();
46 if(!is_null($params['lang']))
49 $wgLang = Language
::factory($params['lang']);
53 //Determine which messages should we print
54 $messages_target = array();
55 if( $params['messages'] == '*' ) {
56 $message_names = array_keys( Language
::getMessagesFor( 'en' ) );
57 sort( $message_names );
58 $messages_target = $message_names;
60 $messages_target = explode( '|', $params['messages'] );
64 if( isset( $params['filter'] ) ) {
65 $messages_filtered = array();
66 foreach( $messages_target as $message ) {
67 if( strpos( $message, $params['filter'] ) !== false ) { //!== is used because filter can be at the beginnig of the string
68 $messages_filtered[] = $message;
71 $messages_target = $messages_filtered;
74 //Get all requested messages
76 $skip = !is_null($params['from']);
77 foreach( $messages_target as $message ) {
78 // Skip all messages up to $params['from']
79 if($skip && $message === $params['from'])
82 $messages[$message] = wfMsg( $message );
86 $result = $this->getResult();
87 $messages_out = array();
88 foreach( $messages as $name => $value ) {
90 $message['name'] = $name;
91 if( wfEmptyMsg( $name, $value ) ) {
92 $message['missing'] = '';
94 $result->setContent( $message, $value );
96 $fit = $result->addValue(array('query', $this->getModuleName()), null, $message);
99 $this->setContinueEnumParameter('from', $name);
103 $result->setIndexedTagName_internal(array('query', $this->getModuleName()), 'message');
106 public function getAllowedParams() {
108 'messages' => array (
109 ApiBase
:: PARAM_DFLT
=> '*',
117 public function getParamDescription() {
119 'messages' => 'Which messages to output. "*" means all messages',
120 'filter' => 'Return only messages that contain this string',
121 'lang' => 'Return messages in this language',
122 'from' => 'Return messages starting at this message',
126 public function getDescription() {
127 return 'Return messages from this site.';
130 protected function getExamples() {
132 'api.php?action=query&meta=allmessages&amfilter=ipb-',
133 'api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de',
137 public function getVersion() {
138 return __CLASS__
. ': $Id$';