languages/MessageLocalizer.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup Language
  20  */
  21
  22 /**
  23  * Interface for localizing messages in MediaWiki
  24  *
  25  * @since 1.30
  26  * @ingroup Language
  27  */
  28 interface MessageLocalizer {
  29
  30         /**
  31          * This is the method for getting translated interface messages.
  32          *
  33          * @see https://www.mediawiki.org/wiki/Manual:Messages_API
  34          * @see Message::__construct
  35          *
  36          * @param string|string[]|MessageSpecifier $key Message key, or array of keys,
  37          *   or a MessageSpecifier.
  38          * @param mixed $params,... Normal message parameters
  39          * @return Message
  40          */
  41         public function msg( $key /*...*/ );
  42
  43 }