PEAR Handbuch
ZurückNach vorne

Console_Getopt

Console_Getopt -- Command-line options parsing class

Console_Getopt::readPHPArgv

array readPHPArgv ()

Safely read the $argv PHP array across different PHP configurations. Will take care on register_globals and register_argc_argv ini directives

Returns

Beispiel 1. Using

$con  = new Console_Getopt;
$args = $con->readPHPArgv();
array_shift($args);
$options = $con->getopt( $args, $shortopt);

Console_Getopt::getopt

array getopt (string $args, string $shortoptions [, array $longoptions])

parses the command-line options

Parameter

Returns

Options

Getopt() support two types of options: short options and long options

Beispiel 2. Calling a script with short and long options

# Using short options
myphpscript -q -l en -o
# Using long options instead
myphpscript --quite --lang=en --option
# Mixing both
myphpscript -q --lang=en -o
You have to define which options you want to support. The second argument of getopt() requires a string containing all supported chars. For the example above this would be at least: 
$shortoptions = "qlo";
The order of the chars isn't important. Often you have to define options with (optional) parameters. To express, that a option requires a parameter, you have to add a colon. If the parameter is optional add a double colon, ie: 
$shortoptions = "ql:o::";
this means the following script calls are permitted, ie. 
myphpscript 
myphpscript -q
myphpscript -q -l en 
myphpscript -o text 
myphpscript -o
not permitted would be: 
myphpscript -l
The -l option requires a parameter, if the option is used.

The long options work equal, but you have to define them in an array 
$longoptions = array("quite", "lang", "option");
For defining option parameters, use '=' and '==' like the colon in short options. 
$longoptions = array("quite", "lang=", "option==");

The returned array

The return value is an array of two elements: the list of parsed options and the list of non-option command-line arguments. Each entry in the list of parsed options is a pair of elements - the first one specifies the option, and the second one specifies the option argument, if there was one, else the value is NULL.

ZurückZum AnfangNach vorne
PEAR ConsoleNach obenPEAR DB: a unified API for accessing SQL-databases