Documentation

Parser
in package

Table of Contents

parse()  : array<string|int, mixed>
parseLongOption()  : void
parseShortOption()  : void

Methods

parse()

public parse(array<string|int, mixed> $argv, string $shortOptions[, array<string|int, mixed> $longOptions = null ]) : array<string|int, mixed>
Parameters
$argv : array<string|int, mixed>
$shortOptions : string
$longOptions : array<string|int, mixed> = null
Tags
psalm-param

list $argv

psalm-param

list $longOptions

throws
AmbiguousOptionException
throws
RequiredOptionArgumentMissingException
throws
OptionDoesNotAllowArgumentException
throws
UnknownOptionException
Return values
array<string|int, mixed> —

parseLongOption()

private parseLongOption(string $arg, array<string|int, mixed> $longOptions, array<string|int, mixed> &$opts, array<string|int, mixed> &$args) : void
Parameters
$arg : string
$longOptions : array<string|int, mixed>
$opts : array<string|int, mixed>
$args : array<string|int, mixed>
Tags
psalm-param

list $longOptions

throws
AmbiguousOptionException
throws
RequiredOptionArgumentMissingException
throws
OptionDoesNotAllowArgumentException
throws
UnknownOptionException
Return values
void —

parseShortOption()

private parseShortOption(string $arg, string $shortOptions, array<string|int, mixed> &$opts, array<string|int, mixed> &$args) : void
Parameters
$arg : string
$shortOptions : string
$opts : array<string|int, mixed>
$args : array<string|int, mixed>
Tags
throws
RequiredOptionArgumentMissingException
Return values
void —

Search results