Getting Started

Usage

Advanced Usage

Adapters

Focus and Goals

It’s good to understand why Flysystem works the way that it does. There are some restrictions Flysystem upholds in order to benefit users in the long run. These restrictions are necessary to achieve the goals.

Overview

Vision

Flysystem’s goal is to provide a standardized file storage interface. After extensive research a common ground was determined which various types of filesystems could work with. This common ground was converted into an interface, the AdapterInterface. The most important goal for Flysystem is portability.

In order to achieve portability behaviour across filesystems is normalized. In some cases this mean’s we’ll go the extra mile to ensure polyfills are provided to provide a common API, in other cases it means features that are very specific to a filesystem are not supported. These limitation are put in place by design.

Adapters

The main entry point for the file system API is the FilesystemInterface. When working with file systems, this is the class you’ll want to be talking to.

Flysystem works the way it does because of its use of the adapter pattern. The inconsistencies of the different filesystems are eliminated in these adapters.

While adapters have a public interface (publicly accessible methods), they should be considered internal.

Every adapter should always be wrapped in a League\Flysystem\Filesystem class:

$filesystem = new League\Flysystem\Filesystem($yourAdapter)

Relative paths

Portability is a very important concept within Flysystem. In order to roll out this aspect to the fullest, all paths in Flysystem are relative. File system root paths, whether remote or local, are viewed as endpoints. Because of this, file systems are movable independently. This allows parts of the application file handling to move to other storage types, while the majority is in a centralized location.

Like the storage type, root paths are an implementation detail. When root paths are defined as configuration, the stability of your code improves.

Files first, directories second.

Flysystem has a files first approach. Storage systems like AWS S3 are linear file systems, this means the path to a file is used as an identifier, rather than a representation of all the directories it’s nested in.

This means directories are second class citizens. Because of this, directories will be automatically created on file systems that require them when writing files. Not only does this make handling writes a lot easier, it also ensures a consistent behaviors across all file system types.