Flysystem

https://flysystem.thephpleague.com/docs
Admin
Flysystem is a file storage abstraction library for PHP that provides a unified interface to...
Tokens:28,809
Snippets:272
Trust Score:9.6
Update:2 days ago
Show doc for...
Tokens:
Raw
### Install with Composer

Source: https://flysystem.thephpleague.com/docs/adapter/gitlab/

Install the Gitlab Filesystem Adapter package using Composer.

```bash
composer require royvoetman/flysystem-gitlab-storage
```

--------------------------------

### Install with Composer

Source: https://flysystem.thephpleague.com/docs/adapter/path-prefixing/

Install the flysystem-path-prefixing package version ^3.3 via Composer.

```bash
composer require league/flysystem-path-prefixing:^3.3
```

--------------------------------

### Install Flysystem ZipArchive Adapter with Composer

Source: https://flysystem.thephpleague.com/docs/adapter/zip-archive/

Run this command to install the league/flysystem-ziparchive package via Composer.

```bash
composer require league/flysystem-ziparchive
```

--------------------------------

### Install SimpleS3Client for large files

Source: https://flysystem.thephpleague.com/docs/adapter/async-aws-s3/

Install the async-aws/simple-s3 package to enable multipart uploads for files larger than 5GB.

```bash
composer require async-aws/simple-s3
```

--------------------------------

### Install Flysystem with Composer

Source: https://flysystem.thephpleague.com/docs/adapter/local/

Install the Flysystem package, which includes the local adapter, using Composer.

```bash
composer require league/flysystem:^3.0
```

--------------------------------

### Install league/mime-type-detection via Composer

Source: https://flysystem.thephpleague.com/docs/advanced/mime-type-detection/

Install the package separately if not using Flysystem.

```bash
composer require league/mime-type-detection
```

--------------------------------

### Installation with Composer

Source: https://flysystem.thephpleague.com/docs/adapter/aws-s3-v3/

Install the Flysystem AWS S3 v3 adapter using Composer. Requires PHP and Composer.

```bash
composer require league/flysystem-aws-s3-v3:^3.0
```

--------------------------------

### Install GridFS adapter with Composer

Source: https://flysystem.thephpleague.com/docs/adapter/gridfs/

Install the Flysystem GridFS adapter version ^3.0 using Composer.

```bash
composer require league/flysystem-gridfs:^3.0
```

--------------------------------

### Install WebDAV Adapter with Composer

Source: https://flysystem.thephpleague.com/docs/adapter/webdav/

Install the league/flysystem-webdav package version ^3.0 using Composer. This adapter is powered by sabre/dav.

```bash
composer require league/flysystem-webdav:^3.0
```

--------------------------------

### Install Flysystem FTP Adapter with Composer

Source: https://flysystem.thephpleague.com/docs/adapter/ftp/

Install the Flysystem FTP adapter version 3.0 using Composer.

```bash
composer require league/flysystem-ftp:^3.0
```

--------------------------------

### Set up Google Cloud Storage Adapter with Flysystem

Source: https://flysystem.thephpleague.com/docs/adapter/google-cloud-storage/

This PHP example initializes a StorageClient, retrieves a bucket, creates a GoogleCloudStorageAdapter with an optional prefix, and constructs a Filesystem instance. Note that visibility retrieval for unknown files always resolves to private, which is a known deviation from the adapter contract.

```php
<?php

use League\Flysystem\GoogleCloudStorage\GoogleCloudStorageAdapter;
use League\Flysystem\Filesystem;
use Google\Cloud\Storage\StorageClient;

include __DIR__.'/vendor/autoload.php';

$storageClient = new StorageClient($clientOptions);
$bucket = $storageClient->bucket('your-bucket-name');

$adapter = new GoogleCloudStorageAdapter($bucket, 'optional-prefix');

$filesystem = new Filesystem($adapter);
```

--------------------------------

### Setting up a Mount Manager

Source: https://flysystem.thephpleague.com/docs/advanced/mount-manager/

Creates three Filesystem instances and passes them to the MountManager constructor as an array with keys 'ftp', 's3', and 'local'. This setup allows subsequent operations to reference these file systems using URI prefixes.

```php
$ftp = new League\Flysystem\Filesystem($ftpAdapter);
$s3 = new League\Flysystem\Filesystem($s3Adapter);
$local = new League\Flysystem\Filesystem($localAdapter);

// Add them in the constructor
$manager = new League\Flysystem\MountManager([
    'ftp' => $ftp,
    's3' => $s3,
]);
```

--------------------------------

### Install adapter test utilities

Source: https://flysystem.thephpleague.com/docs/advanced/creating-an-adapter/

Use Composer to install the league/flysystem-adapter-test-utilities package, which provides the FilesystemAdapterTestCase base class for integration testing your adapter.

```bash
composer require --dev league/flysystem-adapter-test-utilities
```

--------------------------------

### Create a file using the Local Filesystem Adapter

Source: https://flysystem.thephpleague.com/docs/getting-started/

This PHP example creates a LocalFilesystemAdapter pointing to a storage directory, wraps it in a Filesystem instance, and writes a file named 'Example.txt' with the given contents. Always wrap the adapter in a Filesystem instance for safe interaction.

```php
// Create a Local Filesystem adapter
$adapter = new \League\Flysystem\Local\LocalFilesystemAdapter(__DIR__ . '/storage');

// Create a new Filesystem instance with that adapter
$filesystem = new \League\Flysystem\Filesystem($adapter);

// Create a file "Example.txt" with the contents "Lorem ipsum dolor sit amet."
$filesystem->write(location: 'Example.txt', contents: 'Lorem ipsum dolor sit amet.');
```

--------------------------------

### Install league/flysystem-read-only via Composer

Source: https://flysystem.thephpleague.com/docs/adapter/read-only/

Use this Composer command to install the read-only adapter package version ^3.3.

```bash
composer require league/flysystem-read-only:^3.3
```

--------------------------------

### Install Azure Blob Storage Adapter via Composer

Source: https://flysystem.thephpleague.com/docs/adapter/azure-blob-storage/

Install the adapter using Composer with the specified version constraint.

```bash
composer require league/flysystem-azure-blob-storage:^3.0
```

--------------------------------

### Install flysystem-memory via Composer

Source: https://flysystem.thephpleague.com/docs/adapter/in-memory/

Install the in-memory adapter package using Composer. Requires version ^3.0.

```bash
composer require league/flysystem-memory:^3.0
```

--------------------------------

### Install AsyncAws S3 Adapter via Composer

Source: https://flysystem.thephpleague.com/docs/adapter/async-aws-s3/

Install the Flysystem AsyncAws S3 adapter version 3.0 using Composer.

```bash
composer require league/flysystem-async-aws-s3:^3.0
```

--------------------------------

### Simple usage of AwsS3V3Adapter

Source: https://flysystem.thephpleague.com/docs/adapter/aws-s3-v3/

Creates an S3 client, wraps it in the AwsS3V3Adapter with a bucket name, and then creates a Filesystem instance. This is the minimal setup for basic operations.

```php
/** @var Aws\S3\S3ClientInterface $client */
$client = new Aws\S3\S3Client($options);

// The internal adapter
$adapter = new League\Flysystem\AwsS3V3\AwsS3V3Adapter(
    // S3Client
    $client,
    // Bucket name
    'bucket-name'
);

// The FilesystemOperator
$filesystem = new League\Flysystem\Filesystem($adapter);
```

--------------------------------

### Usage Example for Azure Blob Storage Adapter

Source: https://flysystem.thephpleague.com/docs/adapter/azure-blob-storage/

Shows how to create an Azure Blob Storage adapter and a Flysystem instance. Requires the Azure Blob REST proxy client and a container name. Note that visibility is not supported, mimetypes are always resolved, and directory creation is not supported.

```php
<?php

use League\Flysystem\AzureBlobStorage\AzureBlobStorageAdapter;
use League\Flysystem\Filesystem;
use MicrosoftAzure\Storage\Blob\BlobRestProxy;

include __DIR__.'/vendor/autoload.php';

$client = BlobRestProxy::createBlobService('[INSERT-DSN-STRING-HERE]');
$adapter = new AzureBlobStorageAdapter(
    $client,
    'container-name',
    'optional/prefix',
);
$filesystem = new Filesystem($adapter);
```

--------------------------------

### Install Flysystem Google Cloud Storage Adapter

Source: https://flysystem.thephpleague.com/docs/adapter/google-cloud-storage/

Use Composer to install the adapter version ^3.0. This is the required dependency for using the Google Cloud Storage adapter with Flysystem.

```bash
composer require league/flysystem-google-cloud-storage:^3.0
```

--------------------------------

### Wrap an adapter with ReadOnlyFilesystemAdapter

Source: https://flysystem.thephpleague.com/docs/adapter/read-only/

This PHP example shows how to decorate any adapter (here InMemoryFilesystemAdapter) with ReadOnlyFilesystemAdapter and then create a Filesystem instance. The resulting filesystem will be read-only.

```php
// The internal adapter, any
$adapter = new League\Flysystem\InMemory\InMemoryFilesystemAdapter();

// Turn it into a read-only adapter
$adapter = new League\Flysystem\ReadOnly\ReadOnlyFilesystemAdapter($adapter);

// Instantiate the filesystem
$filesystem = new League\Flysystem\Filesystem($adapter);
```

--------------------------------

### Advanced usage with visibility converter and link handling

Source: https://flysystem.thephpleague.com/docs/adapter/local/

Configure the local adapter with a custom visibility converter, write flags, and link handling. The example uses LOCK_EX and DISALLOW_LINKS.

```php
use League\Flysystem\Local\LocalFilesystemAdapter;
use League\Flysystem\UnixVisibility\PortableVisibilityConverter;

// The internal adapter
$adapter = new LocalFilesystemAdapter(
    // Determine the root directory
    __DIR__.'/root/directory/',

    // Customize how visibility is converted to unix permissions
    PortableVisibilityConverter::fromArray([
        'file' => [
            'public' => 0640,
            'private' => 0604,
        ],
        'dir' => [
            'public' => 0740,
            'private' => 7604,
        ],
    ]),

    // Write flags
    LOCK_EX,

    // How to deal with links when listing directory contents, either DISALLOW_LINKS or SKIP_LINKS
    // Disallowing them causes exceptions when encountered
    LocalFilesystemAdapter::DISALLOW_LINKS
);

// The FilesystemOperator
$filesystem = new League\Flysystem\Filesystem($adapter);
```

--------------------------------

### Install Flysystem SFTP Adapter via Composer

Source: https://flysystem.thephpleague.com/docs/adapter/sftp-v2/

Use Composer to require the league/flysystem-sftp package version ^3.0. This adapter uses version 2 of phpseclib.

```bash
composer require league/flysystem-sftp:^3.0
```

--------------------------------

### Install Flysystem SFTP Adapter V3 via Composer

Source: https://flysystem.thephpleague.com/docs/adapter/sftp-v3/

Use Composer to require the league/flysystem-sftp-v3 package version ^3.0. This adapter uses version 3 of phpseclib.

```bash
composer require league/flysystem-sftp-v3:^3.0
```

--------------------------------

### FilesystemWriter::write example

Source: https://flysystem.thephpleague.com/docs/usage/filesystem-api/

Writes file contents as a string to the given path. The $config parameter is optional. Throws FilesystemException or UnableToWriteFile on error.

```php
try {
    $filesystem->write($path, $contents, $config);
} catch (FilesystemException | UnableToWriteFile $exception) {
    // handle the error
}
```

--------------------------------

### FilesystemWriter::writeStream example

Source: https://flysystem.thephpleague.com/docs/usage/filesystem-api/

Writes a file resource (stream) to the given path, which is more memory-efficient for large files. The $config parameter is optional. Throws FilesystemException or UnableToWriteFile on error.

```php
try {
    $filesystem->writeStream($path, $stream, $config);
} catch (FilesystemException | UnableToWriteFile $exception) {
    // handle the error
}
```

--------------------------------

### Advanced FTP Adapter Usage

Source: https://flysystem.thephpleague.com/docs/adapter/ftp/

Create an FTP adapter with custom connection provider, connectivity checker, and visibility converter. This allows modifying connection setup, connectivity checks, and permission handling.

```php
// The internal adapter
$adapter = new League\Flysystem\Ftp\FtpAdapter(
    // Connection options
    League\Flysystem\Ftp\FtpConnectionOptions::fromArray([
        'host' => 'hostname', // required
        'root' => '/root/path/', // required
        'username' => 'username', // required
        'password' => 'password', // required
    ]),
    new League\Flysystem\Ftp\FtpConnectionProvider(),
    new League\Flysystem\Ftp\NoopCommandConnectivityChecker(),
    new League\Flysystem\UnixVisibility\PortableVisibilityConverter()
);

// The FilesystemOperator
$filesystem = new League\Flysystem\Filesystem($adapter);
```

--------------------------------

### Set up SFTP Filesystem with SftpConnectionProvider and SftpAdapter

Source: https://flysystem.thephpleague.com/docs/adapter/sftp-v3/

Creates a Flysystem Filesystem instance using SftpAdapter and SftpConnectionProvider. The connection provider requires host and username, with optional password, private key, passphrase, port, agent, timeout, max tries, host fingerprint, and connectivity checker. The adapter requires a root path and a visibility converter for file and directory permissions.

```php
use League\Flysystem\Filesystem;
use League\Flysystem\PhpseclibV3\SftpConnectionProvider;
use League\Flysystem\PhpseclibV3\SftpAdapter;
use League\Flysystem\UnixVisibility\PortableVisibilityConverter;


$filesystem = new Filesystem(new SftpAdapter(
    new SftpConnectionProvider(
        'localhost', // host (required)
        'foo', // username (required)
        'pass', // password (optional, default: null) set to null if privateKey is used
        '/path/to/my/private_key', // private key (optional, default: null) can be used instead of password, set to null if password is set
        'my-super-secret-passphrase-for-the-private-key', // passphrase (optional, default: null), set to null if privateKey is not used or has no passphrase
        2222, // port (optional, default: 22)
        true, // use agent (optional, default: false)
        30, // timeout (optional, default: 10)
        10, // max tries (optional, default: 4)
        'fingerprint-string', // host fingerprint (optional, default: null),
        null, // connectivity checker (must be an implementation of 'League\Flysystem\PhpseclibV2\ConnectivityChecker' to check if a connection can be established (optional, omit if you don't need some special handling for setting reliable connections)
    ),
    '/upload', // root path (required)
    PortableVisibilityConverter::fromArray([
        'file' => [
            'public' => 0640,
            'private' => 0604,
        ],
        'dir' => [
            'public' => 0740,
            'private' => 7604,
        ],
    ])
));
```

--------------------------------

### Create GitlabAdapter and Filesystem

Source: https://flysystem.thephpleague.com/docs/adapter/gitlab/

Create a GitLab client, instantiate the adapter with an optional path prefix, and create a FilesystemOperator.

```php
// Create a Gitlab Client to talk with the API
$client = new Client('project-id', 'branch', 'base-url', 'personal-access-token');
   
// Create the Adapter that implements Flysystem's AdapterInterface
$adapter = new GitlabAdapter(
    // Gitlab API Client
    $client,
    // Optional path prefix
    'path/prefix',
);

// The FilesystemOperator
$filesystem = new League\Flysystem\Filesystem($adapter);
```

--------------------------------

### Create Filesystem with WebDAV Adapter

Source: https://flysystem.thephpleague.com/docs/adapter/webdav/

Set up a Flysystem instance with a WebDAV adapter. Requires a Sabre\DAV\Client configured with the server base URI and credentials. Note that visibility is not supported.

```php
<?php

use League\Flysystem\Filesystem;
use League\Flysystem\WebDAV\WebDAVAdapter;
use Sabre\DAV\Client;

include __DIR__ . '/vendor/autoload.php';

$client = new Client([
    'baseUri' => 'http://your-webdav-server.org/',
    'userName' => 'your_user',
    'password' => 'superSecret1234'
]);
$adapter = new WebDAVAdapter($client);
$filesystem = new Filesystem($adapter);
```

--------------------------------

### Create Filesystem with ZipArchiveAdapter

Source: https://flysystem.thephpleague.com/docs/adapter/zip-archive/

Instantiate a Flysystem filesystem using the ZipArchiveAdapter and FilesystemZipArchiveProvider. The $pathToZip variable must be defined beforehand.

```php
use League\Flysystem\Filesystem;
use League\Flysystem\ZipArchive\ZipArchiveAdapter;
use League\Flysystem\ZipArchive\FilesystemZipArchiveProvider;

$adapter = new ZipArchiveAdapter(
    new FilesystemZipArchiveProvider($pathToZip)
);
$filesystem = new Filesystem($adapter);
```

--------------------------------

### Get file size with FilesystemReader::fileSize

Source: https://flysystem.thephpleague.com/docs/usage/filesystem-api/

Retrieves the size of a file in bytes. Returns an integer. Throws FilesystemException or UnableToRetrieveMetadata on error.

```php
try {
    $fileSize = $filesystem->fileSize($path);
} catch (FilesystemException | UnableToRetrieveMetadata $exception) {
    // handle the error
}
```

--------------------------------

### Get mime type with FilesystemReader::mimeType

Source: https://flysystem.thephpleague.com/docs/usage/filesystem-api/

Retrieves the mime type of a file. Returns a string. Throws FilesystemException or UnableToRetrieveMetadata on error.

```php
try {
    $mimeType = $filesystem->mimeType($path);
} catch (FilesystemException | UnableToRetrieveMetadata $exception) {
    // handle the error
}
```

--------------------------------

### Simple usage of LocalFilesystemAdapter

Source: https://flysystem.thephpleague.com/docs/adapter/local/

Create a local filesystem adapter with a root directory and wrap it in a FilesystemOperator.

```php
// The internal adapter
$adapter = new League\Flysystem\Local\LocalFilesystemAdapter(
    // Determine root directory
    __DIR__.'/root/directory/'
);

// The FilesystemOperator
$filesystem = new League\Flysystem\Filesystem($adapter);
```

--------------------------------

### Simple usage of AsyncAwsS3Adapter

Source: https://flysystem.thephpleague.com/docs/adapter/async-aws-s3/

Create an S3Client, instantiate the AsyncAwsS3Adapter with a bucket name, and wrap it in a Filesystem instance for basic operations.

```php
$client = new AsyncAws\S3\S3Client();

// The internal adapter
$adapter = new League\Flysystem\AsyncAwsS3\AsyncAwsS3Adapter(
    // S3Client
    $client,
    // Bucket name
    'bucket-name'
);

// The FilesystemOperator
$filesystem = new League\Flysystem\Filesystem($adapter);
```

--------------------------------

### Get visibility with FilesystemReader::visibility

Source: https://flysystem.thephpleague.com/docs/usage/filesystem-api/

Retrieves the visibility of a file (e.g., public or private). Returns a string. Throws FilesystemException or UnableToRetrieveMetadata on error.

```php
try {
    $visibility = $filesystem->visibility($path);
} catch (FilesystemException | UnableToRetrieveMetadata $exception) {
    // handle the error
}
```

--------------------------------

### Use PathPrefixedAdapter

Source: https://flysystem.thephpleague.com/docs/adapter/path-prefixing/

Wrap an internal adapter with a path prefix and create a filesystem. The adapter is instantiated with the internal adapter and a prefix string, then passed to the Filesystem constructor.

```php
// The internal adapter, any
$adapter = new League\Flysystem\InMemory\InMemoryFilesystemAdapter();

// Turn it into a path-prefixed adapter
$adapter = new League\Flysystem\PathPrefixing\PathPrefixedAdapter($adapter, 'a/path/prefix');

// Instantiate the filesystem
$filesystem = new League\Flysystem\Filesystem($adapter);
```

--------------------------------

### V2 error handling with exceptions

Source: https://flysystem.thephpleague.com/docs/what-is-new/

In V2, all errors throw exceptions, so you only need a single try-catch block. This example shows the simplified pattern.

```php
try {
    $filesystem->write('path.txt', 'contents');
    // it is ok!
} catch (FilesystemException $exception) {
    // it failed!
}
```

--------------------------------

### Get last modified timestamp with FilesystemReader::lastModified

Source: https://flysystem.thephpleague.com/docs/usage/filesystem-api/

Retrieves the last modified timestamp of a file. Returns an integer. Throws FilesystemException or UnableToRetrieveMetadata on error.

```php
try {
    $lastModified = $filesystem->lastModified($path);
} catch (FilesystemException | UnableToRetrieveMetadata $exception) {
    // handle the error
}
```

--------------------------------

### Simple FTP Adapter Usage

Source: https://flysystem.thephpleague.com/docs/adapter/ftp/

Create an FTP adapter with connection options and wrap it in a Filesystem operator. Required options are host, root, username, and password. Optional options include port, ssl, timeout, utf8, passive, transferMode, systemType, ignorePassiveAddress, timestampsOnUnixListingsEnabled, and recurseManually.

```php
// The internal adapter
$adapter = new League\Flysystem\Ftp\FtpAdapter(
    // Connection options
    League\Flysystem\Ftp\FtpConnectionOptions::fromArray([
        'host' => 'hostname', // required
        'root' => '/root/path/', // required
        'username' => 'username', // required
        'password' => 'password', // required
        'port' => 21,
        'ssl' => false,
        'timeout' => 90,
        'utf8' => false,
        'passive' => true,
        'transferMode' => FTP_BINARY,
        'systemType' => null, // 'windows' or 'unix'
        'ignorePassiveAddress' => null, // true or false
        'timestampsOnUnixListingsEnabled' => false, // true or false
        'recurseManually' => true // true 
    ])
);

// The FilesystemOperator
$filesystem = new League\Flysystem\Filesystem($adapter);
```

--------------------------------

### V1 error handling with success boolean

Source: https://flysystem.thephpleague.com/docs/what-is-new/

In V1, you had to check the return value of write() and also catch exceptions, leading to duplicated error handling. This example shows the old pattern.

```php
try {
    $success = $filesystem->write('path.txt', 'contents');

    if ($success) {
        // it is ok!
    } else {
        // it failed!
    }
} catch (Throwable $exception) {
    // it failed! (in a different way)
}
```

--------------------------------

### Retrieve checksum with optional algorithm

Source: https://flysystem.thephpleague.com/docs/usage/checksums/

Use the `checksum` method to get a file's checksum. By default, the adapter's native checksum type (e.g., etag or md5) is returned. You can specify a different algorithm by passing the `checksum_algo` option in the method call.

```php
$checksum = $filesystem->checksum('path/to/file.txt'); // etag or md5

// you can specify the algo during the method call too
$checksum = $filesystem->checksum('path/to/file.txt', ['checksum_algo' => 'sha1']);
```

--------------------------------

### Use SimpleS3Client with AsyncAwsS3Adapter

Source: https://flysystem.thephpleague.com/docs/adapter/async-aws-s3/

Create a SimpleS3Client and use it with the adapter to support large file uploads and a user-friendly interface.

```php
$client = new AsyncAws\SimpleS3\SimpleS3Client();
$adapter = new League\Flysystem\AsyncAwsS3\AsyncAwsS3Adapter($client, 'bucket-name');
$filesystem = new League\Flysystem\Filesystem($adapter);
```

--------------------------------

### Specifying your own portable visibility with PortableVisibilityConverter::fromArray

Source: https://flysystem.thephpleague.com/docs/usage/unix-visibility/

Use PortableVisibilityConverter::fromArray to define custom public and private permissions for files and directories. The example sets file permissions to 0640 (public) and 0604 (private), and directory permissions to 0740 (public) and 7604 (private).

```php
use League\Flysystem\UnixVisibility\PortableVisibilityConverter;

$visibilityConverter = PortableVisibilityConverter::fromArray([
    'file' => [
        'public' => 0640,
        'private' => 0604,
    ],
    'dir' => [
        'public' => 0740,
        'private' => 7604,
    ],
]);
```

--------------------------------

### Simple usage of GridFS adapter

Source: https://flysystem.thephpleague.com/docs/adapter/gridfs/

Create a MongoDB client, instantiate the GridFS adapter with a GridFS bucket, and wrap it in a FilesystemOperator.

```php
$client = new MongoDB\Client('mongodb://localhost:27017/');

// The internal adapter
$adapter = new League\Flysystem\GridFS\GridFSAdapter(
    // GridFS Bucket
    $client->selectDatabase('flysystem')->selectGridFSBucket()
);

// The FilesystemOperator
$filesystem = new League\Flysystem\Filesystem($adapter);
```

--------------------------------

### Configure SFTP Adapter with Connection Provider and Visibility Converter

Source: https://flysystem.thephpleague.com/docs/adapter/sftp-v2/

Sets up a Flysystem Filesystem with an SftpAdapter using an SftpConnectionProvider. The provider accepts host, username, password or private key, passphrase, port, agent flag, timeout, max tries, host fingerprint, and an optional connectivity checker. The root path is '/upload' and visibility permissions are defined for files and directories.

```php
use League\Flysystem\Filesystem;
use League\Flysystem\PhpseclibV2\SftpConnectionProvider;
use League\Flysystem\PhpseclibV2\SftpAdapter;
use League\Flysystem\UnixVisibility\PortableVisibilityConverter;


$filesystem = new Filesystem(new SftpAdapter(
    new SftpConnectionProvider(
        'localhost', // host (required)
        'foo', // username (required)
        'pass', // password (optional, default: null) set to null if privateKey is used
        '/path/to/my/private_key', // private key (optional, default: null) can be used instead of password, set to null if password is set
        'my-super-secret-passphrase-for-the-private-key', // passphrase (optional, default: null), set to null if privateKey is not used or has no passphrase
        2222, // port (optional, default: 22)
        true, // use agent (optional, default: false)
        30, // timeout (optional, default: 10)
        10, // max tries (optional, default: 4)
        'fingerprint-string', // host fingerprint (optional, default: null),
        null, // connectivity checker (must be an implementation of 'League\Flysystem\PhpseclibV2\ConnectivityChecker' to check if a connection can be established (optional, omit if you don't need some special handling for setting reliable connections)
    ),
    '/upload', // root path (required)
    PortableVisibilityConverter::fromArray([
        'file' => [
            'public' => 0640,
            'private' => 0604,
        ],
        'dir' => [
            'public' => 0740,
            'private' => 7604,
        ],
    ])
));
```

--------------------------------

### Sync strategy using listContents and fileExists

Source: https://flysystem.thephpleague.com/docs/advanced/mount-manager/

Iterates over files in a local directory, checks if the corresponding storage path exists and if the local file is newer, then writes the file to the storage file system. Uses preg_replace to convert the URI prefix from 'local://' to 'storage://'.

```php
$contents = $manager->listContents('local://uploads', true);

foreach ($contents as $entry) {
    $update = false;
    $storagePath = preg_replace('{^local://}', 'storage://', $entry->path());

    if ( ! $manager->fileExists($storagePath)) {
        $update = true;
    } elseif ($manager->lastModified($entry->path()) > $manager->lastModified($storagePath)) {
        $update = true;
    }

    if ($update) {
        $manager->write($storagePath, $manager->read($entry->path()));
    }
}
```

--------------------------------

### Create InMemoryFilesystemAdapter and Filesystem

Source: https://flysystem.thephpleague.com/docs/adapter/in-memory/

Instantiate the internal adapter and wrap it in a FilesystemOperator. Use this in tests as a test double to avoid mocking Flysystem.

```php
// The internal adapter
$adapter = new League\Flysystem\InMemory\InMemoryFilesystemAdapter();

// The FilesystemOperator
$filesystem = new League\Flysystem\Filesystem($adapter);
```

--------------------------------

### Advanced usage of AsyncAwsS3Adapter

Source: https://flysystem.thephpleague.com/docs/adapter/async-aws-s3/

Configure the adapter with an optional path prefix and a visibility converter, using PortableVisibilityConverter with a default visibility for directories.

```php
$client = new AsyncAws\S3\S3Client();

// The internal adapter
$adapter = new League\Flysystem\AsyncAwsS3\AsyncAwsS3Adapter(
    // S3Client
    $client,
    // Bucket name
    'bucket-name',
    // Optional path prefix
    'path/prefix',
    // Visibility converter (League\Flysystem\AsyncAwsS3\VisibilityConverter)
    new League\Flysystem\AsyncAwsS3\PortableVisibilityConverter(
        // Optional default for directories
        League\Flysystem\Visibility::PUBLIC // or ::PRIVATE
    )
);

// The FilesystemOperator
$filesystem = new League\Flysystem\Filesystem($adapter);
```

--------------------------------

### FilesystemWriter::createDirectory

Source: https://flysystem.thephpleague.com/docs/usage/filesystem-api/

Creates a directory at the given path with optional configuration. Throws FilesystemException or UnableToCreateDirectory on failure.

```APIDOC
## FilesystemWriter::createDirectory

### Description
Creates a directory at the given path.

### Method
createDirectory

### Parameters
- **$path** (string) - Required - Location of a file
- **$config** (array) - Required - Config array

### Exceptions
- FilesystemException
- UnableToCreateDirectory

### Example
```php
try {
    $filesystem->createDirectory($path, $config);
} catch (FilesystemException | UnableToCreateDirectory $exception) {
    // handle the error
}
```
```

--------------------------------

### Filesystem constructor with checksum_algo

Source: https://flysystem.thephpleague.com/docs/usage/checksums/

Configures the default checksum algorithm for a Filesystem instance.

```APIDOC
## Filesystem constructor with checksum_algo

### Description
Creates a new Filesystem instance with a default checksum algorithm. This default is used when calling the `checksum` method without specifying an algorithm.

### Method
new Filesystem

### Endpoint
new Filesystem($adapter, array $config = [])

### Parameters
#### Parameters
- **adapter** (AdapterInterface) - Required - The filesystem adapter.
- **config** (array) - Optional - Configuration options. May include 'checksum_algo' to set the default checksum algorithm.

### Request Example
```php
use League\Flysystem\Filesystem;

$filesystem = new Filesystem(
    $adapter,
    ['checksum_algo' => 'sha256']
);
```

### Response
#### Success Response
- **Filesystem** - The configured Filesystem instance.

#### Response Example
```php
$checksum = $filesystem->checksum('path/to/file.txt'); // always sha256
```
```

--------------------------------

### Reading and writing across file systems

Source: https://flysystem.thephpleague.com/docs/advanced/mount-manager/

Shows how to read a file from an FTP file system and write the contents to a local file system using the MountManager. The URI scheme (e.g., 'ftp://', 'local://') determines the target file system.

```php
// Read from FTP
$contents = $manager->read('ftp://some/file.txt');

// And write to local
$manager->write('local://put/it/here.txt', $contents);
```

--------------------------------

### FilesystemWriter::createDirectory - Create a directory

Source: https://flysystem.thephpleague.com/docs/usage/filesystem-api/

Creates a directory at the given path with optional config array. Throws FilesystemException or UnableToCreateDirectory on failure.

```php
try {
    $filesystem->createDirectory($path, $config);
} catch (FilesystemException | UnableToCreateDirectory $exception) {
    // handle the error
}
```

--------------------------------

### Implement a custom public URL generator

Source: https://flysystem.thephpleague.com/docs/usage/public-urls/

Create a custom public URL generator by implementing the PublicUrlGenerator interface and passing it as the publicUrlGenerator parameter to the Filesystem constructor. The publicUrl method must return a string.

```php
use League\Flysystem\Config;
use League\Flysystem\Filesystem;
use League\Flysystem\UrlGeneration\PublicUrlGenerator;

$filesystem = new Filesystem(
    $adapter,
    publicUrlGenerator: new class() implements PublicUrlGenerator
    {
        public function publicUrl(string $path, Config $config): string
        {
            // implement your own public URL generation
        }
    }
);
```

--------------------------------

### Map directory listing to paths with map method

Source: https://flysystem.thephpleague.com/docs/usage/directory-listings/

Transforms a directory listing by filtering files and mapping to their paths, then converts to an array.

```php
/** @var string[] $allPaths */
$allPaths = $filesystem->listContents('/some/path')
    ->filter(fn (StorageAttributes $attributes) => $attributes->isFile())
    ->map(fn (StorageAttributes $attributes) => $attributes->path())
    ->toArray();
```

--------------------------------

### Advanced usage of GridFS adapter with bucket name and path prefix

Source: https://flysystem.thephpleague.com/docs/adapter/gridfs/

Create a GridFS adapter with a custom bucket name and an optional path prefix, then wrap it in a FilesystemOperator.

```php
$client = new MongoDB\Client('mongodb://localhost:27017/');

// The internal adapter
$adapter = new League\Flysystem\GridFS\GridFSAdapter(
    // GridFS Bucket
    $client->selectDatabase('flysystem')->selectGridFSBucket([
        // Bucket name in the MongoDB database
        'bucketName' => 'project_files'
    ])
    // Optional path prefix
    'path/prefix',
);

// The FilesystemOperator
$filesystem = new League\Flysystem\Filesystem($adapter);
```

--------------------------------

### FilesystemWriter::copy - Copy a file

Source: https://flysystem.thephpleague.com/docs/usage/filesystem-api/

Copies a file from source to destination. Overwrites target and creates parent directories as needed. Throws FilesystemException or UnableToCopyFile on failure.

```php
try {
    $filesystem->copy($source, $destination, $config);
} catch (FilesystemException | UnableToCopyFile $exception) {
    // handle the error
}
```

--------------------------------

### Configure a base URL prefix for public URL generation

Source: https://flysystem.thephpleague.com/docs/usage/public-urls/

For adapters that do not provide public URLs, configure a base URL in the main Filesystem configuration using the 'public_url' option. This prefix is prepended to the file path to generate the public URL.

```php
use League\Flysystem\Filesystem;

$filesystem = new Filesystem(
    $adapter,
    ['public_url' => 'https://example.org/assets/']
);
```

--------------------------------

### Read file contents with FilesystemReader::read

Source: https://flysystem.thephpleague.com/docs/usage/filesystem-api/

Reads the entire file contents as a string. Throws FilesystemException or UnableToReadFile on failure. The $path parameter is the file location and $response contains the file contents.

```php
try {
    $response = $filesystem->read($path);
} catch (FilesystemException | UnableToReadFile $exception) {
    // handle the error
}
```

--------------------------------

### Generate a public URL with publicUrl method

Source: https://flysystem.thephpleague.com/docs/usage/public-urls/

Use the publicUrl method on the filesystem instance to generate a public URL for a given path. This is the basic usage for adapters that support URL generation.

```php
$publicUrl = $filesystem->publicUrl('path/to/file.txt');
```

--------------------------------

### FilesystemWriter::copy

Source: https://flysystem.thephpleague.com/docs/usage/filesystem-api/

Copies a file from source to destination, overwriting the target and creating parent directories as needed. Throws FilesystemException or UnableToCopyFile on failure.

```APIDOC
## FilesystemWriter::copy

### Description
Copies a file from source to destination. This operation is deterministic: it always overwrites the target location and creates parent directories if needed.

### Method
copy

### Parameters
- **$source** (string) - Required - Location of a file
- **$destination** (string) - Required - Location for the file copy
- **$config** (array) - Optional - Config array

### Exceptions
- FilesystemException
- UnableToCopyFile

### Example
```php
try {
    $filesystem->copy($source, $destination, $config);
} catch (FilesystemException | UnableToCopyFile $exception) {
    // handle the error
}
```
```
Tokens:
Raw