ObjectListing
One page of ListableObjectStoreClientInterface::listObjects().
$commonPrefixes is only ever non-empty when the call passed a delimiter: it is the “directories” one level below the prefix, the same grouping S3, GCS and Azure each fold keys into when asked to stop at the first delimiter after the prefix. Without a delimiter every matching key comes back in $objects, flat.
Synopsis
Section titled “Synopsis”final readonly class ObjectListing
| Since | 4.2.0 |
| Source | ObjectListing.php |
Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
$commonPrefixes | array | readonly. |
$nextContinuationToken | ?``string | readonly. |
$objects | array | readonly. |
Constructor
Section titled “Constructor”__construct()
Section titled “__construct()”public function __construct(list<ObjectSummary> $objects, list<string> $commonPrefixes, ?string $nextContinuationToken): mixed
Each ending in the delimiter that produced it.
| Parameter | Type | Description |
|---|---|---|
$objects | list``<ObjectSummary> | In the order the provider returned them. |
$commonPrefixes | list``<``string``> | Each ending in the delimiter that produced it. |
$nextContinuationToken | ?``string |
Returns mixed
Methods
Section titled “Methods”| Method | Description |
|---|---|
isTruncated(): bool | Whether another page follows — pass $nextContinuationToken back in to fetch it. |
isTruncated()
Section titled “isTruncated()”public function isTruncated(): bool
Whether another page follows — pass $nextContinuationToken back in to fetch it.
Returns bool