ADOdb

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Include File Guide ======
===== Description =====
This page describes the required and optional include files for use in applications.

<WRAP important>
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.
</WRAP>

===== Core Library =====
The following include file is required for all database applications:
<code php>
require 'adodb-directory/adodb.inc.php';
</code>
  
prior to inclusion of the file, the following constant may optionally be defined:

[[v5:reference: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:

<code php>
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';
</code>

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

===== Date/Time Library =====
The ADOdb [[v5:datetime:datetime_index|Date/Time Library]] is standalone and does not require a database connection.

<code php>
require 'adodb-directory/adodb-time.inc.php';
</code>

===== Session Management Library =====
The ADOdb [[v5:session:session_index|Session Library]] should be included after the database handler. Make sure to use the **adodb-session2.inc.php**, not **adodb-session.inc.php**.
<code php>
require 'adodb-directory/adodb.inc.php';
require 'adodb-directory/session/adodb-session2.inc.php';
</code>
==== Using Encrypted Data ====
<code php>
require 'adodb-directory/adodb.inc.php';
require 'adodb-directory/session/adodb-cryptsession2.inc.php';
</code>
==== Storing Data In CLOBS ====
Do not use this with Oracle Databases.
<code php>
require 'adodb-directory/adodb.inc.php';
require 'adodb-directory/session/adodb-session-clob2.inc.php';
</code>

===== ADOdb-xmlschema =====
The ADOdb [[v5:session:session_index|Session Library]] should be included after the database handler. Make sure to use the **adodb-xmlschema03.inc.php**, not **adodb-xmlschema.inc.php**.
<code php>
require 'adodb-directory/adodb.inc.php';
require 'adodb-directory/adodb-xmlschema03.inc.php';
</code>