1. sfCommandArgument.class.php
  2. /**
 * Represents a command line argument.
 *
 * @package    symfony
 * @subpackage command
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfCommandArgument.class.php 21908 2009-09-11 12:06:21Z fabien $
 */
  3. class sfCommandArgument
  4. {
  5.   const REQUIRED = 1;
  6.   const OPTIONAL = 2;
  8.   const IS_ARRAY = 4;
  10.   protected
  11.     $name    = null,
  12.     $mode    = null,
  13.     $default = null,
  14.     $help    = '';
  16.   /**
  17.    * Constructor.
  18.    *
  19.    * @param string  $name    The argument name
  20.    * @param integer $mode    The argument mode: self::REQUIRED or self::OPTIONAL
  21.    * @param string  $help    A help text
  22.    * @param mixed   $default The default value (for self::OPTIONAL mode only)
  23.    */
  24.   public function __construct($name, $mode = null, $help = '', $default = null)
  25.   {
  26.     if (null === $mode)
  27.     {
  28.       $mode = self::OPTIONAL;
  29.     }
  30.     else if (is_string($mode) || $mode > 7)
  31.     {
  32.       throw new sfCommandException(sprintf('Argument mode "%s" is not valid.', $mode));
  33.     }
  35.     $this->name = $name;
  36.     $this->mode = $mode;
  37.     $this->help = $help;
  39.     $this->setDefault($default);
  40.   }
  42.   /**
  43.    * Returns the argument name.
  44.    *
  45.    * @return string The argument name
  46.    */
  47.   public function getName()
  48.   {
  49.     return $this->name;
  50.   }
  52.   /**
  53.    * Returns true if the argument is required.
  54.    *
  55.    * @return Boolean true if parameter mode is self::REQUIRED, false otherwise
  56.    */
  57.   public function isRequired()
  58.   {
  59.     return self::REQUIRED === (self::REQUIRED & $this->mode);
  60.   }
  62.   /**
  63.    * Returns true if the argument can take multiple values.
  64.    *
  65.    * @return Boolean true if mode is self::IS_ARRAY, false otherwise
  66.    */
  67.   public function isArray()
  68.   {
  69.     return self::IS_ARRAY === (self::IS_ARRAY & $this->mode);
  70.   }
  72.   /**
  73.    * Sets the default value.
  74.    *
  75.    * @param mixed $default The default value
  76.    */
  77.   public function setDefault($default = null)
  78.   {
  79.     if (self::REQUIRED === $this->mode && null !== $default)
  80.     {
  81.       throw new sfCommandException('Cannot set a default value except for sfCommandParameter::OPTIONAL mode.');
  82.     }
  84.     if ($this->isArray())
  85.     {
  86.       if (null === $default)
  87.       {
  88.         $default = array();
  89.       }
  90.       else if (!is_array($default))
  91.       {
  92.         throw new sfCommandException('A default value for an array argument must be an array.');
  93.       }
  94.     }
  96.     $this->default = $default;
  97.   }
  99.   /**
  100.    * Returns the default value.
  101.    *
  102.    * @return mixed The default value
  103.    */
  104.   public function getDefault()
  105.   {
  106.     return $this->default;
  107.   }
  109.   /**
  110.    * Returns the help text.
  111.    *
  112.    * @return string The help text
  113.    */
  114.   public function getHelp()
  115.   {
  116.     return $this->help;
  117.   }
  118. }
Debug toolbar