Copied!

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

AbstractInterface
Methods
public abstract Symfony\Component\Console\Input\InputInterface::__toString() : string
 

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 abstract Symfony\Component\Console\Input\InputInterface::bind(Symfony\Component\Console\Input\InputDefinition $definition) : void
 

Binds the current Input instance with the given arguments and options.

  • throws \RuntimeException
public abstract Symfony\Component\Console\Input\InputInterface::getArgument(string $name) : ?mixed
 

Returns the argument value for a given argument name.

  • throws \InvalidArgumentException When argument given doesn't exist
public abstract Symfony\Component\Console\Input\InputInterface::getArguments() : array
 

Returns all the given arguments merged with the default values.

  • return (string|bool|int|float|array|null)[]
public abstract Symfony\Component\Console\Input\InputInterface::getFirstArgument() : ?string
 

Returns the first argument from the raw parameters (not parsed).

public abstract Symfony\Component\Console\Input\InputInterface::getOption(string $name) : ?mixed
 

Returns the option value for a given option name.

  • throws \InvalidArgumentException When option given doesn't exist
public abstract Symfony\Component\Console\Input\InputInterface::getOptions() : array
 

Returns all the given options merged with the default values.

  • return (string|bool|int|float|array|null)[]
public abstract Symfony\Component\Console\Input\InputInterface::getParameterOption(array|string $values, array|string|int|float|bool|?null $default = false, bool $onlyParams = false) : ?mixed
 

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 abstract getStream()
 

Returns the input stream.

  • return resource|null
public abstract Symfony\Component\Console\Input\InputInterface::hasArgument(string $name) : bool
 

Returns true if an InputArgument object exists by name or position.

public abstract Symfony\Component\Console\Input\InputInterface::hasOption(string $name) : bool
 

Returns true if an InputOption object exists by name.

public abstract Symfony\Component\Console\Input\InputInterface::hasParameterOption(array|string $values, bool $onlyParams = false) : bool
 

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 abstract Symfony\Component\Console\Input\InputInterface::isInteractive() : bool
 

Is this input means interactive?

public abstract Symfony\Component\Console\Input\InputInterface::setArgument(string $name, ?mixed $value) : void
 

Sets an argument value by name.

  • throws \InvalidArgumentException When argument given doesn't exist
public abstract Symfony\Component\Console\Input\InputInterface::setInteractive(bool $interactive) : void
 

Sets the input interactivity.

public abstract Symfony\Component\Console\Input\InputInterface::setOption(string $name, ?mixed $value) : void
 

Sets an option value by name.

  • throws \InvalidArgumentException When option given doesn't exist
public abstract setStream( $stream) : void
 

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 abstract Symfony\Component\Console\Input\InputInterface::validate() : void
 

Validates the input.

  • throws \RuntimeException When not enough arguments are given
© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration