This library provides a SharePoint client for PHP applications. This allows you to performs CRUD operations on SharePoint data, using an REST/OData based API for SharePoint 2013.
The current version is restricted to SharePoint Online, using claims based authentication.
- PHP 5.3 or later
PHP:cURL library is used to make HTTP requests to performs CRUD operations on SharePoint data, using SharePoint 2013 REST API
An object of this class represents a REST Service client for the specified SharePoint Online (SPO) site.
Example:
$client = new SPOClient($url);
The signin method performs a claims-based authentication:
- build a SAML request (using SAML.xml template included in module)
- submit a SAML token request to Microsoft Online Security Token Service
- receive a signed security token
- POST the token to SharePoint Online
- receive FedAuth and rtFa authentication cookies
- store the cookies in client for use in subsequent requests
Example:
try {
$client = new SPOClient($url);
$client->signIn($username,$password);
echo 'You have authenticated successfully\n';
}
catch (Exception $e) {
echo 'Connection failed: ', $e->getMessage(), "\n";
}
The following examples demonstrates how to perform basic CRUD operations on SharePoint list data.
require_once 'SPOClient.php';
$username = '[email protected]';
$password = 'password';
$url = "https://tenant.sharepoint.com/";
generateTasks($url,$username,$password);
function generateTasks($url,$username,$password){
$client = new SPOClient($url);
$client->signIn($username,$password);
$listTitle = 'Tasks';
$list = $client->getList($listTitle);
for ($i=0;$i<4;$i++) {
$itemProperties = array('Title' => 'Order Approval ' . $i, 'Body' => 'Order approval task');
$item = $list->addItem($itemProperties);
print "Task '{$item->Title}' has been created succesfully.\r\n";
}
}
How to create SharePoint list item:
function addListItem($url,$username,$password){
$client = new SPOClient($url);
$client->signIn($username,$password);
$listTitle = 'Tasks';
$list = $client->getList($listTitle);
$itemProperties = array('Title' => 'Order Approval', 'Body' => 'Order approval task');
$item = $list->addItem($itemProperties);
}
How to delete SharePoint list item:
function deleteListItem($url,$username,$password){
$client = new SPOClient($url);
$client->signIn($username,$password);
$listTitle = 'Tasks';
$list = $client->getList($listTitle);
$list->deleteItem(2);
}
How to update SharePoint list item:
function updateListItem($url,$username,$password){
$client = new SPOClient($url);
$client->signIn($username,$password);
$listTitle = 'Tasks';
$list = $client->getList($listTitle);
$itemProperties = array('PercentComplete' => 1);
$list->updateItem(2,$itemProperties);
}
1.0.0 - May 23st, 2014
- Initial release.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent