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

Source for file StoreString.php

Documentation is available at StoreString.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.  * Required by this class.
  27.  */
  28. require_once 'Console/CommandLine/Action.php';
  29.  
  30. /**
  31.  * Class that represent the StoreString action.
  32.  *
  33.  * The execute method store the value of the option entered by the user as a
  34.  * string in the result option array entry.
  35.  *
  36.  * @category  Console
  37.  * @package   Console_CommandLine
  38.  * @author    David JEAN LOUIS <izimobil@gmail.com>
  39.  * @copyright 2007 David JEAN LOUIS
  40.  * @license   http://opensource.org/licenses/mit-license.php MIT License
  41.  * @version   Release: 1.2.0
  42.  * @link      http://pear.php.net/package/Console_CommandLine
  43.  * @since     Class available since release 0.1.0
  44.  */
  45. {
  46.     // execute() {{{
  47.  
  48.     /**
  49.      * Executes the action with the value entered by the user.
  50.      *
  51.      * @param mixed $value  The option value
  52.      * @param array $params An array of optional parameters
  53.      *
  54.      * @return string 
  55.      */
  56.     public function execute($value = false$params = array())
  57.     {
  58.         $this->setResult((string)$value);
  59.     }
  60.     // }}}
  61. }

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