Skip to content

omnidrive/azure API reference

Floor
Provider · Omnidrive
Version
1.x
Conformance suite
runs, CI green
Verified for real
Verified in part
Licence
MIT
composer require omnidrive/azure:1.x-dev

Read from the package's own PHP files at the commit c985f5bb41f0: its namespaces, classes, interfaces and enums, their public constants, properties and methods with their PHPDoc, and the options its factories take. Nothing of it is run.

Omnidrive\Azure

  • AzureDriveFactory class

    A container of Azure Blob Storage, through azure-oss/storage-blob-flysystem (the adapter The PHP League names in place of its own league/flysystem-azure-blob-storage, abandoned with Microsoft's retired SDK):

    3 options

Omnidrive\Azure

AzureDriveFactory class

final class AzureDriveFactory extends FlysystemDriveFactory AzureDriveFactory.php:34

A container of Azure Blob Storage, through azure-oss/storage-blob-flysystem (the adapter The PHP League names in place of its own league/flysystem-azure-blob-storage, abandoned with Microsoft's retired SDK):

(new AzureDriveFactory())->create(['container' => 'uploads', 'connection_string' => 'DefaultEndpointsProtocol=https;AccountName=...;AccountKey=...;EndpointSuffix=core.windows.net']); (new AzureDriveFactory())->create(['container' => 'uploads', 'account_name' => 'example', 'account_key' => '...']);

Options: container (required); connection_string (the portal's, a shared key or a SAS) or account_name and account_key (with endpoint, the Blob service's address, for another cloud or Azurite - else https://<account>.blob.core.windows.net); prefix (every path under it); public_container (the container's blobs are readable anonymously: a file's own address is its public one); public_url (a CDN in front of it).

A public address is given only with public_container or public_url: the adapter's own, for a private container, is a SAS valid a thousand years, which this drive does not hand out as "public". temporaryUrl() signs a read-only SAS with the account key. Blob Storage keeps no visibility per file: reading or changing one is a DriveException. Nothing is sent until the first operation.

Options

OptionDefault
prefix''
public_containerfalse
containerrequired