PHP Extension

SharePoint -- Delete a Folder

Demonstrates how to delete a SharePoint folder. PHP Extension

<?php

include("chilkat.php");

$success = false;

// This requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

// If SharePoint Windows classic authentication is used, then set the 
// Login, Password, LoginDomain, and NtlmAuth properties.
$http->put_Login('SHAREPOINT_USERNAME');
$http->put_Password('SHAREPOINT_PASSWORD');
$http->put_LoginDomain('SHAREPOINT_NTLM_DOMAIN');
$http->put_NtlmAuth(true);

// The more common case is to use SharePoint Online authentication (via the SPOIDCRL cookie).
// If so, do not set Login, Password, LoginDomain, and NtlmAuth, and instead
// establish the cookie as shown at SharePoint Online Authentication

// This example will delete the folder /Documents/ChilkatTest2

$req = new CkHttpRequest();
$req->put_HttpVerb('POST');
// If your Sharepoint site is within a site collection, then use "/sites/teamA/_api/web/GetFolderByServerRelativeUrl('/sites/teamA/Documents/ChilkatTest2')" where "teamA" is the name of the site.
$req->put_Path('/_api/web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest2')');

// We need to add a form digest value in the X-RequestDigest header field.
// See this example for details on
// how to get (and cache) a form digest value
$req->AddHeader('X-RequestDigest','SHAREPOINT_FORM_DIGEST');

// Add additional required headers.
$req->AddHeader('IF-MATCH','*');
$req->AddHeader('X-HTTP-Method','DELETE');

// Send the POST using https (TLS). (Port 443 is the default port for https.)
$bUseTls = true;
$resp = new CkHttpResponse();
$success = $http->HttpSReq('SHAREPOINT_HTTPS_DOMAIN',443,$bUseTls,$req,$resp);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

// If failed, the response body contains XML 
$xml = new CkXml();
$xml->LoadXml($resp->bodyStr());

// Note: It seems that if an attempt is made to delete a folder that does not exist,
// the response status code is 200, indicating success.
if ($resp->get_StatusCode() != 200) {
    print 'Response status code = ' . $resp->get_StatusCode() . "\n";
    print $xml->getXml() . "\n";
    print 'Failed' . "\n";
    exit;
}

// If successful, the response body is empty.
print 'Success.' . "\n";

?>