PHP OSS for Azure API Reference

Blob
in package

FinalYes

Represents Azure Storage blob data.

Table of Contents

Properties

$hasVersionsOnly  : bool|null
Indicates whether the listed item represents a deleted base blob that still has versions.
$isDeleted  : bool
Indicates whether this blob or blob version is soft-deleted.
$isLatestVersion  : bool|null
Indicates whether this version is the current version of the blob.
$metadata  : array<string, string>|null
$name  : string
The blob name.
$properties  : BlobProperties
The blob system properties returned by the service.
$snapshot  : string|null
The snapshot timestamp for this blob snapshot when snapshots are included.
$tags  : array<string, string>|null
$versionId  : string|null
The version identifier for this blob when versions are included.

Methods

fromXml()  : self
__construct()  : mixed
deserializeBool()  : bool|null
deserializeDictionary()  : array<string, string>
deserializeNullableString()  : string|null

Properties

$hasVersionsOnly read-only

Indicates whether the listed item represents a deleted base blob that still has versions.

public bool|null $hasVersionsOnly = null

$isDeleted read-only

Indicates whether this blob or blob version is soft-deleted.

public bool $isDeleted = false

$isLatestVersion read-only

Indicates whether this version is the current version of the blob.

public bool|null $isLatestVersion = null

$metadata read-only

public array<string, string>|null $metadata = null

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

$name read-only

The blob name.

public string $name

$properties read-only

The blob system properties returned by the service.

public BlobProperties $properties

$snapshot read-only

The snapshot timestamp for this blob snapshot when snapshots are included.

public string|null $snapshot = null

$tags read-only

public array<string, string>|null $tags = null

Blob index tags, or null when tags were not returned.

$versionId read-only

The version identifier for this blob when versions are included.

public string|null $versionId = null

Methods

fromXml()

public static fromXml(SimpleXMLElement $xml) : self
Parameters
$xml : SimpleXMLElement
Return values
self

__construct()

private __construct(string $name, BlobProperties $properties[, string|null $snapshot = null ][, bool $isDeleted = false ][, string|null $versionId = null ][, bool|null $isLatestVersion = null ][, array<string, string>|null $metadata = null ][, array<string, string>|null $tags = null ][, bool|null $hasVersionsOnly = null ]) : mixed
Parameters
$name : string
$properties : BlobProperties
$snapshot : string|null = null
$isDeleted : bool = false
$versionId : string|null = null
$isLatestVersion : bool|null = null
$metadata : array<string, string>|null = null

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

$tags : array<string, string>|null = null

Blob index tags, or null when no tags were returned.

$hasVersionsOnly : bool|null = null

deserializeBool()

private static deserializeBool(SimpleXMLElement $xml) : bool|null
Parameters
$xml : SimpleXMLElement
Return values
bool|null

deserializeDictionary()

private static deserializeDictionary(SimpleXMLElement $xml) : array<string, string>
Parameters
$xml : SimpleXMLElement
Return values
array<string, string>

deserializeNullableString()

private static deserializeNullableString(SimpleXMLElement $xml) : string|null
Parameters
$xml : SimpleXMLElement
Return values
string|null
On this page

Search results