Ready to get started?

Learn more about the CData ODBC Driver for Alfresco or download a free trial:

Download Now

Natively Connect to Alfresco Data in PHP

The CData ODBC driver for Alfresco enables you to create PHP applications with connectivity to Alfresco data. Leverage the native support for ODBC in PHP.

Drop the CData ODBC Driver for Alfresco into your LAMP or WAMP stack to build Alfresco-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Alfresco data, execute queries, and output the results.

Configure a DSN

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

To connect to Alfresco, the following connection properties must be supplied: User, Password, and InstanceUrl. User and Password correspond to the login credentials that you use to access Alfresco in a web browser. InstanceUrl corresponds to the Alfresco instance you will be querying. For instance, if you expect your queries to hit https://search-demo.dev.alfresco.me/alfresco/api/-default-/public/search/versions/1/sql, you should supply search-demo.dev.alfresco.me for InstanceUrl.

Establish a Connection

Open the connection to Alfresco by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

$conn = odbc_connect("CData ODBC Alfresco Source","user","password");

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC Alfresco Source","user","password"); ... odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the odbc_prepare function.

$query = odbc_prepare($conn, "SELECT * FROM Alfresco WHERE Column2 = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC Alfresco Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Alfresco WHERE Column2 = ?"); $success = odbc_execute($query, array('MyFilter'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC Alfresco Source","user","password"); $query = odbc_exec($conn, "SELECT DBID, Column1 FROM Alfresco WHERE Column2 = MyFilter");

Process Results

Access a row in the result set as an array with the odbc_fetch_array function.

$conn = odbc_connect("CData ODBC Alfresco data Source","user","password"); $query = odbc_exec($conn, "SELECT DBID, Column1 FROM Alfresco WHERE Column2 = MyFilter"); while($row = odbc_fetch_array($query)){ echo $row["DBID"] . "\n"; }

Display the result set in an HTML table with the odbc_result_all function.

$conn = odbc_connect("CData ODBC Alfresco data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Alfresco WHERE Column2 = ?"); $success = odbc_execute($query, array('MyFilter')); if($success) odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are Alfresco-specific adaptations of the PHP community documentation for all ODBC functions.