Documentation

ArgvInput extends Input
in package

Application

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.

Properties

$arguments : mixed
$definition : mixed
$interactive : mixed
$options : mixed
$stream : resource
$parsed : array<string|int, mixed>
$tokens : array<string|int, mixed>

Methods

__construct() : mixed
__toString() : string: Returns a stringified representation of the args passed to the command.
bind() : void: Binds the current Input instance with the given arguments and options.
escapeToken() : string: Escapes a token through escapeshellarg if it contains unsafe chars.
getArgument() : mixed: Returns the argument value for a given argument name.
getArguments() : array<string|int, string|bool|int|float|array<string|int, mixed>|null>: Returns all the given arguments merged with the default values.
getFirstArgument() : string|null: Returns the first argument from the raw parameters (not parsed).
getOption() : mixed: Returns the option value for a given option name.
getOptions() : array<string|int, string|bool|int|float|array<string|int, mixed>|null>: Returns all the given options merged with the default values.
getParameterOption() : mixed: Returns the value of a raw option (not parsed).
getStream() : resource: Returns the input stream.
hasArgument() : bool: Returns true if an InputArgument object exists by name or position.
hasOption() : bool: Returns true if an InputOption object exists by name.
hasParameterOption() : bool: Returns true if the raw parameters (not parsed) contain a value.
isInteractive() : bool: Is this input means interactive?
setArgument() : void: Sets an argument value by name.
setInteractive() : void: Sets the input interactivity.
setOption() : void: Sets an option value by name.
setStream() : void: Sets the input stream to read from when interacting with the user.
validate() : void: Validates the input.
parse() : void: Processes command line arguments.
parseToken() : bool
setTokens() : void
addLongOption() : void: Adds a long option value.
addShortOption() : void: Adds a short option value.
parseArgument() : void: Parses an argument.
parseLongOption() : void: Parses a long option.
parseShortOption() : void: Parses a short option.
parseShortOptionSet() : void: Parses a short option set.

$arguments


    protected
        mixed
    $arguments
     = []

$definition


    protected
        mixed
    $definition

$interactive


    protected
        mixed
    $interactive
     = true

$options


    protected
        mixed
    $options
     = []

$stream


    protected
        resource
    $stream

$parsed


    private
        array<string|int, mixed>
    $parsed

$tokens


    private
        array<string|int, mixed>
    $tokens

__construct()


    public
                    __construct([array<string|int, mixed>|null $argv = null ][, InputDefinition|null $definition = null ]) : mixed

Parameters

$argv : array<string|int, mixed>|null = null
$definition : InputDefinition|null = null

__toString()

Returns a stringified representation of the args passed to the command.


    public
                    __toString() : string

Return values

string

bind()

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


    public
                    bind(InputDefinition $definition) : void

Parameters

$definition : InputDefinition

escapeToken()

Escapes a token through escapeshellarg if it contains unsafe chars.


    public
                    escapeToken(string $token) : string

Parameters

$token : string

Return values

string

getArgument()

Returns the argument value for a given argument name.


    public
                    getArgument(string $name) : mixed

Parameters

$name : string

getArguments()

Returns all the given arguments merged with the default values.


    public
                    getArguments() : array<string|int, string|bool|int|float|array<string|int, mixed>|null>

Return values

getFirstArgument()

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


    public
                    getFirstArgument() : string|null

Return values

string|null

getOption()

Returns the option value for a given option name.


    public
                    getOption(string $name) : mixed

Parameters

$name : string

getOptions()

Returns all the given options merged with the default values.


    public
                    getOptions() : array<string|int, string|bool|int|float|array<string|int, mixed>|null>

Return values

getParameterOption()

Returns the value of a raw option (not parsed).


    public
                    getParameterOption(string|array<string|int, mixed> $values[, string|bool|int|float|array<string|int, mixed>|null $default = false ][, bool $onlyParams = false ]) : mixed

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.

Parameters

$values : string|array<string|int, mixed>: The value(s) to look for in the raw parameters (can be an array)
$default : string|bool|int|float|array<string|int, mixed>|null = false: The default value to return if no result is found
$onlyParams : bool = false: Only check real parameters, skip those following an end of options (--) signal

getStream()

Returns the input stream.


    public
                    getStream() : resource

Return values

resource

hasArgument()

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


    public
                    hasArgument(string $name) : bool

Parameters

$name : string

Return values

bool

hasOption()

Returns true if an InputOption object exists by name.


    public
                    hasOption(string $name) : bool

Parameters

$name : string

Return values

bool

hasParameterOption()

Returns true if the raw parameters (not parsed) contain a value.


    public
                    hasParameterOption(string|array<string|int, mixed> $values[, bool $onlyParams = false ]) : bool

Parameters

$values : string|array<string|int, mixed>: The values to look for in the raw parameters (can be an array)
$onlyParams : bool = false: Only check real parameters, skip those following an end of options (--) signal

Return values

bool

isInteractive()

Is this input means interactive?


    public
                    isInteractive() : bool

Return values

bool

setArgument()

Sets an argument value by name.


    public
                    setArgument(string $name, mixed $value) : void

Parameters

$name : string
$value : mixed

setInteractive()

Sets the input interactivity.


    public
                    setInteractive(bool $interactive) : void

Parameters

$interactive : bool

setOption()

Sets an option value by name.


    public
                    setOption(string $name, mixed $value) : void

Parameters

$name : string
$value : mixed

setStream()

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


    public
                    setStream(resource $stream) : void

Parameters

$stream : resource

validate()

Validates the input.


    public
                    validate() : void

parse()

Processes command line arguments.


    protected
                    parse() : void

parseToken()


    protected
                    parseToken(string $token, bool $parseOptions) : bool

Parameters

$token : string
$parseOptions : bool

Return values

bool

setTokens()


    protected
                    setTokens(array<string|int, mixed> $tokens) : void

Parameters

$tokens : array<string|int, mixed>

addLongOption()

Adds a long option value.


    private
                    addLongOption(string $name, mixed $value) : void

Parameters

$name : string
$value : mixed

addShortOption()

Adds a short option value.


    private
                    addShortOption(string $shortcut, mixed $value) : void

Parameters

$shortcut : string
$value : mixed

parseArgument()

Parses an argument.


    private
                    parseArgument(string $token) : void

Parameters

$token : string

parseLongOption()

Parses a long option.


    private
                    parseLongOption(string $token) : void

Parameters

$token : string

parseShortOption()

Parses a short option.


    private
                    parseShortOption(string $token) : void

Parameters

$token : string

parseShortOptionSet()

Parses a short option set.


    private
                    parseShortOptionSet(string $name) : void

Parameters

$name : string

ArgvInput extends Input in package Application

Tags

Table of Contents

Properties

Methods

Properties

$arguments

$definition

$interactive

$options

$stream

$parsed

$tokens

Methods

__construct()

Parameters

__toString()

Return values

bind()

Parameters

escapeToken()

Parameters

Return values

getArgument()

Parameters

getArguments()

Return values

getFirstArgument()

Return values

getOption()

Parameters

getOptions()

Return values

getParameterOption()

Parameters

getStream()

Return values

hasArgument()

Parameters

Return values

hasOption()

Parameters

Return values

hasParameterOption()

Parameters

Return values

isInteractive()

Return values

setArgument()

Parameters

setInteractive()

Parameters

setOption()

Parameters

setStream()

Parameters

validate()

parse()

parseToken()

Parameters

Return values

setTokens()

Parameters

addLongOption()

Parameters

Tags

addShortOption()

Parameters

Tags

parseArgument()

Parameters

Tags

parseLongOption()

Parameters

parseShortOption()

Parameters

parseShortOptionSet()

Parameters

Tags

ArgvInput extends Input
in package

Application