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

Source for file Result.php

Documentation is available at Result.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.  * A lightweight class to store the result of the command line parsing.
  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.     // Public properties {{{
  39.  
  40.     /**
  41.      * The result options associative array.
  42.      * Key is the name of the option and value its value.
  43.      *
  44.      * @var array $options Result options array
  45.      */
  46.     public $options = array();
  47.  
  48.     /**
  49.      * The result arguments array.
  50.      *
  51.      * @var array $args Result arguments array
  52.      */
  53.     public $args = array();
  54.  
  55.     /**
  56.      * Name of the command invoked by the user, false if no command invoked.
  57.      *
  58.      * @var string $command_name Result command name
  59.      */
  60.     public $command_name = false;
  61.  
  62.     /**
  63.      * A result instance for the subcommand.
  64.      *
  65.      * @var Console_CommandLine_Result Result instance for the subcommand
  66.      */
  67.     public $command = false;
  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.