diff options
Diffstat (limited to 'includes/libs/MessageSpecifier.php')
-rw-r--r-- | includes/libs/MessageSpecifier.php | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/includes/libs/MessageSpecifier.php b/includes/libs/MessageSpecifier.php new file mode 100644 index 00000000..b417f299 --- /dev/null +++ b/includes/libs/MessageSpecifier.php @@ -0,0 +1,39 @@ +<?php +/** + * 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., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +interface MessageSpecifier { + /** + * Returns the message key + * + * If a list of multiple possible keys was supplied to the constructor, this method may + * return any of these keys. After the message has been fetched, this method will return + * the key that was actually used to fetch the message. + * + * @return string + */ + public function getKey(); + + /** + * Returns the message parameters + * + * @return array + */ + public function getParams(); +} |