You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

MessageProvider.php 1.7KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  3. /**
  4. * This file is part of the PEAR Console_CommandLine package.
  5. *
  6. * PHP version 5
  7. *
  8. * LICENSE: This source file is subject to the MIT license that is available
  9. * through the world-wide-web at the following URI:
  10. * http://opensource.org/licenses/mit-license.php
  11. *
  12. * @category Console
  13. * @package Console_CommandLine
  14. * @author David JEAN LOUIS <izimobil@gmail.com>
  15. * @copyright 2007 David JEAN LOUIS
  16. * @license http://opensource.org/licenses/mit-license.php MIT License
  17. * @version CVS: $Id$
  18. * @link http://pear.php.net/package/Console_CommandLine
  19. * @since File available since release 0.1.0
  20. * @filesource
  21. */
  22. /**
  23. * Message providers common interface, all message providers must implement
  24. * this interface.
  25. *
  26. * @category Console
  27. * @package Console_CommandLine
  28. * @author David JEAN LOUIS <izimobil@gmail.com>
  29. * @copyright 2007 David JEAN LOUIS
  30. * @license http://opensource.org/licenses/mit-license.php MIT License
  31. * @version Release: 1.2.2
  32. * @link http://pear.php.net/package/Console_CommandLine
  33. * @since Class available since release 0.1.0
  34. */
  35. interface Console_CommandLine_MessageProvider
  36. {
  37. // get() {{{
  38. /**
  39. * Retrieves the given string identifier corresponding message.
  40. * For a list of identifiers please see the provided default message
  41. * provider.
  42. *
  43. * @param string $code The string identifier of the message
  44. * @param array $vars An array of template variables
  45. *
  46. * @return string
  47. * @see Console_CommandLine_MessageProvider_Default
  48. */
  49. public function get($code, $vars=array());
  50. // }}}
  51. }