\
Drupal
strata
Access
Anomaly
Archive
Branch
Budget
Capture
Classifier
EventSubscriber
Cas
Chunker
Code
Codec
Dictionary
Compaction
Crypto
Delta
Diff
Drill
Drush
Commands
Estimate
Event
Webhook
Explore
File
Flush
Form
Health
Tripwire
Hook
Journal
Metrics
Plugin
QueueWorker
views
field
filter
Restore
Plugin
Strata
Restore
Segment
Site
Storage
Plugin
Strata
Storage
Telemetry
Tier
Timeline
Tree
Verify

\Drupal\strata\Storage ObjectPage

One page of a listing.

Listings are paged rather than returned whole because a prune or a verify walks the entire store, and a bucket holding a year of history has millions of keys in it.

Summary

Methods
Properties
Constants
__construct
hasMore
bytes
keys
count
getIterator
objects
cursor
prefixes
No public constants found
No protected methods found
No protected properties found
No protected constants found
No private methods found
No private properties found
No private constants found

Properties

$objects

$objects : array

Type

array<string|int, mixed>

$cursor

$cursor : ?string

Type

string|null

$prefixes

$prefixes : array

Type

array<string|int, mixed>

Methods

__construct()

__construct(list<\Drupal\strata\Storage\ObjectMeta>  $objects = [], string|null  $cursor = null, list  $prefixes = []) : mixed

Constructs a page.

Parameters

list<\Drupal\strata\Storage\ObjectMeta> $objects

The objects on this page, in the order the endpoint returned them.
string|null $cursor

Token for the next page, or NULL when this is the last one.
list $prefixes

Common prefixes, when the listing was delimited.

Returns

mixed —

hasMore()

hasMore() : bool

Whether another page follows.

Returns

bool —

TRUE when StorageProviderInterface::list() should be called again with this cursor.

bytes()

bytes() : int

Total bytes described by this page.

Returns

int —

The sum of every object's size.

keys()

keys() : list<string>

Just the keys.

Returns

list —

Object keys, in page order.

count()

count() : int

{@inheritdoc}

Returns

int —

getIterator()

getIterator() : \Traversable<int,\Drupal\strata\Storage\ObjectMeta>

{@inheritdoc}

Returns

\Traversable —

The objects on this page.