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