Natively Connect to SharePoint Data in PHP

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

Getting Started

---

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.

Set the URL property to the base SharePoint site or to a sub-site. This allows you to query any lists and other SharePoint entities defined for the site or sub-site.

The User and Password properties, under the Authentication section, must be set to valid SharePoint user credentials when using SharePoint On-Premise.

If you are connecting to SharePoint Online, set the SharePointEdition to SHAREPOINTONLINE along with the User and Password connection string properties. For more details on connecting to SharePoint Online, see the "Getting Started" chapter of the help documentation

Establish a Connection

Open the connection to SharePoint by calling the or methods. To close connections, use or .

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

Connections opened with are closed when the script ends. Connections opened with the 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 SharePoint Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the function.

$query = odbc_prepare($conn, "SELECT * FROM MyCustomList WHERE Location = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC SharePoint Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM MyCustomList WHERE Location = ?");
$success = odbc_execute($query, array('Chapel Hill'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC SharePoint Source","user","password");
$query = odbc_exec($conn, "SELECT Name, Revenue FROM MyCustomList");
 

Process Results

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

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

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

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