Ready to get started?

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

Download Now

Natively Connect to FreshBooks Data in PHP

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

The CData ODBC Driver for FreshBooks enables you to write data access code for FreshBooks data in PHP. This article shows how to use PHP's ODBC built-in functions to connect to FreshBooks data, execute queries, and output the results.

Configure a DSN

To connect to FreshBooks data, your application will use connection properties defined in the data source name (DSN).

Below is a typical connection string:

CompanyName=CData;Token=token;

You can configure the DSN in the built-in Microsoft ODBC Data Source Administrator. This is the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to use the Microsoft ODBC Data Source Administrator to create and configure a DSN for FreshBooks data.

Establish a Connection

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

$conn = odbc_connect("CData ODBC FreshBooks 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:

$conn = odbc_pconnect("CData ODBC FreshBooks 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 Clients WHERE Email = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC FreshBooks Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Clients WHERE Email = ?"); $success = odbc_execute($query, array('Captain Hook'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC FreshBooks Source","user","password"); $query = odbc_exec($conn, "SELECT * FROM Clients");

Process Results

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

$conn = odbc_connect("CData ODBC FreshBooks data Source","user","password"); $query = odbc_exec($conn, "SELECT * FROM Clients"); while($row = odbc_fetch_array($query)){ echo $row["Username"] . "\n"; }

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

$conn = odbc_connect("CData ODBC FreshBooks data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Clients WHERE Email = ?"); $success = odbc_execute($query, array('Captain Hook')); if($success) odbc_result_all($query);

Test the Example Queries

One easy way to test the queries above is to use PHP's built-in test server to set up a basic stand-alone test environment. To start it, follow the steps below:

  1. Download the binaries for the latest version of PHP.

  2. Extract files to a folder.

  3. Open the folder.

  4. Rename php.ini-development to php.ini for a basic development setup.

  5. Run the command below to access your test scripts from the browser:

    php -S localhost:8000 -t C:\path-to-your-scripts -c C:\path-to-php\php.ini

More Example Queries

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

 
 
ダウンロード