Console_CommandLine
[ class tree: Console_CommandLine ] [ index: Console_CommandLine ] [ all elements ]

Source for file Renderer.php

Documentation is available at Renderer.php

  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: 1.2.0
  34.  * @link      http://pear.php.net/package/Console_CommandLine
  35.  * @since     Class available since release 0.1.0
  36.  */
  37. {
  38.     // usage() {{{
  39.  
  40.     /**
  41.      * Returns the full usage message.
  42.      *
  43.      * @return string The usage message
  44.      */
  45.     public function usage();
  46.  
  47.     // }}}
  48.     // error() {{{
  49.  
  50.     /**
  51.      * Returns a formatted error message.
  52.      *
  53.      * @param string $error The error message to format
  54.      *
  55.      * @return string The error string
  56.      */
  57.     public function error($error);
  58.  
  59.     // }}}
  60.     // version() {{{
  61.  
  62.     /**
  63.      * Returns the program version string.
  64.      *
  65.      * @return string The version string
  66.      */
  67.     public function version();
  68.  
  69.     // }}}
  70. }

Documentation generated on Thu, 25 Oct 2012 08:00:07 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.