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

Source for file StoreInt.php

Documentation is available at StoreInt.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 StoreInt action.
  32.  *
  33.  * The execute method store the value of the option entered by the user as an
  34.  * integer in the result option array entry, if the value passed is not an
  35.  * integer an Exception is raised.
  36.  *
  37.  * @category  Console
  38.  * @package   Console_CommandLine
  39.  * @author    David JEAN LOUIS <izimobil@gmail.com>
  40.  * @copyright 2007 David JEAN LOUIS
  41.  * @license   http://opensource.org/licenses/mit-license.php MIT License
  42.  * @version   Release: 1.2.0
  43.  * @link      http://pear.php.net/package/Console_CommandLine
  44.  * @since     Class available since release 0.1.0
  45.  */
  46. {
  47.     // execute() {{{
  48.  
  49.     /**
  50.      * Executes the action with the value entered by the user.
  51.      *
  52.      * @param mixed $value  The option value
  53.      * @param array $params An array of optional parameters
  54.      *
  55.      * @return string 
  56.      * @throws Console_CommandLine_Exception
  57.      */
  58.     public function execute($value = false$params = array())
  59.     {
  60.         if (!is_numeric($value)) {
  61.             include_once 'Console/CommandLine/Exception.php';
  62.             throw Console_CommandLine_Exception::factory(
  63.                 'OPTION_VALUE_TYPE_ERROR',
  64.                 array(
  65.                     'name'  => $this->option->name,
  66.                     'type'  => 'int',
  67.                     'value' => $value
  68.                 ),
  69.                 $this->parser
  70.             );
  71.         }
  72.         $this->setResult((int)$value);
  73.     }
  74.     // }}}
  75. }

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