[ Index ]

PHP Cross Reference of phpBB-3.1.12-deutsch

title

Body

[close]

/vendor/symfony/console/Symfony/Component/Console/Input/ -> Input.php (summary)

Input is the base class for all concrete Input classes. Three concrete classes are provided by default:

Author: Fabien Potencier <fabien@symfony.com>
File Size: 232 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 14 functions

  __construct()
  bind()
  validate()
  isInteractive()
  setInteractive()
  getArguments()
  getArgument()
  setArgument()
  hasArgument()
  getOptions()
  getOption()
  setOption()
  hasOption()
  escapeToken()

Functions
Functions that are not part of a class:

__construct(InputDefinition $definition = null)   X-Ref
Constructor.

param: InputDefinition $definition A InputDefinition instance

bind(InputDefinition $definition)   X-Ref
Binds the current Input instance with the given arguments and options.

param: InputDefinition $definition A InputDefinition instance

validate()   X-Ref
Validates the input.


isInteractive()   X-Ref
Checks if the input is interactive.

return: bool Returns true if the input is interactive

setInteractive($interactive)   X-Ref
Sets the input interactivity.

param: bool $interactive If the input should be interactive

getArguments()   X-Ref
Returns the argument values.

return: array An array of argument values

getArgument($name)   X-Ref
Returns the argument value for a given argument name.

param: string $name The argument name
return: mixed The argument value

setArgument($name, $value)   X-Ref
Sets an argument value by name.

param: string $name  The argument name
param: string $value The argument value

hasArgument($name)   X-Ref
Returns true if an InputArgument object exists by name or position.

param: string|int $name The InputArgument name or position
return: bool true if the InputArgument object exists, false otherwise

getOptions()   X-Ref
Returns the options values.

return: array An array of option values

getOption($name)   X-Ref
Returns the option value for a given option name.

param: string $name The option name
return: mixed The option value

setOption($name, $value)   X-Ref
Sets an option value by name.

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

hasOption($name)   X-Ref
Returns true if an InputOption object exists by name.

param: string $name The InputOption name
return: bool true if the InputOption object exists, false otherwise

escapeToken($token)   X-Ref
Escapes a token through escapeshellarg if it contains unsafe chars.

param: string $token
return: string



Generated: Thu Jan 11 00:25:41 2018 Cross-referenced by PHPXref 0.7.1