Gitee
\
App
HttpController
Api
Lib
Process
Redis
Composer
Autoload
CaBundle
Command
Config
Console
DependencyResolver
Operation
Downloader
EventDispatcher
Exception
Installer
IO
Json
Package
Archiver
Comparer
Dumper
LinkConstraint
Loader
Version
Plugin
Capability
Question
Repository
Pear
Vcs
Script
SelfUpdate
Semver
Constraint
Spdx
Util
XdebugHandler
Cron
Tests
EasySwoole
FastRoute
DataGenerator
Dispatcher
RouteParser
JsonSchema
Constraints
TypeCheck
Entity
Exception
Iterator
Uri
Retrievers
PhpParser
Builder
Comment
ErrorHandler
Lexer
Node
Expr
AssignOp
BinaryOp
Cast
Name
Scalar
MagicConst
Stmt
TraitUseAdaptation
NodeVisitor
Parser
PrettyPrinter
Serializer
Unserializer
Psr
Log
Test
Seld
JsonLint
PharUtils
SuperClosure
Analyzer
Visitor
Exception
Swoole
Connection
Coroutine
Http
Http2
Mysql
Http
Http2
Mysql
Redis
Server
WebSocket
Symfony
Component
Console
Command
CommandLoader
DependencyInjection
Descriptor
Event
EventListener
Exception
Formatter
Helper
Input
Logger
Output
Question
Style
Tester
Tests
Command
CommandLoader
DependencyInjection
Descriptor
EventListener
Fixtures
Formatter
Helper
Input
Logger
Output
Style
Tester
Filesystem
Exception
Tests
Fixtures
MockStream
Finder
Comparator
Exception
Iterator
Tests
Comparator
Iterator
Process
Exception
Pipes
Tests
Polyfill
Ctype
Mbstring
Php56
Util

\Symfony\Component\Console\Tests\EventListenerNonStringInput

Input is the base class for all concrete Input classes.

Three concrete classes are provided by default:

  • ArgvInput: The input comes from the CLI arguments (argv)
  • StringInput: The input is provided as a string
  • ArrayInput: The input is provided as an array

Summary

Methods
Properties
Constants
__construct()
bind()
parse()
validate()
isInteractive()
setInteractive()
getArguments()
getArgument()
setArgument()
hasArgument()
getOptions()
getOption()
setOption()
hasOption()
escapeToken()
setStream()
getStream()
getFirstArgument()
hasParameterOption()
getParameterOption()
No public properties found
No constants found
No protected methods found
$definition
$stream
$options
$arguments
$interactive
N/A
No private methods found
No private properties found
N/A

Properties

$definition

$definition :

Type

$stream

$stream :

Type

$options

$options :

Type

$arguments

$arguments :

Type

$interactive

$interactive :

Type

Methods

parse()

parse()

Processes command line arguments.

validate()

validate()

Validates the input.

isInteractive()

isInteractive() : boolean

Is this input means interactive?

Returns

boolean

setInteractive()

setInteractive(boolean  $interactive)

Sets the input interactivity.

Parameters

boolean $interactive

If the input should be interactive

getArguments()

getArguments() : array

Returns all the given arguments merged with the default values.

Returns

array

getArgument()

getArgument(string  $name) : string|array<mixed,string>|null

Returns the argument value for a given argument name.

Parameters

string $name

The argument name

Returns

string|array<mixed,string>|null —

The argument value

setArgument()

setArgument(string  $name, string|array<mixed,string>|null  $value)

Sets an argument value by name.

Parameters

string $name

The argument name
string|array<mixed,string>|null $value

The argument value

hasArgument()

hasArgument(string|integer  $name) : boolean

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

Parameters

string|integer $name

The InputArgument name or position

Returns

boolean —

true if the InputArgument object exists, false otherwise

getOptions()

getOptions() : array

Returns all the given options merged with the default values.

Returns

array

getOption()

getOption(string  $name) : string|array<mixed,string>|boolean|null

Returns the option value for a given option name.

Parameters

string $name

The option name

Returns

string|array<mixed,string>|boolean|null —

The option value

setOption()

setOption(string  $name, string|array<mixed,string>|boolean|null  $value)

Sets an option value by name.

Parameters

string $name

The option name
string|array<mixed,string>|boolean|null $value

The option value

hasOption()

hasOption(string  $name) : boolean

Returns true if an InputOption object exists by name.

Parameters

string $name

The InputOption name

Returns

boolean —

true if the InputOption object exists, false otherwise

escapeToken()

escapeToken(string  $token) : string

Escapes a token through escapeshellarg if it contains unsafe chars.

Parameters

string $token

Returns

string

setStream()

setStream(resource  $stream)

Sets the input stream to read from when interacting with the user.

This is mainly useful for testing purpose.

Parameters

resource $stream

The input stream

getStream()

getStream() : resource|null

Returns the input stream.

Returns

resource|null

getFirstArgument()

getFirstArgument()

hasParameterOption()

hasParameterOption(  $values,   $onlyParams = false)

Parameters

$values
$onlyParams

getParameterOption()

getParameterOption(  $values,   $default = false,   $onlyParams = false)

Parameters

$values
$default
$onlyParams