PEAR Manual
Prev |  | Next

# Console_Getopt::readPHPArgv

Console_Getopt::readPHPArgv -- read the predefined $argv array

## Synopsis

    require_once 'Console/Getopt.php';

``array readPHPArgv` ()`

## Description

Reads the $argv PHP array across different PHP configurations. Will take care of the register_globals and register_argc_argv ini directives.

## Return value

`array` - array containing the options and parameters or PEAR_Error

## Throws

Table 32-1. Possible PEAR_Error values

Error code | Error message | Reason | Solution
--- | --- | --- | ---
`NULL` | "Console_Getopt: Could not read cmd args (register_argc_argv=Off?)" | PHP does not provide the command-line arguments for the script. | Check "register_argc_argv" in your php.ini

## Note

This function can not be called statically.

## Example

Example 32-1. Using readPHPArgv()
    $con  = new Console_Getopt;
    $args = $con->readPHPArgv();
    array_shift($args);
    $options = $con->getopt2($args, $shortopt);

Prev | Home | Next
Console_Getopt::getopt | Up | Console_Table