Archive
A dump archive entry — the unit the rotation engine reasons about.
Hydrated from an $init array keyed by the class constants, e.g.
new Archive([ Archive::PATH => …, Archive::BUCKET => …, Archive::DATE => …, Archive::SIZE => … ]).
Tags
Table of Contents
Constants
- BUCKET : string = 'bucket'
- The `bucket` property name — the archive suffix signature.
- DATE : string = 'date'
- The `date` property name — the date embedded in the archive name.
- PATH : string = 'path'
- The `path` property name — the absolute archive path.
- SIZE : string = 'size'
- The `size` property name — the archive size in bytes.
Properties
- $bucket : string
- The bucket the archive belongs to (its suffix signature).
- $date : DateTimeImmutable|null
- The date embedded at the start of the archive file name.
- $path : string
- The absolute archive path.
- $size : int
- The archive size, in bytes.
Methods
- __construct() : mixed
- Creates a new Archive.
Constants
BUCKET
The `bucket` property name — the archive suffix signature.
public
string
BUCKET
= 'bucket'
DATE
The `date` property name — the date embedded in the archive name.
public
string
DATE
= 'date'
PATH
The `path` property name — the absolute archive path.
public
string
PATH
= 'path'
SIZE
The `size` property name — the archive size in bytes.
public
string
SIZE
= 'size'
Properties
$bucket
The bucket the archive belongs to (its suffix signature).
public
string
$bucket
= ''
$date
The date embedded at the start of the archive file name.
public
DateTimeImmutable|null
$date
= null
$path
The absolute archive path.
public
string
$path
= ''
$size
The archive size, in bytes.
public
int
$size
= 0
Methods
__construct()
Creates a new Archive.
public
__construct([array<string|int, mixed>|object|null $init = null ]) : mixed
Parameters
- $init : array<string|int, mixed>|object|null = null
-
Initial values keyed by the class constants.