includes/libs/MessageSpecifier.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  */
  20
  21 interface MessageSpecifier {
  22         /**
  23          * Returns the message key
  24          *
  25          * If a list of multiple possible keys was supplied to the constructor, this method may
  26          * return any of these keys. After the message has been fetched, this method will return
  27          * the key that was actually used to fetch the message.
  28          *
  29          * @return string
  30          */
  31         public function getKey();
  32
  33         /**
  34          * Returns the message parameters
  35          *
  36          * @return array
  37          */
  38         public function getParams();
  39 }