Blame view

vendor/symfony/console/Input/InputArgument.php 3.16 KB
ad2e91f7   Mihail   move multyparser ...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
  <?php
  
  /*
   * This file is part of the Symfony package.
   *
   * (c) Fabien Potencier <fabien@symfony.com>
   *
   * For the full copyright and license information, please view the LICENSE
   * file that was distributed with this source code.
   */
  
  namespace Symfony\Component\Console\Input;
  
  /**
   * Represents a command line argument.
   *
   * @author Fabien Potencier <fabien@symfony.com>
   */
  class InputArgument
  {
      const REQUIRED = 1;
      const OPTIONAL = 2;
      const IS_ARRAY = 4;
  
      private $name;
      private $mode;
      private $default;
      private $description;
  
      /**
       * Constructor.
       *
       * @param string $name        The argument name
       * @param int    $mode        The argument mode: self::REQUIRED or self::OPTIONAL
       * @param string $description A description text
       * @param mixed  $default     The default value (for self::OPTIONAL mode only)
       *
       * @throws \InvalidArgumentException When argument mode is not valid
       */
      public function __construct($name, $mode = null, $description = '', $default = null)
      {
          if (null === $mode) {
              $mode = self::OPTIONAL;
          } elseif (!is_int($mode) || $mode > 7 || $mode < 1) {
              throw new \InvalidArgumentException(sprintf('Argument mode "%s" is not valid.', $mode));
          }
  
          $this->name = $name;
          $this->mode = $mode;
          $this->description = $description;
  
          $this->setDefault($default);
      }
  
      /**
       * Returns the argument name.
       *
       * @return string The argument name
       */
      public function getName()
      {
          return $this->name;
      }
  
      /**
       * Returns true if the argument is required.
       *
       * @return bool true if parameter mode is self::REQUIRED, false otherwise
       */
      public function isRequired()
      {
          return self::REQUIRED === (self::REQUIRED & $this->mode);
      }
  
      /**
       * Returns true if the argument can take multiple values.
       *
       * @return bool true if mode is self::IS_ARRAY, false otherwise
       */
      public function isArray()
      {
          return self::IS_ARRAY === (self::IS_ARRAY & $this->mode);
      }
  
      /**
       * Sets the default value.
       *
       * @param mixed $default The default value
       *
       * @throws \LogicException When incorrect default value is given
       */
      public function setDefault($default = null)
      {
          if (self::REQUIRED === $this->mode && null !== $default) {
              throw new \LogicException('Cannot set a default value except for InputArgument::OPTIONAL mode.');
          }
  
          if ($this->isArray()) {
              if (null === $default) {
                  $default = array();
              } elseif (!is_array($default)) {
                  throw new \LogicException('A default value for an array argument must be an array.');
              }
          }
  
          $this->default = $default;
      }
  
      /**
       * Returns the default value.
       *
       * @return mixed The default value
       */
      public function getDefault()
      {
          return $this->default;
      }
  
      /**
       * Returns the description text.
       *
       * @return string The description text
       */
      public function getDescription()
      {
          return $this->description;
      }
  }