OneupFlysystemBundle Documentation

Instead of using the service locator (container), it is recommended to inject filesystems directly into your services via Dependency Injection.

When injecting, use the resolved service name (e.g., @oneup_flysystem.acme_filesystem) or the alias you defined. In your PHP class, type-hint against \League\Flysystem\FilesystemOperator.

Symfony 4.2+ Tip: You can use automatic dependency injection by type-hinting the specific filesystem. For a filesystem named acme, you can type-hint AcmeFilesystem (or similar depending on your autowiring setup) if you leverage ContainerBuilder::registerAliasForArgument().

services:
    app.my_service:
        class: App\MyService
        arguments:
            - '@oneup_flysystem.acme_filesystem'

use League\Flysystem\FilesystemOperator;

class MyService
{
    private FilesystemOperator $filesystem;

    public function __construct(FilesystemOperator $acmeFilesystem)
    {
        $this->filesystem = $acmeFilesystem;
    }
}

To use the awss3v3 adapter, you must first define an Aws\S3\S3Client as a service in your Symfony configuration. This adapter requires the aws/aws-sdk-php package (version 3 or higher) and uses the 'v4' signature.

You must also define a League\Flysystem\AwsS3V3\PortableVisibilityConverter service to handle file visibility.

Once the services are defined, register the adapter under oneup_flysystem.adapters by referencing the S3 client service in the client key.

services:
    acme.awss3v3.portable_visibility_converter:
        class: League\Flysystem\AwsS3V3\PortableVisibilityConverter

    acme.s3_client:
        class: Aws\S3\S3Client
        arguments:
            -
                version: '2006-03-01' # or 'latest'
                region: "region-id"
                credentials:
                    key: "s3-key"
                    secret: "s3-secret"

oneup_flysystem:
    adapters:
        acme.flysystem_adapter:
            awss3v3:
                client: acme.s3_client
                bucket: 'bucket-name'
                prefix: 'path/prefix' # Optional path prefix
                visibilityConverter: acme.awss3v3.portable_visibility_converter

To use the async_aws_s3 adapter, you must first define an AsyncAws\S3\S3Client service in your Symfony service container. You can configure this service manually or use the AsyncAws SymfonyBundle.

Once the client is defined, you must also provide a visibilityConverter (typically League\Flysystem\AsyncAwsS3\PortableVisibilityConverter) to handle file visibility settings.

Finally, register the adapter under oneup_flysystem.adapters by referencing your S3 client service via the client key.

# 1. Define the S3 Client and Visibility Converter services
services:
    acme.async.portable_visibility_converter:
        class: League\Flysystem\AsyncAwsS3\PortableVisibilityConverter

    acme.async_s3_client:
        class: AsyncAws\S3\S3Client
        arguments:
            - region: 'eu-central-1'
              accessKeyId: 'AKIAIOSFODNN7EXAMPLE'
              accessKeySecret: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'

# 2. Configure the OneupFlysystem adapter
oneup_flysystem:
    adapters:
        acme.flysystem_adapter:
            async_aws_s3:
                client: acme.async_s3_client
                bucket: 'my_image_bucket'
                prefix: ''
                visibilityConverter: acme.async.portable_visibility_converter

To use the GitLab adapter, you must first define a GitLab client service in your Symfony service container and then reference that service within the oneup_flysystem configuration.

1. Define the GitLab client service: Create a service using the RoyVoetman\FlysystemGitlab\Client class. You must provide the project-id, branch, base-url, and personal-access-token as arguments.
2. Register the adapter: In your oneup_flysystem configuration, define an adapter under adapters and set the client key to the service ID of your GitLab client. You can optionally provide a prefix for a path prefix within the repository.

# 1. Define the GitLab client service
services:
    acme.gitlab_client:
        class: RoyVoetman\FlysystemGitlab\Client
        arguments:
            - 'project-id'
            - 'branch'
            - 'base-url'
            - 'personal-access-token'

# 2. Configure the OneupFlysystem adapter
oneup_flysystem:
    adapters:
        acme.gitlab_adapter:
            gitlab:
                client: acme.gitlab_client
                prefix: 'optional/path/prefix'