1. sfCommandOptionSet.class.php
  2. /**
 * Represent a set of command line options.
 *
 * @package    symfony
 * @subpackage command
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfCommandOptionSet.class.php 17865 2009-05-02 09:23:55Z FabianLange $
 */
  3. class sfCommandOptionSet
  4. {
  5.   protected
  6.     $options   = array(),
  7.     $shortcuts = array();
  9.   /**
  10.    * Constructor.
  11.    *
  12.    * @param array $options An array of sfCommandOption objects
  13.    */
  14.   public function __construct($options = array())
  15.   {
  16.     $this->setOptions($options);
  17.   }
  19.   /**
  20.    * Sets the sfCommandOption objects.
  21.    *
  22.    * @param array $options An array of sfCommandOption objects
  23.    */
  24.   public function setOptions($options = array())
  25.   {
  26.     $this->options = array();
  27.     $this->shortcuts = array();
  28.     $this->addOptions($options);
  29.   }
  31.   /**
  32.    * Add an array of sfCommandOption objects.
  33.    *
  34.    * @param array $options An array of sfCommandOption objects
  35.    */
  36.   public function addOptions($options = array())
  37.   {
  38.     foreach ($options as $option)
  39.     {
  40.       $this->addOption($option);
  41.     }
  42.   }
  44.   /**
  45.    * Add a sfCommandOption objects.
  46.    *
  47.    * @param sfCommandOption $option A sfCommandOption object
  48.    */
  49.   public function addOption(sfCommandOption $option)
  50.   {
  51.     if (isset($this->options[$option->getName()]))
  52.     {
  53.       throw new sfCommandException(sprintf('An option named "%s" already exist.', $option->getName()));
  54.     }
  55.     else if (isset($this->shortcuts[$option->getShortcut()]))
  56.     {
  57.       throw new sfCommandException(sprintf('An option with shortcut "%s" already exist.', $option->getShortcut()));
  58.     }
  60.     $this->options[$option->getName()] = $option;
  61.     if ($option->getShortcut())
  62.     {
  63.       $this->shortcuts[$option->getShortcut()] = $option->getName();
  64.     }
  65.   }
  67.   /**
  68.    * Returns an option by name.
  69.    *
  70.    * @param string $name The option name
  71.    *
  72.    * @return sfCommandOption A sfCommandOption object
  73.    */
  74.   public function getOption($name)
  75.   {
  76.     if (!$this->hasOption($name))
  77.     {
  78.       throw new sfCommandException(sprintf('The "--%s" option does not exist.', $name));
  79.     }
  81.     return $this->options[$name];
  82.   }
  84.   /**
  85.    * Returns true if an option object exists by name.
  86.    *
  87.    * @param string $name The option name
  88.    *
  89.    * @return Boolean true if the option object exists, false otherwise
  90.    */
  91.   public function hasOption($name)
  92.   {
  93.     return isset($this->options[$name]);
  94.   }
  96.   /**
  97.    * Gets the array of sfCommandOption objects.
  98.    *
  99.    * @return array An array of sfCommandOption objects
  100.    */
  101.   public function getOptions()
  102.   {
  103.     return $this->options;
  104.   }
  106.   /**
  107.    * Returns true if an option object exists by shortcut.
  108.    *
  109.    * @param string $name The option shortcut
  110.    *
  111.    * @return Boolean true if the option object exists, false otherwise
  112.    */
  113.   public function hasShortcut($name)
  114.   {
  115.     return isset($this->shortcuts[$name]);
  116.   }
  118.   /**
  119.    * Gets an option by shortcut.
  120.    *
  121.    * @return sfCommandOption A sfCommandOption object
  122.    */
  123.   public function getOptionForShortcut($shortcut)
  124.   {
  125.     return $this->getOption($this->shortcutToName($shortcut));
  126.   }
  128.   /**
  129.    * Gets an array of default values.
  130.    *
  131.    * @return array An array of all default values
  132.    */
  133.   public function getDefaults()
  134.   {
  135.     $values = array();
  136.     foreach ($this->options as $option)
  137.     {
  138.       $values[$option->getName()] = $option->getDefault();
  139.     }
  141.     return $values;
  142.   }
  144.   /**
  145.    * Returns the option name given a shortcut.
  146.    *
  147.    * @param string $shortcut The shortcut
  148.    *
  149.    * @return string The option name
  150.    */
  151.   protected function shortcutToName($shortcut)
  152.   {
  153.     if (!isset($this->shortcuts[$shortcut]))
  154.     {
  155.       throw new sfCommandException(sprintf('The "-%s" option does not exist.', $shortcut));
  156.     }
  158.     return $this->shortcuts[$shortcut];
  159.   }
  160. }
Debug toolbar