Download the PHP package webalternatif/flysystem-failover-bundle without Composer

Flysystem failover bundle

This bundle allows creating failover Flysystem adapters and provides tooling to keep underlying storages synchronized.

💡 Tip: you may want to use this bundle through webalternatif/flysystem-dsn-bundle, which makes the configuration much easier.

How it works

This bundle allows you to create failover adapters for Flysystem. A failover adapter is an adapter that is built upon multiple (already existing) adapters.

When you use a failover adapter, it will forward method calls to inner adapters.

• For reading, it will use the first that works.
• For writing, it will use the first that works and will push messages into a repository to keep underlying storages of all adapters synchronized.

Messages in the repository can then be asynchronously processed by a console command call (see Processing messages section).

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:

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:

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:

Usage

Configuration

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

Each failover adapter must have at least 2 inner adapters. An inner adapter could be a string to reference a service id, or an array with the following attributes:

• service_id: (required) identifier of the inner adapter service,
• time_shift: a time shift for when the synchronization command compares modification dates between inner adapters.

Message repository is customizable under the webf_flysystem_failover.message_repository_dsn Symfony config path. For now, only doctrine://<connection_name> and service://<service_id> are available.

Run bin/console config:dump-reference webf_flysystem_failover for more info.

Processing messages

To process messages created by failover adapters, the following command is available:

It will process and remove the oldest messages present in the repository.

Listing messages to be processed

To list messages without removing them from the repository, run the following command:

Results are paginated by default, you can use --limit (-l) and --page (-p) to configure pagination.

If symfony/serializer is installed, the --format (-f) becomes available and allows you to display output in csv, json or xml.

Use --help for more info.

Synchronize existing storages

If you start to use this bundle on an existing project, you may want to manually synchronize an existing non-empty storage with other new empty ones.

It is possible with the following command:

Use --help for more info.

Tests

To run all tests, execute the command:

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