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

  • DefaultResolver
  • ResolveResult
  • Overview
  • Namespace
  • Class

Class ResolveResult

An intermediate result created during resolving.

Namespace: Webmozart\Console\Resolver
Author: Bernhard Schussek bschussek@gmail.com
Since: 1.0
Located at Resolver/ResolveResult.php
Methods summary
public
# __construct( Webmozart\Console\Api\Command\Command $command, Webmozart\Console\Api\Args\RawArgs $rawArgs )

Creates a new resolved command.

Creates a new resolved command.

Parameters

$command
The command.
$rawArgs
The raw console arguments.
public Webmozart\Console\Api\Command\Command
# getCommand( )

Returns the command.

Returns the command.

Returns

Webmozart\Console\Api\Command\Command
The command.
public Webmozart\Console\Api\Args\RawArgs
# getRawArgs( )

The raw console arguments.

The raw console arguments.

Returns

Webmozart\Console\Api\Args\RawArgs
The raw console arguments.
public Webmozart\Console\Api\Args\Args
# getParsedArgs( )

Returns the parsed console arguments.

Returns the parsed console arguments.

Returns

Webmozart\Console\Api\Args\Args

The parsed console arguments or null if the console arguments cannot be parsed.

See

Webmozart\Console\Resolver\ResolveResult::isParsable(), Webmozart\Console\Resolver\ResolveResult::getParseError()
public Webmozart\Console\Api\Args\CannotParseArgsException
# getParseError( )

Returns the error that happened during argument parsing.

Returns the error that happened during argument parsing.

Returns

Webmozart\Console\Api\Args\CannotParseArgsException

The parse error or null if the arguments were parsed successfully.

See

Webmozart\Console\Resolver\ResolveResult::isParsable(), Webmozart\Console\Resolver\ResolveResult::getParsedArgs()
public boolean
# isParsable( )

Returns whether the console arguments can be parsed.

Returns whether the console arguments can be parsed.

Returns

boolean

Returns true if the console arguments can be parsed and false if a parse error occurred.

See

Webmozart\Console\Resolver\ResolveResult::getParsedArgs(), Webmozart\Console\Resolver\ResolveResult::getParseError()
Webmozart Console API API documentation generated by ApiGen