PEAR Manual
PrevNext

DB_common::getOption()

DB_common::getOption() --  Determines current state of a PEAR DB configuration option

Synopsis

mixed getOption (string $option)

Description

Determines current state of a PEAR DB configuration option

Parameter

string $option

name of the option to examine

Return value

mixed the option's value

Throws

Table 26-1. Possible PEAR_Error values

Error codeError messageReasonSolution
NULL unknown option The given option does not exist Check $option for typographical errors

Note

This function can not be called statically.

Example

Example 26-1. Simple getOption() example

<?php
// Once you have a valid DB object named $db...
if ($db->getOption('autofree')) {
    // do something...
}
?>
PrevHomeNext
DB_common::getOne()UpDB_common::getRow()