Copied!

InputInterface is the interface implemented by all input classes.

Abstract Interface
Methods
public abstract bind ( Symfony\Component\Console\Input\InputDefinition $definition )
 

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

  • throws RuntimeException
public abstract getArgument ( string $name )
 

Returns the argument value for a given argument name.

  • return mixed
  • throws InvalidArgumentException When argument given doesn't exist
public abstract getArguments () : array
 

Returns all the given arguments merged with the default values.

  • return (string | bool | int | float | array | null) []
public abstract getFirstArgument () : ? string
 

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

public abstract getOption ( string $name )
 

Returns the option value for a given option name.

  • return mixed
  • throws InvalidArgumentException When option given doesn't exist
public abstract getOptions () : array
 

Returns all the given options merged with the default values.

  • return (string | bool | int | float | array | null) []
public abstract getParameterOption ( array | string $values , array | string | int | float | bool | null $default = false , bool $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 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
  • return mixed
public abstract hasArgument ( string $name ) : bool
 

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

public abstract hasOption ( string $name ) : bool
 

Returns true if an InputOption object exists by name.

public abstract 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 isInteractive () : bool
 

Is this input means interactive?

public abstract setArgument ( string $name , ? mixed $value )
 

Sets an argument value by name.

  • throws InvalidArgumentException When argument given doesn't exist
public abstract setInteractive ( bool $interactive )
 

Sets the input interactivity.

public abstract setOption ( string $name , ? mixed $value )
 

Sets an option value by name.

  • throws InvalidArgumentException When option given doesn't exist
public abstract validate ()
 

Validates the input.

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