webalternatif/flysystem-dsn-bundle

A bundle to build Flysystem adapters from DSN.

v0.3.5 2021-12-30 22:35 UTC

This package is auto-updated.

Last update: 2022-04-29 10:00:05 UTC


README

Source code Packagist Version Software license GitHub issues
Test status Psalm coverage Psalm level Infection MSI

This bundle integrates the Flysystem DSN library with Symfony, allowing the creation of adapters as services with DSN from the configuration.

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

composer require webalternatif/flysystem-dsn-bundle

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

composer require webalternatif/flysystem-dsn-bundle

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    Webf\Flysystem\DsnBundle\WebfFlysystemDsnBundle::class => ['all' => true],
];

Usage

Adapters are configured under the webf_flysystem_dsn.adapters Symfony config path, and are then available as services with id webf_flysystem_dsn.adapter.{name}:

webf_flysystem_dsn:
    adapters:
        adapter1: '%env(STORAGE1_DSN)%' # service: webf_flysystem_dsn.adapter.adapter1
        adapter2: '%env(STORAGE2_DSN)%' # service: webf_flysystem_dsn.adapter.adapter2

In addition to available adapters from webalternatif/flysystem-dsn, this bundle provides a Symfony-specific DSN service://service_id to which you must provide an identifier that references an external service (that must be a Flysystem adapter). It could be useful if you already have adapter services, and you want to inject them into a composed adapter like failover: failover(service://external_service_id ...).

Integration with Flysystem bundles

As explained above, this bundle only provides services that are Flysystem adapters, but they're not usable as is. Generally you'll have to use another bundle that provide FilesystemOperator instances.

The two best known are oneup/flysystem-bundle and league/flysystem-bundle, here is some examples of configuration for those two bundles (considering the webf_flysystem_dsn configuration above).

oneup/flysystem-bundle

oneup_flysystem:
    adapters:
        adapter1:
            custom:
                service: webf_flysystem_dsn.adapter.adapter1
        adapter2:
            custom:
                service: webf_flysystem_dsn.adapter.adapter2

    filesystems:
        storage1:
            adapter: adapter1
        storage2:
            adapter: adapter2

league/flysystem-bundle

flysystem:
    storages:
        storage1:
            adapter: webf_flysystem_dsn.adapter.adapter1
        storage2:
            adapter: webf_flysystem_dsn.adapter.adapter2

Integration with webalternatif/flysystem-failover-bundle

If webalternatif/flysystem-failover-bundle is installed, the failover DSN function becomes available and all configured failover adapters are registered so that they can be used in webf:flysystem-failover:* Symfony commands.

Using failover DSN function nested in others

In order to use the failover DSN function as parameter of other DSN functions, adapters created by the corresponding factories must implement CompositeFilesystemAdapter from webalternatif/flysystem-composite. Without that, the bundle wouldn't be able to register them, and they won't be usable in webf:flysystem-failover:* Symfony commands.

Using your own DSN

If you want to use your own DSN to build your own Flysystem adapters, you can create an adapter factory service that implement Webf\Flysystem\Dsn\FlysystemAdapterFactoryInterface.

To register the factory, either you have autoconfiguration enabled, or you have to tag your service with webf_flysystem_dsn.adapter_factory (also available in PHP with Webf\Flysystem\DsnBundle\DependencyInjection\WebfFlysystemDsnExtension::ADAPTER_FACTORY_TAG_NAME).

Tests

To run all tests, execute the command:

composer test

This will run Psalm, PHPUnit, Infection and a PHP-CS-Fixer check, but you can run them individually like this:

composer psalm
composer phpunit
composer infection
composer cs-check