README

Warning

Data Lake Storage (Storage Account with hierarchical namespace enabled) is unsupported.

Minimum Requirements

PHP 8.1 or above
Required PHP extensions
- curl
- json
- xml

Install

composer require azure-oss/storage-blob-flysystem

Usage

use AzureOss\FlysystemAzureBlobStorage\AzureBlobStorageAdapter;
use AzureOss\Storage\Blob\BlobServiceClient;
use League\Flysystem\Filesystem;

// Create a BlobContainerClient
$containerClient = BlobServiceClient::fromConnectionString($connectionString)
    ->getContainerClient('your-container-name');

// Create the adapter
$adapter = new AzureBlobStorageAdapter(
    $containerClient,
    'optional-prefix',
    useDirectPublicUrl: false, // Set to true to use direct public URLs instead of SAS tokens
);

// Create the filesystem
$filesystem = new Filesystem($adapter);

Public URLs

By default, the adapter generates public URLs using SAS tokens with a 1000-year expiration. If you prefer to use direct public URLs without SAS tokens, you can set the useDirectPublicUrl parameter to true:

$adapter = new AzureBlobStorageAdapter(
    $containerClient,
    'optional-prefix',
    useDirectPublicUrl: true,
);

Note that for direct public URLs to work, your container must be configured with public access. If your container is private, you should use the default SAS token approach.

Documentation

For more information visit the documentation at azure-oss.github.io.

Support

Do you need help, do you want to talk to us, or is there anything else?

Join us at:

License

Azure-Storage-PHP-Adapter-Flysystem is released under the MIT License. See LICENSE for details.

PHP Version Support Policy

The maintainers of this package add support for a PHP version following its initial release and drop support for a PHP version once it has reached its end of security support.

Backward compatibility promise

Azure-Storage-PHP is using Semver. This means that versions are tagged with MAJOR.MINOR.PATCH. Only a new major version will be allowed to break backward compatibility (BC).

Classes marked as @experimental or @internal are not included in our backward compatibility promise. You are also not guaranteed that the value returned from a method is always the same. You are guaranteed that the data type will not change.

PHP 8 introduced named arguments, which increased the cost and reduces flexibility for package maintainers. The names of the arguments for methods in the library are not included in our BC promise.

azure-oss / storage-blob-flysystem

Maintainers

Details