Overview

Namespaces

  • Contrib
    • Bundle
      • CoverallsBundle
        • Console
        • Entity
      • CoverallsV1Bundle
        • Api
        • Collector
        • Command
        • Config
        • Entity
          • Git
    • Component
      • File
      • Log
      • System
        • Git
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP
  • Psr
    • Log
  • Symfony
    • Component
      • Config
        • Definition
          • Builder
          • Exception
        • Exception
        • Loader
        • Resource
        • Util
      • Console
        • Command
        • Formatter
        • Helper
        • Input
        • Output
        • Tester
      • EventDispatcher
        • Debug
      • Finder
        • Adapter
        • Comparator
        • Exception
        • Expression
        • Iterator
        • Shell
      • Stopwatch
      • Yaml
        • Exception

Classes

  • ArgvInput
  • ArrayInput
  • Input
  • InputArgument
  • InputDefinition
  • InputOption
  • StringInput

Interfaces

  • InputInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Class ArrayInput

ArrayInput represents an input provided as an array.

Usage:
$input = new ArrayInput(array('name' => 'foo', '--bar' => 'foobar'));

Symfony\Component\Console\Input\Input implements Symfony\Component\Console\Input\InputInterface
Extended by Symfony\Component\Console\Input\ArrayInput
Namespace: Symfony\Component\Console\Input
Author: Fabien Potencier <fabien@symfony.com>
Api
Located at console/Symfony/Component/Console/Input/ArrayInput.php
Methods summary
public
# __construct( array $parameters, Symfony\Component\Console\Input\InputDefinition $definition = null )

Constructor.

Constructor.

Parameters

$parameters
array
$parameters An array of parameters
$definition
Symfony\Component\Console\Input\InputDefinition
$definition A InputDefinition instance

Api

Overrides

Symfony\Component\Console\Input\Input::__construct()
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 values 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
protected
# parse( )

Processes command line arguments.

Processes command line arguments.

Methods inherited from Symfony\Component\Console\Input\Input
bind(), getArgument(), getArguments(), getOption(), getOptions(), hasArgument(), hasOption(), isInteractive(), setArgument(), setInteractive(), setOption(), validate()
Properties inherited from Symfony\Component\Console\Input\Input
$arguments, $definition, $interactive, $options
php-coveralls API documentation generated by ApiGen 2.8.0