73 lines
1.7 KiB
PHP
73 lines
1.7 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This file is part of the PEAR2\Console\CommandLine package.
|
||
|
|
*
|
||
|
|
* PHP version 5
|
||
|
|
*
|
||
|
|
* LICENSE: This source file is subject to the MIT license that is available
|
||
|
|
* through the world-wide-web at the following URI:
|
||
|
|
* http://opensource.org/licenses/mit-license.php
|
||
|
|
*
|
||
|
|
* @category Console
|
||
|
|
* @package PEAR2\Console\CommandLine
|
||
|
|
* @author David JEAN LOUIS <izimobil@gmail.com>
|
||
|
|
* @copyright 2007-2009 David JEAN LOUIS
|
||
|
|
* @license http://opensource.org/licenses/mit-license.php MIT License
|
||
|
|
* @version 0.2.1
|
||
|
|
* @link http://pear2.php.net/PEAR2_Console_CommandLine
|
||
|
|
* @since File available since release 0.1.0
|
||
|
|
* @filesource
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace PEAR2\Console\CommandLine;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Renderers common interface, all renderers must implement this interface.
|
||
|
|
*
|
||
|
|
* @category Console
|
||
|
|
* @package PEAR2\Console\CommandLine
|
||
|
|
* @author David JEAN LOUIS <izimobil@gmail.com>
|
||
|
|
* @copyright 2007-2009 David JEAN LOUIS
|
||
|
|
* @license http://opensource.org/licenses/mit-license.php MIT License
|
||
|
|
* @link http://pear2.php.net/PEAR2_Console_CommandLine
|
||
|
|
* @since Class available since release 0.1.0
|
||
|
|
*/
|
||
|
|
interface Renderer
|
||
|
|
{
|
||
|
|
// usage() {{{
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the full usage message.
|
||
|
|
*
|
||
|
|
* @return string The usage message
|
||
|
|
*/
|
||
|
|
public function usage();
|
||
|
|
|
||
|
|
// }}}
|
||
|
|
// error() {{{
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns a formatted error message.
|
||
|
|
*
|
||
|
|
* @param string $error The error message to format
|
||
|
|
*
|
||
|
|
* @return string The error string
|
||
|
|
*/
|
||
|
|
public function error($error);
|
||
|
|
|
||
|
|
// }}}
|
||
|
|
// version() {{{
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the program version string.
|
||
|
|
*
|
||
|
|
* @return string The version string
|
||
|
|
*/
|
||
|
|
public function version();
|
||
|
|
|
||
|
|
// }}}
|
||
|
|
}
|