PEAR Manual
PrevNext

DB_common::setOption()

DB_common::setOption() -- Sets run-time configuration options for PEAR DB

Synopsis

integer setOption (string $option, mixed $value)

Description

Sets run-time configuration options for PEAR DB.

Parameter

string $option

name of the option to set

mixed $value

value to set the option to

Table 26-1.

OptionData TypeDefault ValueDescription
autofree boolean FALSE should results be freed automatically when there are no more rows?
debug integer 0 debug level
persistent boolean FALSE should the connection be persistent?
portability integer DB_PORTABILITY_NONE portability mode constant. These constants are bitwised, so they can be combined using | and removed using ^. See the examples below and the "Intro - Portability" for more information.
seqname_format string %s_seq the sprintf() format string used on sequence names. This format is applied to sequence names passed to createSequence(), nextID() and dropSequence().  
ssl boolean FALSE use ssl to connect?

Return value

integer - DB_OK on success or a DB_Error object on failure

Throws

Table 26-2. 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 setOption() example

<?php
// Once you have a valid DB object named $db...
$db->setOption('autofree', true);
?>

Example 26-2. Portability for lowercasing and trimming

<?php
// Once you have a valid DB object named $db...
$db->setOption('portability',
    DB_PORTABILITY_LOWERCASE | DB_PORTABILITY_RTRIM);
?>

Example 26-3. All portability options except trimming

<?php
// Once you have a valid DB object named $db...
$db->setOption('portability',
    DB_PORTABILITY_ALL ^ DB_PORTABILITY_RTRIM);
?>
PrevHomeNext
DB_common::setFetchMode()UpDB_common::tableInfo()