(PHP Extension) S3 Get Bucket Objects with CommonPrefixes

Demonstrates how to get a list of bucket objects using the prefix and delimiter query params to get an XML result with CommonPrefixes.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

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

$http = new CkHttp();

// Insert your access key here:
$http->put_AwsAccessKey('AWS_ACCESS_KEY');

// Insert your secret key here:
$http->put_AwsSecretKey('AWS_SECRET_KEY');

// In this example, my bucket is "chilkat100".
// It contains a number of folders, one of which is named "images".
// I want to get a list of all sub-folders under the "images" folder
$strXml = $http->s3_ListBucketObjects('chilkat100?prefix=images/&delimiter=/');
if ($http->get_LastMethodSuccess() != true) {
    print $http->lastErrorText() . "\n";
    exit;
}

print 'Response status code = ' . $http->get_LastStatus() . "\n";

$xml = new CkXml();
$success = $xml->LoadXml($strXml);
if ($success != true) {
    print $xml->lastErrorText() . "\n";
    exit;
}

// If the response status code was not 200, then the XML response is not a 
// listing of objects, but instead contains error information.
if ($http->get_LastStatus() != 200) {
    print $xml->getXml() . "\n";
    print 'Failed.' . "\n";
    exit;
}

// A sample response is shown below.
print $xml->getXml() . "\n";
print '----' . "\n";

// Here is the list of sub-folders (i.e. CommonPrefixes)

// <?xml version="1.0" encoding="UTF-8"?>
// <ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
//     <Name>chilkat100</Name>
//     <Prefix>images/</Prefix>
//     <Marker/>
//     <MaxKeys>1000</MaxKeys>
//     <Delimiter>/</Delimiter>
//     <IsTruncated>false</IsTruncated>
//     <CommonPrefixes>
//         <Prefix>images/africa/</Prefix>
//     </CommonPrefixes>
//     <CommonPrefixes>
//         <Prefix>images/sea_creatures/</Prefix>
//     </CommonPrefixes>
// </ListBucketResult>

// The XML can be parsed like this:
$i = 0;
$count_i = $xml->NumChildrenHavingTag('CommonPrefixes');
while ($i < $count_i) {
    $xml->put_I($i);
    $Prefix = $xml->getChildContent('CommonPrefixes[i]|Prefix');
    print 'Prefix = ' . $Prefix . "\n";
    $i = $i + 1;
}


?>