1. sfCommandOption.class.php
  2. /**
 * Represents a command line option.
 *
 * @package    symfony
 * @subpackage command
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfCommandOption.class.php 21908 2009-09-11 12:06:21Z fabien $
 */
  3. class sfCommandOption
  4. {
  5.   const PARAMETER_NONE     = 1;
  6.   const PARAMETER_REQUIRED = 2;
  7.   const PARAMETER_OPTIONAL = 4;
  9.   const IS_ARRAY = 8;
  11.   protected
  12.     $name     = null,
  13.     $shortcut = null,
  14.     $mode     = null,
  15.     $default  = null,
  16.     $help     = '';
  18.   /**
  19.    * Constructor.
  20.    *
  21.    * @param string  $name     The option name
  22.    * @param string  $shortcut The shortcut (can be null)
  23.    * @param integer $mode     The option mode: self::PARAMETER_REQUIRED, self::PARAMETER_NONE or self::PARAMETER_OPTIONAL
  24.    * @param string  $help     A help text
  25.    * @param mixed   $default  The default value (must be null for self::PARAMETER_REQUIRED or self::PARAMETER_NONE)
  26.    */
  27.   public function __construct($name, $shortcut = null, $mode = null, $help = '', $default = null)
  28.   {
  29.     if ('--' == substr($name, 0, 2))
  30.     {
  31.       $name = substr($name, 2);
  32.     }
  34.     if (empty($shortcut))
  35.     {
  36.       $shortcut = null;
  37.     }
  39.     if (null !== $shortcut)
  40.     {
  41.       if ('-' == $shortcut[0])
  42.       {
  43.         $shortcut = substr($shortcut, 1);
  44.       }
  45.     }
  47.     if (null === $mode)
  48.     {
  49.       $mode = self::PARAMETER_NONE;
  50.     }
  51.     else if (is_string($mode) || $mode > 15)
  52.     {
  53.       throw new sfCommandException(sprintf('Option mode "%s" is not valid.', $mode));
  54.     }
  56.     $this->name     = $name;
  57.     $this->shortcut = $shortcut;
  58.     $this->mode     = $mode;
  59.     $this->help     = $help;
  61.     $this->setDefault($default);
  62.   }
  64.   /**
  65.    * Returns the shortcut.
  66.    *
  67.    * @return string The shortcut
  68.    */
  69.   public function getShortcut()
  70.   {
  71.     return $this->shortcut;
  72.   }
  74.   /**
  75.    * Returns the name.
  76.    *
  77.    * @return string The name
  78.    */
  79.   public function getName()
  80.   {
  81.     return $this->name;
  82.   }
  84.   /**
  85.    * Returns true if the option accept a parameter.
  86.    *
  87.    * @return Boolean true if parameter mode is not self::PARAMETER_NONE, false otherwise
  88.    */
  89.   public function acceptParameter()
  90.   {
  91.     return $this->isParameterRequired() || $this->isParameterOptional();
  92.   }
  94.   /**
  95.    * Returns true if the option requires a parameter.
  96.    *
  97.    * @return Boolean true if parameter mode is self::PARAMETER_REQUIRED, false otherwise
  98.    */
  99.   public function isParameterRequired()
  100.   {
  101.     return self::PARAMETER_REQUIRED === (self::PARAMETER_REQUIRED & $this->mode);
  102.   }
  104.   /**
  105.    * Returns true if the option takes an optional parameter.
  106.    *
  107.    * @return Boolean true if parameter mode is self::PARAMETER_OPTIONAL, false otherwise
  108.    */
  109.   public function isParameterOptional()
  110.   {
  111.     return self::PARAMETER_OPTIONAL === (self::PARAMETER_OPTIONAL & $this->mode);
  112.   }
  114.   /**
  115.    * Returns true if the option can take multiple values.
  116.    *
  117.    * @return Boolean true if mode is self::IS_ARRAY, false otherwise
  118.    */
  119.   public function isArray()
  120.   {
  121.     return self::IS_ARRAY === (self::IS_ARRAY & $this->mode);
  122.   }
  124.   /**
  125.    * Sets the default value.
  126.    *
  127.    * @param mixed $default The default value
  128.    */
  129.   public function setDefault($default = null)
  130.   {
  131.     if (self::PARAMETER_NONE === (self::PARAMETER_NONE & $this->mode) && null !== $default)
  132.     {
  133.       throw new sfCommandException('Cannot set a default value when using sfCommandOption::PARAMETER_NONE mode.');
  134.     }
  136.     if ($this->isArray())
  137.     {
  138.       if (null === $default)
  139.       {
  140.         $default = array();
  141.       }
  142.       else if (!is_array($default))
  143.       {
  144.         throw new sfCommandException('A default value for an array option must be an array.');
  145.       }
  146.     }
  148.     $this->default = $this->acceptParameter() ? $default : false;
  149.   }
  151.   /**
  152.    * Returns the default value.
  153.    *
  154.    * @return mixed The default value
  155.    */
  156.   public function getDefault()
  157.   {
  158.     return $this->default;
  159.   }
  161.   /**
  162.    * Returns the help text.
  163.    *
  164.    * @return string The help text
  165.    */
  166.   public function getHelp()
  167.   {
  168.     return $this->help;
  169.   }
  170. }
Debug toolbar