Classes List

Symfony\Component\Console\Input\InputInterface

 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 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
<?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;

use Symfony\Component\Console\Exception\InvalidArgumentException;
use Symfony\Component\Console\Exception\RuntimeException;

/** * InputInterface is the interface implemented by all input classes. * * @author Fabien Potencier <fabien@symfony.com> */
interface InputInterface
{
    /** * Returns the first argument from the raw parameters (not parsed). * * @return string|null The value of the first argument or null otherwise */
    public function getFirstArgument();

    /** * Returns true if the raw parameters (not parsed) contain a value. * * This method is to be used to introspect the input parameters * before they have been validated. It must be used carefully. * Does not necessarily return the correct result for short options * when multiple flags are combined in the same option. * * @param string|array $values The values to look for in the raw parameters (can be an array) * @param bool $onlyParams Only check real parameters, skip those following an end of options (--) signal * * @return bool true if the value is contained in the raw parameters */
    public function hasParameterOption($values$onlyParams = false);

    /** * Returns the value of a raw option (not parsed). * * This method is to be used to introspect the input parameters * before they have been validated. It must be used carefully. * Does not necessarily return the correct result for short options * when multiple flags are combined in the same option. * * @param string|array $values The value(s) to look for in the raw parameters (can be an array) * @param mixed $default The default value to return if no result is found * @param bool $onlyParams Only check real parameters, skip those following an end of options (--) signal * * @return mixed The option value */
    public function getParameterOption($values$default = false$onlyParams = false);

    /** * Binds the current Input instance with the given arguments and options. */
    public function bind(InputDefinition $definition);

    /** * Validates the input. * * @throws RuntimeException When not enough arguments are given */
    public function validate();

    /** * Returns all the given arguments merged with the default values. * * @return array */
    public function getArguments();

    /** * Returns the argument value for a given argument name. * * @param string $name The argument name * * @return mixed The argument value * * @throws InvalidArgumentException When argument given doesn't exist */
    public function getArgument($name);

    /** * Sets an argument value by name. * * @param string $name The argument name * @param string $value The argument value * * @throws InvalidArgumentException When argument given doesn't exist */
    public function setArgument($name$value);

    /** * Returns true if an InputArgument object exists by name or position. * * @param string|int $name The InputArgument name or position * * @return bool true if the InputArgument object exists, false otherwise */
    public function hasArgument($name);

    /** * Returns all the given options merged with the default values. * * @return array */
    public function getOptions();

    /** * Returns the option value for a given option name. * * @param string $name The option name * * @return mixed The option value * * @throws InvalidArgumentException When option given doesn't exist */
    public function getOption($name);

    /** * Sets an option value by name. * * @param string $name The option name * @param string|bool $value The option value * * @throws InvalidArgumentException When option given doesn't exist */
    public function setOption($name$value);

    /** * Returns true if an InputOption object exists by name. * * @param string $name The InputOption name * * @return bool true if the InputOption object exists, false otherwise */
    public function hasOption($name);

    /** * Is this input means interactive? * * @return bool */
    public function isInteractive();

    /** * Sets the input interactivity. * * @param bool $interactive If the input should be interactive */
    public function setInteractive($interactive);
}