PHP OSS for Azure API Reference

BlobProperties
in package

FinalYes

Represents Azure Storage blob properties data.

Table of Contents

Properties

$cacheControl  : string
$contentDisposition  : string
$contentEncoding  : string
$contentLanguage  : string
$contentLength  : int
$contentMD5  : string|null
$contentType  : string
$copyCompletionTime  : DateTimeInterface|null
$copyId  : string|null
$copySource  : UriInterface|null
$copyStatus  : CopyStatus|null
$copyStatusDescription  : string|null
$deletedOn  : DateTimeInterface|null
The time at which the blob or snapshot was soft-deleted.
$eTag  : ETag|null
$isLatestVersion  : bool|null
Whether this version is the current version of the blob.
$lastModified  : DateTimeInterface|null
$metadata  : array<string, string>|null
$remainingRetentionDays  : int|null
Days remaining before the soft-deleted blob or snapshot is permanently removed.
$versionId  : string|null
The version identifier returned for this blob when versioning is enabled.

Methods

fromResponseHeaders()  : self
fromXml()  : self
__construct()  : mixed

Properties

$contentDisposition read-only

public string $contentDisposition = ''

$copyCompletionTime read-only

public DateTimeInterface|null $copyCompletionTime = null

$copySource read-only

public UriInterface|null $copySource = null

$copyStatusDescription read-only

public string|null $copyStatusDescription = null

$deletedOn read-only

The time at which the blob or snapshot was soft-deleted.

public DateTimeInterface|null $deletedOn = null

$isLatestVersion read-only

Whether this version is the current version of the blob.

public bool|null $isLatestVersion = null

$lastModified read-only

public DateTimeInterface|null $lastModified

$metadata read-only

public array<string, string>|null $metadata

User-defined metadata, or null when metadata was not returned.

$remainingRetentionDays read-only

Days remaining before the soft-deleted blob or snapshot is permanently removed.

public int|null $remainingRetentionDays = null

$versionId read-only

The version identifier returned for this blob when versioning is enabled.

public string|null $versionId = null

Methods

fromResponseHeaders()

public static fromResponseHeaders(ResponseInterface $response) : self
Parameters
$response : ResponseInterface
Return values
self

fromXml()

public static fromXml(SimpleXMLElement $xml[, array<string, string>|null $metadata = null ]) : self
Parameters
$xml : SimpleXMLElement
$metadata : array<string, string>|null = null
Return values
self

__construct()

private __construct(DateTimeInterface|null $lastModified, int $contentLength, string $contentType, string|null $contentMD5, array<string, string>|null $metadata[, string|null $copyId = null ][, UriInterface|null $copySource = null ][, CopyStatus|null $copyStatus = null ][, string|null $copyStatusDescription = null ][, DateTimeInterface|null $copyCompletionTime = null ][, string $cacheControl = '' ][, string $contentDisposition = '' ][, string $contentLanguage = '' ][, string $contentEncoding = '' ][, ETag|null $eTag = null ][, DateTimeInterface|null $deletedOn = null ][, int|null $remainingRetentionDays = null ][, string|null $versionId = null ][, bool|null $isLatestVersion = null ]) : mixed
Parameters
$lastModified : DateTimeInterface|null
$contentLength : int
$contentType : string
$contentMD5 : string|null
$metadata : array<string, string>|null
$copyId : string|null = null
$copySource : UriInterface|null = null
$copyStatus : CopyStatus|null = null
$copyStatusDescription : string|null = null
$copyCompletionTime : DateTimeInterface|null = null
$cacheControl : string = ''
$contentDisposition : string = ''
$contentLanguage : string = ''
$contentEncoding : string = ''
$eTag : ETag|null = null
$deletedOn : DateTimeInterface|null = null
$remainingRetentionDays : int|null = null
$versionId : string|null = null
$isLatestVersion : bool|null = null
On this page

Search results