Mercurial > hg > rc1

comparison vendor/pear/console_commandline/Console/CommandLine/Renderer.php @ 0:1e000243b222

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
vanilla 1.3.3 distro, I hope
author Charlie Root
date Thu, 04 Jan 2018 15:50:29 -0500
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:1e000243b222
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 * @copyright 2007 David JEAN LOUIS
18 * @license http://opensource.org/licenses/mit-license.php MIT License
19 * @version CVS: $Id$
20 * @link http://pear.php.net/package/Console_CommandLine
21 * @since File available since release 0.1.0
22 * @filesource
23 */
24
25 /**
26 * Renderers common interface, all renderers must implement this interface.
27 *
28 * @category Console
29 * @package Console_CommandLine
30 * @author David JEAN LOUIS <izimobil@gmail.com>
31 * @copyright 2007 David JEAN LOUIS
32 * @license http://opensource.org/licenses/mit-license.php MIT License
33 * @version Release: @package_version@
34 * @link http://pear.php.net/package/Console_CommandLine
35 * @since Class available since release 0.1.0
36 */
37 interface Console_CommandLine_Renderer
38 {
39 // usage() {{{
40
41 /**
42 * Returns the full usage message.
43 *
44 * @return string The usage message
45 */
46 public function usage();
47
48 // }}}
49 // error() {{{
50
51 /**
52 * Returns a formatted error message.
53 *
54 * @param string $error The error message to format
55 *
56 * @return string The error string
57 */
58 public function error($error);
59
60 // }}}
61 // version() {{{
62
63 /**
64 * Returns the program version string.
65 *
66 * @return string The version string
67 */
68 public function version();
69
70 // }}}
71 }