MessageSpecifier.php 1.2 KB

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