interface StreamableInputInterface

StreamableInputInterface is the interface implemented by all input classes that have an input stream.

@author Robin Chalas <robin.chalas@gmail.com>

Hierarchy

Expanded class hierarchy of StreamableInputInterface

All classes that implement StreamableInputInterface

2 files declare their use of StreamableInputInterface
BufferIO.php in vendor/composer/composer/src/Composer/IO/BufferIO.php
QuestionHelper.php in vendor/symfony/console/Helper/QuestionHelper.php

File

vendor/symfony/console/Input/StreamableInputInterface.php, line 20

Namespace

Symfony\Component\Console\Input
View source 
interface StreamableInputInterface extends InputInterface {
    
    /**
     * Sets the input stream to read from when interacting with the user.
     *
     * This is mainly useful for testing purpose.
     *
     * @param resource $stream The input stream
     */
    public function setStream($stream) : void;
    
    /**
     * Returns the input stream.
     *
     * @return resource|null
     */
    public function getStream();

}

Members

Title Modifiers Object type Summary Overrides
InputInterface::bind public function Binds the current Input instance with the given arguments and options. 1
InputInterface::getArgument public function Returns the argument value for a given argument name. 1
InputInterface::getArguments public function Returns all the given arguments merged with the default values. 1
InputInterface::getFirstArgument public function Returns the first argument from the raw parameters (not parsed). 2
InputInterface::getOption public function Returns the option value for a given option name. 1
InputInterface::getOptions public function Returns all the given options merged with the default values. 1
InputInterface::getParameterOption public function Returns the value of a raw option (not parsed). 2
InputInterface::hasArgument public function Returns true if an InputArgument object exists by name or position. 1
InputInterface::hasOption public function Returns true if an InputOption object exists by name. 1
InputInterface::hasParameterOption public function Returns true if the raw parameters (not parsed) contain a value. 2
InputInterface::isInteractive public function Is this input means interactive? 1
InputInterface::setArgument public function Sets an argument value by name. 1
InputInterface::setInteractive public function Sets the input interactivity. 1
InputInterface::setOption public function Sets an option value by name. 1
InputInterface::validate public function Validates the input. 1
InputInterface::__toString public function Returns a stringified representation of the args passed to the command. 2
StreamableInputInterface::getStream public function Returns the input stream. 1
StreamableInputInterface::setStream public function Sets the input stream to read from when interacting with the user. 1