Overview

Namespaces

  • Webmozart
    • Console
      • Adapter
      • Api
        • Application
        • Args
          • Format
        • Command
        • Config
        • Event
        • Formatter
        • IO
        • Resolver
      • Args
      • Config
      • Formatter
      • Handler
        • Help
      • IO
        • InputStream
        • OutputStream
      • Process
      • Resolver
      • UI
        • Alignment
        • Component
        • Help
        • Layout
        • Style
      • Util

Classes

  • Args

Interfaces

  • ArgsParser
  • RawArgs

Exceptions

  • CannotAddArgumentException
  • CannotAddOptionException
  • CannotParseArgsException
  • NoSuchArgumentException
  • NoSuchOptionException
  • Overview
  • Namespace
  • Class

Interface ArgsParser

Parses raw console arguments and returns the parsed arguments.

Direct known implementers

Webmozart\Console\Args\DefaultArgsParser
Namespace: Webmozart\Console\Api\Args
Author: Bernhard Schussek bschussek@gmail.com
Since: 1.0
Located at Api/Args/ArgsParser.php
Methods summary
public Webmozart\Console\Api\Args\Args
# parseArgs( Webmozart\Console\Api\Args\RawArgs $args, Webmozart\Console\Api\Args\Format\ArgsFormat $format, boolean $lenient = false )

Parses the raw console arguments and returns the parsed arguments.

Parses the raw console arguments and returns the parsed arguments.

Parameters

$args
The raw console arguments.
$format
The argument format.
$lenient

Whether the parser should ignore parse errors. If true, the parser will not throw any exceptions when parse errors occur.

Returns

Webmozart\Console\Api\Args\Args
The parsed console arguments.

Throws

Webmozart\Console\Api\Args\CannotParseArgsException
If the arguments cannot be parsed.
Webmozart Console API API documentation generated by ApiGen