Include File Guide

Description

This page describes the required and optional include files for use in applications.

Please note that ADOdb version 5 does not support autoloading or namespaces.

When using Composer, only the Library's core adodb.inc.php is included for you. If your project requires additional components, the relevant files still need to be included as described in this document.

Core Library

The following include file is required for all database applications:

require 'adodb-directory/adodb.inc.php';

prior to inclusion of the file, the following constant may optionally be defined:

$ADODB_FETCH_MODE

Any necessary driver and library files are automatically included, based on Connection requirements. However, if you are modifying ADOdb files and are having difficulties debugging, your optional core includes can look like this:

require 'adodb-directory/adodb.inc.php';
require 'adodb-directory/adodb-lib.inc.php';
require 'adodb-directory/drivers/adodb-{driver}.inc.php';
require 'adodb-directory/adodb-datadict.inc.php';
require 'adodb-directory/datadict/datadict-{driver}.inc.php';

When using Composer, with default settings the actual value for the adodb-directory include path is vendor/adodb/adodb-php/.

Date/Time Library

The ADOdb Date/Time Library is standalone and does not require a database connection.

require 'adodb-directory/adodb-time.inc.php';

Session Management Library

The ADOdb Session Library should be included after the database handler. Make sure to use the adodb-session2.inc.php, not adodb-session.inc.php.

require 'adodb-directory/adodb.inc.php';
require 'adodb-directory/session/adodb-session2.inc.php';

Using Encrypted Data

require 'adodb-directory/adodb.inc.php';
require 'adodb-directory/session/adodb-cryptsession2.inc.php';

Storing Data In CLOBS

Do not use this with Oracle Databases.

require 'adodb-directory/adodb.inc.php';
require 'adodb-directory/session/adodb-session-clob2.inc.php';

ADOdb-xmlschema

The ADOdb Session Library should be included after the database handler. Make sure to use the adodb-xmlschema03.inc.php, not adodb-xmlschema.inc.php.

require 'adodb-directory/adodb.inc.php';
require 'adodb-directory/adodb-xmlschema03.inc.php';

Table of Contents