Verzeichnisstruktur phpBB-3.3.15
- Veröffentlicht
- 28.08.2024
So funktioniert es
|
|
Auf das letzte Element klicken. Dies geht jeweils ein Schritt zurück |
Auf das Icon klicken, dies öffnet das Verzeichnis. Nochmal klicken schließt das Verzeichnis. |
|
|
(Beispiel Datei-Icons)
|
Auf das Icon klicken um den Quellcode anzuzeigen |
InputInterface.php
001 <?php
002
003 /*
004 * This file is part of the Symfony package.
005 *
006 * (c) Fabien Potencier <fabien@symfony.com>
007 *
008 * For the full copyright and license information, please view the LICENSE
009 * file that was distributed with this source code.
010 */
011
012 namespace Symfony\Component\Console\Input;
013
014 use Symfony\Component\Console\Exception\InvalidArgumentException;
015 use Symfony\Component\Console\Exception\RuntimeException;
016
017 /**
018 * InputInterface is the interface implemented by all input classes.
019 *
020 * @author Fabien Potencier <fabien@symfony.com>
021 */
022 interface InputInterface
023 {
024 /**
025 * Returns the first argument from the raw parameters (not parsed).
026 *
027 * @return string|null The value of the first argument or null otherwise
028 */
029 public function getFirstArgument();
030
031 /**
032 * Returns true if the raw parameters (not parsed) contain a value.
033 *
034 * This method is to be used to introspect the input parameters
035 * before they have been validated. It must be used carefully.
036 * Does not necessarily return the correct result for short options
037 * when multiple flags are combined in the same option.
038 *
039 * @param string|array $values The values to look for in the raw parameters (can be an array)
040 * @param bool $onlyParams Only check real parameters, skip those following an end of options (--) signal
041 *
042 * @return bool true if the value is contained in the raw parameters
043 */
044 public function hasParameterOption($values, $onlyParams = false);
045
046 /**
047 * Returns the value of a raw option (not parsed).
048 *
049 * This method is to be used to introspect the input parameters
050 * before they have been validated. It must be used carefully.
051 * Does not necessarily return the correct result for short options
052 * when multiple flags are combined in the same option.
053 *
054 * @param string|array $values The value(s) to look for in the raw parameters (can be an array)
055 * @param mixed $default The default value to return if no result is found
056 * @param bool $onlyParams Only check real parameters, skip those following an end of options (--) signal
057 *
058 * @return mixed The option value
059 */
060 public function getParameterOption($values, $default = false, $onlyParams = false);
061
062 /**
063 * Binds the current Input instance with the given arguments and options.
064 *
065 * @throws RuntimeException
066 */
067 public function bind(InputDefinition $definition);
068
069 /**
070 * Validates the input.
071 *
072 * @throws RuntimeException When not enough arguments are given
073 */
074 public function validate();
075
076 /**
077 * Returns all the given arguments merged with the default values.
078 *
079 * @return array
080 */
081 public function getArguments();
082
083 /**
084 * Returns the argument value for a given argument name.
085 *
086 * @param string $name The argument name
087 *
088 * @return string|string[]|null The argument value
089 *
090 * @throws InvalidArgumentException When argument given doesn't exist
091 */
092 public function getArgument($name);
093
094 /**
095 * Sets an argument value by name.
096 *
097 * @param string $name The argument name
098 * @param string|string[]|null $value The argument value
099 *
100 * @throws InvalidArgumentException When argument given doesn't exist
101 */
102 public function setArgument($name, $value);
103
104 /**
105 * Returns true if an InputArgument object exists by name or position.
106 *
107 * @param string|int $name The InputArgument name or position
108 *
109 * @return bool true if the InputArgument object exists, false otherwise
110 */
111 public function hasArgument($name);
112
113 /**
114 * Returns all the given options merged with the default values.
115 *
116 * @return array
117 */
118 public function getOptions();
119
120 /**
121 * Returns the option value for a given option name.
122 *
123 * @param string $name The option name
124 *
125 * @return string|string[]|bool|null The option value
126 *
127 * @throws InvalidArgumentException When option given doesn't exist
128 */
129 public function getOption($name);
130
131 /**
132 * Sets an option value by name.
133 *
134 * @param string $name The option name
135 * @param string|string[]|bool|null $value The option value
136 *
137 * @throws InvalidArgumentException When option given doesn't exist
138 */
139 public function setOption($name, $value);
140
141 /**
142 * Returns true if an InputOption object exists by name.
143 *
144 * @param string $name The InputOption name
145 *
146 * @return bool true if the InputOption object exists, false otherwise
147 */
148 public function hasOption($name);
149
150 /**
151 * Is this input means interactive?
152 *
153 * @return bool
154 */
155 public function isInteractive();
156
157 /**
158 * Sets the input interactivity.
159 *
160 * @param bool $interactive If the input should be interactive
161 */
162 public function setInteractive($interactive);
163 }
164