Normalise comment usage (# --> //)

[lhc/web/wiklou.git] / includes / api / ApiQueryAllmessages.php

diff --git a/includes/api/ApiQueryAllmessages.php b/includes/api/ApiQueryAllmessages.php
index 8f0be01..5601e4e 100644 (file)
--- a/includes/api/ApiQueryAllmessages.php
+++ b/includes/api/ApiQueryAllmessages.php
@@ -23,9 +23,9 @@
  * http://www.gnu.org/copyleft/gpl.html
  */
 
-if (!defined('MEDIAWIKI')) {
+if ( !defined( 'MEDIAWIKI' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ('ApiQueryBase.php');
+       require_once ( 'ApiQueryBase.php' );
 }
 
 /**
@@ -35,81 +35,102 @@ if (!defined('MEDIAWIKI')) {
  */
 class ApiQueryAllmessages extends ApiQueryBase {
 
-       public function __construct($query, $moduleName) {
-               parent :: __construct($query, $moduleName, 'am');
+       public function __construct( $query, $moduleName ) {
+               parent :: __construct( $query, $moduleName, 'am' );
        }
 
        public function execute() {
-               global $wgMessageCache;
                $params = $this->extractRequestParams();
 
-               if(!is_null($params['lang']))
+               if ( !is_null( $params['lang'] ) )
                {
                        global $wgLang;
-                       $wgLang = Language::factory($params['lang']);
+                       $wgLang = Language::factory( $params['lang'] );
                }
+               
+               $prop = array_flip( (array)$params['prop'] );
 
-
-               //Determine which messages should we print
+               // 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' ) ) );
+               if ( in_array( '*', $params['messages'] ) ) {
+                       $message_names = array_keys( Language::getMessagesFor( 'en' ) );
                        sort( $message_names );
                        $messages_target = $message_names;
                } else {
-                       $messages_target = explode( '|', $params['messages'] );
+                       $messages_target = $params['messages'];
                }
 
-               //Filter messages
-               if( isset( $params['filter'] ) ) {
+               // 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
+                       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;
                }
 
-               //Get all requested messages
+               // Get all requested messages and print the result
                $messages = array();
-               foreach( $messages_target as $message ) {
-                       $messages[$message] = wfMsg( $message );
-               }
-
-               //Print the result
+               $skip = !is_null( $params['from'] );
                $result = $this->getResult();
-               $messages_out = array();
-               foreach( $messages as $name => $value ) {
-                       $message = array();
-                       $message['name'] = $name;
-                       if( wfEmptyMsg( $name, $value ) ) {
-                               $message['missing'] = '';
-                       } else {
-                               $result->setContent( $message, $value );
+               foreach ( $messages_target as $message ) {
+                       // Skip all messages up to $params['from']
+                       if ( $skip && $message === $params['from'] ) {
+                               $skip = false;
+
+                               $a = array( 'name' => $message );
+                               $msg = wfMsgGetKey( $message, true, false, false );
+                               if ( wfEmptyMsg( $message, $msg ) )
+                                       $a['missing'] = '';
+                               else {
+                                       ApiResult::setContent( $a, $msg );
+                                       if ( isset( $prop['default'] ) ) {
+                                               $default = wfMsgGetKey( $message, false, false, false );
+                                               if ( $default !== $msg ) {
+                                                       if ( wfEmptyMsg( $message, $default ) )
+                                                               $a['defaultmissing'] = '';
+                                                       else
+                                                               $a['default'] = $default;
+                                               }
+                                       }
+                               }
+                               $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $a );
+                               if ( !$fit ) {
+                                       $this->setContinueEnumParameter( 'from', $name );
+                                       break;
+                               }
                        }
-                       $messages_out[] = $message;
                }
-               $result->setIndexedTagName( $messages_out, 'message' );
-               $result->addValue( 'query', $this->getModuleName(), $messages_out );
+               $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'message' );
        }
 
        public function getAllowedParams() {
                return array (
                        'messages' => array (
                                ApiBase :: PARAM_DFLT => '*',
+                               ApiBase :: PARAM_ISMULTI => true,
+                       ),
+                       'prop' => array(
+                               ApiBase :: PARAM_ISMULTI => true,
+                               ApiBase :: PARAM_TYPE => array(
+                                       'default'
+                               )
                        ),
                        'filter' => array(),
                        'lang' => null,
+                       'from' => 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',
+                       'prop' => 'Which properties to get',
+                       'filter' => 'Return only messages that contain this string',
+                       'lang' => 'Return messages in this language',
+                       'from' => 'Return messages starting at this message',
                );
        }
 
@@ -127,4 +148,4 @@ class ApiQueryAllmessages extends ApiQueryBase {
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
-}
+}
\ No newline at end of file