1. sfCommandArgumentSet.class.php
  2. /**
 * Represent a set of command line arguments.
 *
 * @package    symfony
 * @subpackage command
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfCommandArgumentSet.class.php 21908 2009-09-11 12:06:21Z fabien $
 */
  3. class sfCommandArgumentSet
  4. {
  5.   protected
  6.     $arguments          = array(),
  7.     $requiredCount      = 0,
  8.     $hasAnArrayArgument = false,
  9.     $hasOptional        = false;
  11.   /**
  12.    * Constructor.
  13.    *
  14.    * @param array $arguments An array of sfCommandArgument objects
  15.    */
  16.   public function __construct($arguments = array())
  17.   {
  18.     $this->setArguments($arguments);
  19.   }
  21.   /**
  22.    * Sets the sfCommandArgument objects.
  23.    *
  24.    * @param array $arguments An array of sfCommandArgument objects
  25.    */
  26.   public function setArguments($arguments = array())
  27.   {
  28.     $this->arguments     = array();
  29.     $this->requiredCount = 0;
  30.     $this->hasOptional   = false;
  31.     $this->addArguments($arguments);
  32.   }
  34.   /**
  35.    * Add an array of sfCommandArgument objects.
  36.    *
  37.    * @param array $arguments An array of sfCommandArgument objects
  38.    */
  39.   public function addArguments($arguments = array())
  40.   {
  41.     if (null !== $arguments)
  42.     {
  43.       foreach ($arguments as $argument)
  44.       {
  45.         $this->addArgument($argument);
  46.       }
  47.     }
  48.   }
  50.   /**
  51.    * Add a sfCommandArgument objects.
  52.    *
  53.    * @param sfCommandArgument $argument A sfCommandArgument object
  54.    */
  55.   public function addArgument(sfCommandArgument $argument)
  56.   {
  57.     if (isset($this->arguments[$argument->getName()]))
  58.     {
  59.       throw new sfCommandException(sprintf('An argument with name "%s" already exist.', $argument->getName()));
  60.     }
  62.     if ($this->hasAnArrayArgument)
  63.     {
  64.       throw new sfCommandException('Cannot add an argument after an array argument.');
  65.     }
  67.     if ($argument->isRequired() && $this->hasOptional)
  68.     {
  69.       throw new sfCommandException('Cannot add a required argument after an optional one.');
  70.     }
  72.     if ($argument->isArray())
  73.     {
  74.       $this->hasAnArrayArgument = true;
  75.     }
  77.     if ($argument->isRequired())
  78.     {
  79.       ++$this->requiredCount;
  80.     }
  81.     else
  82.     {
  83.       $this->hasOptional = true;
  84.     }
  86.     $this->arguments[$argument->getName()] = $argument;
  87.   }
  89.   /**
  90.    * Returns an argument by name.
  91.    *
  92.    * @param string $name The argument name
  93.    *
  94.    * @return sfCommandArgument A sfCommandArgument object
  95.    */
  96.   public function getArgument($name)
  97.   {
  98.     if (!$this->hasArgument($name))
  99.     {
  100.       throw new sfCommandException(sprintf('The "%s" argument does not exist.', $name));
  101.     }
  103.     return $this->arguments[$name];
  104.   }
  106.   /**
  107.    * Returns true if an argument object exists by name.
  108.    *
  109.    * @param string $name The argument name
  110.    *
  111.    * @return Boolean true if the argument object exists, false otherwise
  112.    */
  113.   public function hasArgument($name)
  114.   {
  115.     return isset($this->arguments[$name]);
  116.   }
  118.   /**
  119.    * Gets the array of sfCommandArgument objects.
  120.    *
  121.    * @return array An array of sfCommandArgument objects
  122.    */
  123.   public function getArguments()
  124.   {
  125.     return $this->arguments;
  126.   }
  128.   /**
  129.    * Returns the number of arguments.
  130.    *
  131.    * @return integer The number of arguments
  132.    */
  133.   public function getArgumentCount()
  134.   {
  135.     return $this->hasAnArrayArgument ? PHP_INT_MAX : count($this->arguments);
  136.   }
  138.   /**
  139.    * Returns the number of required arguments.
  140.    *
  141.    * @return integer The number of required arguments
  142.    */
  143.   public function getArgumentRequiredCount()
  144.   {
  145.     return $this->requiredCount;
  146.   }
  148.   /**
  149.    * Gets the default values.
  150.    *
  151.    * @return array An array of default values
  152.    */
  153.   public function getDefaults()
  154.   {
  155.     $values = array();
  156.     foreach ($this->arguments as $argument)
  157.     {
  158.       $values[$argument->getName()] = $argument->getDefault();
  159.     }
  161.     return $values;
  162.   }
  163. }
Debug toolbar