Verzeichnisstruktur phpBB-3.2.0
- Veröffentlicht
- 06.01.2017
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 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 *
037 * @param string|array $values The values to look for in the raw parameters (can be an array)
038 *
039 * @return bool true if the value is contained in the raw parameters
040 */
041 public function hasParameterOption($values);
042
043 /**
044 * Returns the value of a raw option (not parsed).
045 *
046 * This method is to be used to introspect the input parameters
047 * before they have been validated. It must be used carefully.
048 *
049 * @param string|array $values The value(s) to look for in the raw parameters (can be an array)
050 * @param mixed $default The default value to return if no result is found
051 *
052 * @return mixed The option value
053 */
054 public function getParameterOption($values, $default = false);
055
056 /**
057 * Binds the current Input instance with the given arguments and options.
058 *
059 * @param InputDefinition $definition A InputDefinition instance
060 */
061 public function bind(InputDefinition $definition);
062
063 /**
064 * Validates the input.
065 *
066 * @throws RuntimeException When not enough arguments are given
067 */
068 public function validate();
069
070 /**
071 * Returns all the given arguments merged with the default values.
072 *
073 * @return array
074 */
075 public function getArguments();
076
077 /**
078 * Returns the argument value for a given argument name.
079 *
080 * @param string $name The argument name
081 *
082 * @return mixed The argument value
083 *
084 * @throws InvalidArgumentException When argument given doesn't exist
085 */
086 public function getArgument($name);
087
088 /**
089 * Sets an argument value by name.
090 *
091 * @param string $name The argument name
092 * @param string $value The argument value
093 *
094 * @throws InvalidArgumentException When argument given doesn't exist
095 */
096 public function setArgument($name, $value);
097
098 /**
099 * Returns true if an InputArgument object exists by name or position.
100 *
101 * @param string|int $name The InputArgument name or position
102 *
103 * @return bool true if the InputArgument object exists, false otherwise
104 */
105 public function hasArgument($name);
106
107 /**
108 * Returns all the given options merged with the default values.
109 *
110 * @return array
111 */
112 public function getOptions();
113
114 /**
115 * Returns the option value for a given option name.
116 *
117 * @param string $name The option name
118 *
119 * @return mixed The option value
120 *
121 * @throws InvalidArgumentException When option given doesn't exist
122 */
123 public function getOption($name);
124
125 /**
126 * Sets an option value by name.
127 *
128 * @param string $name The option name
129 * @param string|bool $value The option value
130 *
131 * @throws InvalidArgumentException When option given doesn't exist
132 */
133 public function setOption($name, $value);
134
135 /**
136 * Returns true if an InputOption object exists by name.
137 *
138 * @param string $name The InputOption name
139 *
140 * @return bool true if the InputOption object exists, false otherwise
141 */
142 public function hasOption($name);
143
144 /**
145 * Is this input means interactive?
146 *
147 * @return bool
148 */
149 public function isInteractive();
150
151 /**
152 * Sets the input interactivity.
153 *
154 * @param bool $interactive If the input should be interactive
155 */
156 public function setInteractive($interactive);
157 }
158