|
0
|
1 <?php
|
|
|
2
|
|
|
3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
|
|
|
4
|
|
|
5 /**
|
|
|
6 * This file is part of the PEAR Console_CommandLine package.
|
|
|
7 *
|
|
|
8 * PHP version 5
|
|
|
9 *
|
|
|
10 * LICENSE: This source file is subject to the MIT license that is available
|
|
|
11 * through the world-wide-web at the following URI:
|
|
|
12 * http://opensource.org/licenses/mit-license.php
|
|
|
13 *
|
|
|
14 * @category Console
|
|
|
15 * @package Console_CommandLine
|
|
|
16 * @author David JEAN LOUIS <izimobil@gmail.com>
|
|
|
17 * @author Michael Gauthier <mike@silverorange.com>
|
|
|
18 * @copyright 2007 David JEAN LOUIS, 2009 silverorange
|
|
|
19 * @license http://opensource.org/licenses/mit-license.php MIT License
|
|
|
20 * @version CVS: $Id$
|
|
|
21 * @link http://pear.php.net/package/Console_CommandLine
|
|
|
22 * @since File available since release 1.1.0
|
|
|
23 * @filesource
|
|
|
24 */
|
|
|
25
|
|
|
26 /**
|
|
|
27 * Common interfacefor message providers that allow overriding with custom
|
|
|
28 * messages
|
|
|
29 *
|
|
|
30 * Message providers may optionally implement this interface.
|
|
|
31 *
|
|
|
32 * @category Console
|
|
|
33 * @package Console_CommandLine
|
|
|
34 * @author David JEAN LOUIS <izimobil@gmail.com>
|
|
|
35 * @author Michael Gauthier <mike@silverorange.com>
|
|
|
36 * @copyright 2007 David JEAN LOUIS, 2009 silverorange
|
|
|
37 * @license http://opensource.org/licenses/mit-license.php MIT License
|
|
|
38 * @version Release: @package_version@
|
|
|
39 * @link http://pear.php.net/package/Console_CommandLine
|
|
|
40 * @since Interface available since release 1.1.0
|
|
|
41 */
|
|
|
42 interface Console_CommandLine_CustomMessageProvider
|
|
|
43 {
|
|
|
44 // getWithCustomMesssages() {{{
|
|
|
45
|
|
|
46 /**
|
|
|
47 * Retrieves the given string identifier corresponding message.
|
|
|
48 *
|
|
|
49 * For a list of identifiers please see the provided default message
|
|
|
50 * provider.
|
|
|
51 *
|
|
|
52 * @param string $code The string identifier of the message
|
|
|
53 * @param array $vars An array of template variables
|
|
|
54 * @param array $messages An optional array of messages to use. Array
|
|
|
55 * indexes are message codes.
|
|
|
56 *
|
|
|
57 * @return string
|
|
|
58 * @see Console_CommandLine_MessageProvider
|
|
|
59 * @see Console_CommandLine_MessageProvider_Default
|
|
|
60 */
|
|
|
61 public function getWithCustomMessages(
|
|
|
62 $code, $vars = array(), $messages = array()
|
|
|
63 );
|
|
|
64
|
|
|
65 // }}}
|
|
|
66 }
|
