Class ArgvInput

ArgvInput represents an input coming from the CLI arguments.

Usage:
$input = new ArgvInput();

By default, the $_SERVER['argv'] array is used for the input values.

This can be overridden by explicitly passing the input values in the constructor:
$input = new ArgvInput($_SERVER['argv']);

If you pass it yourself, don't forget that the first element of the array is the name of the running application.

When passing an argument to the constructor, be sure that it respects the same rules as the argv one. It's almost always better to use the StringInput when you want to provide your own input.

Symfony\Component\Console\Input\Input implements Symfony\Component\Console\Input\InputInterface

Symfony\Component\Console\Input\ArgvInput

Direct known subclasses

Symfony\Component\Console\Input\StringInput

Namespace: Symfony\Component\Console\Input
Author: Fabien Potencier <fabien@symfony.com>
See: http://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html
See: http://www.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html#tag_12_02
Api
Located at laravel/vendor/Symfony/Component/Console/Input/ArgvInput.php

Methods summary
`public`	# `__construct( array $argv = null, Symfony\Component\Console\Input\InputDefinition $definition = null )` Constructor. Constructor. Parameters `$argv` `array` $argv An array of parameters from the CLI (in the argv format) `$definition` `Symfony\Component\Console\Input\InputDefinition` $definition A InputDefinition instance Api Overrides `Symfony\Component\Console\Input\Input::__construct()`
`protected`	# `setTokens( array $tokens )`
`protected`	# `parse( )` Processes command line arguments. Processes command line arguments.
`private`	# `parseShortOption( string $token )` Parses a short option. Parses a short option. Parameters `$token` `string` $token The current token.
`private`	# `parseShortOptionSet( string $name )` Parses a short option set. Parses a short option set. Parameters `$name` `string` $name The current token Throws `RuntimeException` When option given doesn't exist
`private`	# `parseLongOption( string $token )` Parses a long option. Parses a long option. Parameters `$token` `string` $token The current token
`private`	# `parseArgument( string $token )` Parses an argument. Parses an argument. Parameters `$token` `string` $token The current token Throws `RuntimeException` When too many arguments are given
`private`	# `addShortOption( string $shortcut, mixed $value )` Adds a short option value. Adds a short option value. Parameters `$shortcut` `string` $shortcut The short option key `$value` `mixed` $value The value for the option Throws `RuntimeException` When option given doesn't exist
`private`	# `addLongOption( string $name, mixed $value )` Adds a long option value. Adds a long option value. Parameters `$name` `string` $name The long option key `$value` `mixed` $value The value for the option Throws `RuntimeException` When option given doesn't exist
`public string`	# `getFirstArgument( )` Returns the first argument from the raw parameters (not parsed). Returns the first argument from the raw parameters (not parsed). Returns `string` The value of the first argument or null otherwise
`public Boolean`	# `hasParameterOption( string\|array $values )` Returns true if the raw parameters (not parsed) contain a value. 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. Parameters `$values` `string\|array` $values The value(s) to look for in the raw parameters (can be an array) Returns `Boolean` true if the value is contained in the raw parameters
`public mixed`	# `getParameterOption( string\|array $values, mixed $default = false )` Returns the value of a raw option (not parsed). 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. Parameters `$values` `string\|array` $values The value(s) to look for in the raw parameters (can be an array) `$default` `mixed` $default The default value to return if no result is found Returns `mixed` The option value

Methods inherited from Symfony\Component\Console\Input\Input
`bind(), getArgument(), getArguments(), getOption(), getOptions(), hasArgument(), hasOption(), isInteractive(), setArgument(), setInteractive(), setOption(), validate()`

Properties summary
`private mixed`	`$tokens`		#
`private mixed`	`$parsed`		#

Properties inherited from Symfony\Component\Console\Input\Input
`$arguments, $definition, $interactive, $options`

Namespaces

Classes

Interfaces

Class ArgvInput

Direct known subclasses

Parameters

Api

Overrides

Parameters

Parameters

Throws

Parameters

Parameters

Throws

Parameters

Throws

Parameters

Throws

Returns

Parameters

Returns

Parameters

Returns