PHP Class Flitch\Cli\ArgumentParser

This is a PHP port of Arg_Parser, based on version 1.7.
See link: https://savannah.nongnu.org/projects/arg-parser/
Afficher le fichier Open project: dasprid/flitch Class Usage Examples

Protected Properties

Свойство Type Description
$error string Error during argument parsing.
$nonOptions array Parsed non-options.
$options array Parsed options.

Méthodes publiques

Méthode Description
__construct ( array $arguments, array $options ) : void Parse command line arguments.
getError ( ) : string Get parser error.
getNonOptions ( ) : array Get all parsed non-options.
getOptions ( ) : array Get all parsed options.

Méthodes protégées

Méthode Description
parseLongOption ( string $option, string $argument, array $options, integer &$argumentIndex ) : boolean Parse a long option.
parseShortOption ( string $option, string $argument, array $options, integer &$argumentIndex ) : boolean Parse a short option.

Method Details

__construct() public méthode

Parse command line arguments.
public __construct ( array $arguments, array $options ) : void
$arguments array
$options array
Résultat void

getError() public méthode

Get parser error.
public getError ( ) : string
Résultat string

getNonOptions() public méthode

Get all parsed non-options.
public getNonOptions ( ) : array
Résultat array

getOptions() public méthode

Get all parsed options.
public getOptions ( ) : array
Résultat array

parseLongOption() protected méthode

Parse a long option.
protected parseLongOption ( string $option, string $argument, array $options, integer &$argumentIndex ) : boolean
$option string
$argument string
$options array
$argumentIndex integer
Résultat boolean

parseShortOption() protected méthode

Parse a short option.
protected parseShortOption ( string $option, string $argument, array $options, integer &$argumentIndex ) : boolean
$option string
$argument string
$options array
$argumentIndex integer
Résultat boolean

Property Details

$error protected_oe property

Error during argument parsing.
protected string $error
Résultat string

$nonOptions protected_oe property

Parsed non-options.
protected array $nonOptions
Résultat array

$options protected_oe property

Parsed options.
protected array $options
Résultat array