Ready to get started?

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

Download Now

Natively Connect to Magento Data in PHP

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

Drop the CData ODBC Driver for Magento into your LAMP or WAMP stack to build Magento-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Magento 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.

Magento uses the OAuth 1 authentication standard. To connect to the Magento REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Magento system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

You will also need to provide the URL to your Magento system. The URL depends on whether you are using the Magento REST API as a customer or administrator.

  • Customer: To use Magento as a customer, make sure you have created a customer account in the Magento homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Magento system.

  • Administrator: To access Magento as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

    If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

Establish a Connection

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

$conn = odbc_connect("CData ODBC Magento 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 Magento 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 Products WHERE Style = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC Magento Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Products WHERE Style = ?"); $success = odbc_execute($query, array('High Tech'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC Magento Source","user","password"); $query = odbc_exec($conn, "SELECT Name, Price FROM Products");

Process Results

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

$conn = odbc_connect("CData ODBC Magento data Source","user","password"); $query = odbc_exec($conn, "SELECT Name, Price FROM Products"); while($row = odbc_fetch_array($query)){ echo $row["Name"] . "\n"; }

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

$conn = odbc_connect("CData ODBC Magento data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Products WHERE Style = ?"); $success = odbc_execute($query, array('High Tech')); 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 Magento-specific adaptations of the PHP community documentation for all ODBC functions.