Initial Drupal 11 with DDEV setup
This commit is contained in:
		
							
								
								
									
										138
									
								
								vendor/symfony/console/Input/InputInterface.php
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										138
									
								
								vendor/symfony/console/Input/InputInterface.php
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@ -0,0 +1,138 @@
 | 
			
		||||
<?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).
 | 
			
		||||
     */
 | 
			
		||||
    public function getFirstArgument(): ?string;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * 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
 | 
			
		||||
     */
 | 
			
		||||
    public function hasParameterOption(string|array $values, bool $onlyParams = false): bool;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * 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 string|bool|int|float|array|null $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
 | 
			
		||||
     */
 | 
			
		||||
    public function getParameterOption(string|array $values, string|bool|int|float|array|null $default = false, bool $onlyParams = false): mixed;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Binds the current Input instance with the given arguments and options.
 | 
			
		||||
     *
 | 
			
		||||
     * @throws RuntimeException
 | 
			
		||||
     */
 | 
			
		||||
    public function bind(InputDefinition $definition): void;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Validates the input.
 | 
			
		||||
     *
 | 
			
		||||
     * @throws RuntimeException When not enough arguments are given
 | 
			
		||||
     */
 | 
			
		||||
    public function validate(): void;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns all the given arguments merged with the default values.
 | 
			
		||||
     *
 | 
			
		||||
     * @return array<string|bool|int|float|array|null>
 | 
			
		||||
     */
 | 
			
		||||
    public function getArguments(): array;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns the argument value for a given argument name.
 | 
			
		||||
     *
 | 
			
		||||
     * @throws InvalidArgumentException When argument given doesn't exist
 | 
			
		||||
     */
 | 
			
		||||
    public function getArgument(string $name): mixed;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Sets an argument value by name.
 | 
			
		||||
     *
 | 
			
		||||
     * @throws InvalidArgumentException When argument given doesn't exist
 | 
			
		||||
     */
 | 
			
		||||
    public function setArgument(string $name, mixed $value): void;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns true if an InputArgument object exists by name or position.
 | 
			
		||||
     */
 | 
			
		||||
    public function hasArgument(string $name): bool;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns all the given options merged with the default values.
 | 
			
		||||
     *
 | 
			
		||||
     * @return array<string|bool|int|float|array|null>
 | 
			
		||||
     */
 | 
			
		||||
    public function getOptions(): array;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns the option value for a given option name.
 | 
			
		||||
     *
 | 
			
		||||
     * @throws InvalidArgumentException When option given doesn't exist
 | 
			
		||||
     */
 | 
			
		||||
    public function getOption(string $name): mixed;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Sets an option value by name.
 | 
			
		||||
     *
 | 
			
		||||
     * @throws InvalidArgumentException When option given doesn't exist
 | 
			
		||||
     */
 | 
			
		||||
    public function setOption(string $name, mixed $value): void;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns true if an InputOption object exists by name.
 | 
			
		||||
     */
 | 
			
		||||
    public function hasOption(string $name): bool;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Is this input means interactive?
 | 
			
		||||
     */
 | 
			
		||||
    public function isInteractive(): bool;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Sets the input interactivity.
 | 
			
		||||
     */
 | 
			
		||||
    public function setInteractive(bool $interactive): void;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns a stringified representation of the args passed to the command.
 | 
			
		||||
     *
 | 
			
		||||
     * InputArguments MUST be escaped as well as the InputOption values passed to the command.
 | 
			
		||||
     */
 | 
			
		||||
    public function __toString(): string;
 | 
			
		||||
}
 | 
			
		||||
		Reference in New Issue
	
	Block a user