PEAR Manual
Prev |  | Next

# DB_common::getListOf()

DB_common::getListOf() -- Views database system information

## Synopsis

``array getListOf` (string $type)`

## Description

Retrieves information about database users, avaible databases, views and functions.

## Parameter

string `$type`

  type of requested info, valid values for `$type` are database dependent, ie: `tables`, `databases`, `users`, `view`, `functions`

## Return value

array - an ordered array containing the requested data or a DB_Error object on failure

## Throws

Table 33-1. Possible PEAR_Error values

Error code | Error message | Reason | Solution
--- | --- | --- | ---
`DB_ERROR_UNSUPPORTED` | not supported | The requested information is not avaible. | Check your user permissions and the database system for support quering the requested information.

## Note

This function can not be called statically.

## Example

Example 33-1. Using getListOf()
    <?php
    // Once you have a valid DB object named $db...
    $data = $db->getListOf('tables');

    if (PEAR::isError($data)) {
        die($data->getMessage());
    }

    echo implode("\n", $data);
    ?>

Prev | Home | Next
DB_common::getCol() | Up | DB_common::getOne()