FileSystem

Configuration & usage

Flysystem is a file storage library for PHP. It provides one interface to interact with many types of filesystems. When you use Flysystem, you’re not only protected from vendor lock-in, you’ll also have a consistent experience for which ever storage is right for you.

Installation

Flysystem can be installed using composer.

composer require league/flysystem:^3.0

Additionally, you may want to install an extra adapter to interact with specific types of filesystems. Please see the official flysystem documentation.

Configurations

You can choose between many drivers: local, ftp, sftp, memory, awsS3, googleCloudStorage, azureBlobStorage, webdav, zipArchive.

# Local Storage
FILE_SYSTEM_DRIVER=local

# FTP Storage
FILE_SYSTEM_DRIVER=ftp

# SFTP Storage
FILE_SYSTEM_DRIVER=sftp

# Memory Storage
FILE_SYSTEM_DRIVER=memory

# AWS S3 Storage
FILE_SYSTEM_DRIVER=awsS3

# Google Cloud Storage
FILE_SYSTEM_DRIVER=googleCloudStorage

# Azure Blob Storage
FILE_SYSTEM_DRIVER=azureBlobStorage

# WebDAV Storage
FILE_SYSTEM_DRIVER=webdav

# Zip Archive Storage
FILE_SYSTEM_DRIVER=zipArchive

Advanced Settings: Some settings are only available when you use a specific file system driver. Below you can find the advanced settings for each driver.

Local

# Local Storage
FILE_SYSTEM_DRIVER=local

# File System Settings of the `local` driver
FILE_SYSTEM_LOCAL_ROOT_DIRECTORY=<root>

Ftp

# FTP Storage
FILE_SYSTEM_DRIVER=ftp

# File System Settings of the `ftp` driver
FILE_SYSTEM_FTP_HOST=
FILE_SYSTEM_FTP_ROOT=
FILE_SYSTEM_FTP_USERNAME=
FILE_SYSTEM_FTP_PASSWORD=
FILE_SYSTEM_FTP_PORT=
FILE_SYSTEM_FTP_SSL=
FILE_SYSTEM_FTP_TIMEOUT=
FILE_SYSTEM_FTP_UTF8=
FILE_SYSTEM_FTP_PASSIVE=
FILE_SYSTEM_FTP_TRANSFER_MODE=
FILE_SYSTEM_FTP_SYSTEM_TYPE=
FILE_SYSTEM_FTP_SYSTEM_IGNORE_PASSIVE_ADDRESS=
FILE_SYSTEM_FTP_TIMESTAMPS_ON_UNIX_LISTING_ENABLED=
FILE_SYSTEM_FTP_RECURSE_MANUALLY=

SFTP

# SFTP Storage
FILE_SYSTEM_DRIVER=sftp

# File System Settings of the `sftp` driver
FILE_SYSTEM_SFTP_HOST=
FILE_SYSTEM_SFTP_USERNAME=
FILE_SYSTEM_SFTP_PASSWORD=
FILE_SYSTEM_SFTP_PRIVATE_KEY=
FILE_SYSTEM_SFTP_PASSPHRASE=
FILE_SYSTEM_SFTP_PORT=
FILE_SYSTEM_SFTP_USE_AGENT=
FILE_SYSTEM_SFTP_TIMEOUT=
FILE_SYSTEM_SFTP_MAX_TRIES=
FILE_SYSTEM_SFTP_HOST_FINGERPRINT=
FILE_SYSTEM_SFTP_CONNECTIVITY_CHECKER=

Memory

# Memory Storage
FILE_SYSTEM_DRIVER=memory

WebDAV

# WebDAV Storage
FILE_SYSTEM_DRIVER=webdav

# File System Settings of the `webdav` driver
FILE_SYSTEM_WEBDAV_BASE_URI=
FILE_SYSTEM_WEBDAV_USERNAME=
FILE_SYSTEM_WEBDAV_PASSWORD=

ZipArchive

# Zip Archive Storage
FILE_SYSTEM_DRIVER=zipArchive

# File System Settings of the `zipArchive` driver
FILE_SYSTEM_ZIP_ARCHIVE_PATH=

AWS S3

# AWS S3 Storage
FILE_SYSTEM_DRIVER=awsS3

# File System Settings of the `awsS3` driver
FILE_SYSTEM_AWS_S3_BUCKET_NAME=<your-bucket-name>
FILE_SYSTEM_AWS_S3_PATH_PREFIX=<optional-path-prefix>
FILE_SYSTEM_AWS_S3_ASYNC=false

Google Cloud Storage

# Google Cloud Storage
FILE_SYSTEM_DRIVER=googleCloudStorage

# File System Settings of the `googleCloudStorage` driver
FILE_SYSTEM_GOOGLE_CLOUD_STORAGE_BUCKET_NAME=<your-bucket-name>
FILE_SYSTEM_GOOGLE_CLOUD_STORAGE_PATH_PREFIX=<optional-path-prefix>

Azure Blob Storage

# Azure Blob Storage
FILE_SYSTEM_DRIVER=azureBlobStorage

# File System Settings of the `googleCloudStorage` driver
FILE_SYSTEM_AZURE_BLOB_STORAGE_CONTAINER_NAME=<your-container-name>
FILE_SYSTEM_AZURE_BLOB_STORAGE_PATH_PREFIX=<optional-path-prefix>

Usage

// if the class is aware of injections
$fileSystem = $this->fileSystem;

// if the container is present
$fileSystem = $this->di->get('fileSystem');

// to access the shared db service
$fileSystem = Di::getDefault()->get('fileSystem');

External Links

• The PHP League - File Storage Abstraction for PHP

Sources

• Zemit\Provider\FileSystem\ServiceProvider