Input Class Reference

Inheritance diagram for Input:

Public Member Functions
	__construct (InputDefinition $definition=null)
	bind (InputDefinition $definition)
	validate ()
	isInteractive ()
	setInteractive ($interactive)
	getArguments ()
	getArgument ($name)
	setArgument ($name, $value)
	hasArgument ($name)
	getOptions ()
	getOption ($name)
	setOption ($name, $value)
	hasOption ($name)
	escapeToken ($token)
Public Member Functions inherited from InputInterface
	getFirstArgument ()
	hasParameterOption ($values)
	getParameterOption ($values, $default=false)

Protected Member Functions
	parse ()

Protected Attributes
	$definition
	$options = array()
	$arguments = array()
	$interactive = true

Detailed Description

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

Author

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 25 of file Input.php.

Constructor & Destructor Documentation

__construct

(

InputDefinition

$definition = null

)

Constructor.

Parameters

InputDefinition

$definition

A InputDefinition instance

Definition at line 40 of file Input.php.

References Input\$definition, Input\bind(), and Input\validate().

Member Function Documentation

bind

(

InputDefinition

$definition

)

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

Parameters

InputDefinition

$definition

A InputDefinition instance

Implements InputInterface.

Definition at line 55 of file Input.php.

References Input\$definition, and Input\parse().

Referenced by Input\__construct(), and StringInput\__construct().

escapeToken

(

$token

)

Escapes a token through escapeshellarg if it contains unsafe chars.

Parameters

string

$token

Returns

string

Definition at line 222 of file Input.php.

Referenced by ArrayInput\__toString().

getArgument

(

$name

)

Returns the argument value for a given argument name.

Parameters

string

$name

The argument name

Returns

mixed The argument value

Exceptions

\InvalidArgumentException

When argument given doesn't exist

Implements InputInterface.

Definition at line 120 of file Input.php.

getArguments

(

)

Returns the argument values.

Returns

array An array of argument values

Implements InputInterface.

Definition at line 106 of file Input.php.

References Input\$arguments.

getOption

(

$name

)

Returns the option value for a given option name.

Parameters

string

$name

The option name

Returns

mixed The option value

Exceptions

\InvalidArgumentException

When option given doesn't exist

Implements InputInterface.

Definition at line 177 of file Input.php.

getOptions

(

)

Returns the options values.

Returns

array An array of option values

Implements InputInterface.

Definition at line 163 of file Input.php.

References Input\$options.

hasArgument

(

$name

)

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

Parameters

string | int

$name

The InputArgument name or position

Returns

bool true if the InputArgument object exists, false otherwise

Implements InputInterface.

Definition at line 153 of file Input.php.

hasOption

(

$name

)

Returns true if an InputOption object exists by name.

Parameters

string

$name

The InputOption name

Returns

bool true if the InputOption object exists, false otherwise

Implements InputInterface.

Definition at line 210 of file Input.php.

isInteractive

(

)

Checks if the input is interactive.

Returns

bool Returns true if the input is interactive

Implements InputInterface.

Definition at line 86 of file Input.php.

References Input\$interactive.

parse ( )

abstractprotected

Processes command line arguments.

Referenced by Input\bind().

setArgument	(		$name,
			$value
	)

Sets an argument value by name.

Parameters

string	$name	The argument name
string	$value	The argument value

Exceptions

\InvalidArgumentException

When argument given doesn't exist

Implements InputInterface.

Definition at line 137 of file Input.php.

setInteractive

(

$interactive

)

Sets the input interactivity.

Parameters

bool

$interactive

If the input should be interactive

Implements InputInterface.

Definition at line 96 of file Input.php.

References Input\$interactive.

setOption	(		$name,
			$value
	)

Sets an option value by name.

Parameters

string	$name	The option name
string | bool	$value	The option value

Exceptions

\InvalidArgumentException

When option given doesn't exist

Implements InputInterface.

Definition at line 194 of file Input.php.

validate

(

)

Validates the input.

Exceptions

\RuntimeException

When not enough arguments are given

Implements InputInterface.

Definition at line 74 of file Input.php.

Referenced by Input\__construct().

Member Data Documentation

$arguments = array()

protected

Definition at line 32 of file Input.php.

Referenced by Input\getArguments().

$definition

protected

Definition at line 30 of file Input.php.

Referenced by ArrayInput\__construct(), StringInput\__construct(), Input\__construct(), ArgvInput\__construct(), and Input\bind().

$interactive = true

protected

Definition at line 33 of file Input.php.

Referenced by Input\isInteractive(), and Input\setInteractive().

$options = array()

protected

Definition at line 31 of file Input.php.

Referenced by Input\getOptions().