Filesystem Config

Convenience configuration

The filesystem consist of many components:

• several storage adapters (League\Flysystem\FilesystemAdapter),
• a Contao\CoreBundle\Filesystem\MountManager, where adapters are mounted,
• one or more DBAFS services (Contao\CoreBundle\Filesystem\Dbafs\DbafsInterface),
• a Contao\CoreBundle\Filesystem\Dbafs\DbafsManager, where DBAFS services are registered,
• and finally some virtual filesystems (Contao\CoreBundle\Filesystem\VirtualFilesystemInterface) as consumer endpoints.

In case of our DBAFS implementation (Contao\CoreBundle\Filesystem\Dbafs\Dbafs), each instance also needs an individual hash generator (Contao\CoreBundle\Filesystem\Dbafs\Hashing\HashGeneratorInterface).

We need this level of detail to support all use cases, but wanted to offer a convenient way to add and adjust the setup in your extensions and applications. That’s why we added a FilesystemConfiguration class, that gets constructed with a ContainerBuilder instance and provides convenience methods that orchestrate everything you need in the background.

In a Bundle

To use the FilesystemConfiguration in your bundle, implement the ConfigureFilesystemInterface in your extension class:

// src/DependencyInjection/MyFooBundleExtension.php
namespace My\FooBundle\DependencyInjection;

use Contao\CoreBundle\DependencyInjection\Filesystem\ConfigureFilesystemInterface;
use Contao\CoreBundle\DependencyInjection\Filesystem\FilesystemConfiguration;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;

class MyFooBundleExtension extends Extension implements ConfigureFilesystemInterface 
{
    public function configureFilesystem(FilesystemConfiguration $config): void
    {
        // Configure the filesystem here
    }
    
    // …
}

In your Application

In your application in the Contao Managed Edition, you’ll need to adjust the global manager plugin instead by implementing the ConfigPluginInterface and creating the FilesystemConfiguration yourself. Because plugins are handled before extensions, we need to register a compiler pass (can be an anonymous class):

// src/ContaoManager/Plugin.php
namespace App\ContaoManager;

use Contao\CoreBundle\DependencyInjection\Filesystem\FilesystemConfiguration;
use Contao\ManagerPlugin\Config\ConfigPluginInterface;
use Symfony\Component\Config\Loader\LoaderInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;

class Plugin implements ConfigPluginInterface
{
    public function registerContainerConfiguration(LoaderInterface $loader, array $managerConfig)
    {
        $configureFilesystemPass = new class implements CompilerPassInterface {
            public function process(ContainerBuilder $container)
            {
                $config = new FilesystemConfiguration($container);
                // Configure the filesystem here
            }
        };
        
        $loader->load(static function (ContainerBuilder $container) use ($configureFilesystemPass) {
            $container->addCompilerPass($configureFilesystemPass);
        });
    }
}

Reference

When using addVirtualFilesystem and addDefaultDbafs(), the preconfigured Definition is returned. If you want to tweak it (e.g. if you want to adjust the DBAFS defaults), just add methods calls yourself:

// Manually adjust a configuration, if needed
$config
  ->addDefaultDbafs(…)
  ->registerMethodCall('setMaxFileSize', [1048576])
;

Example

Here is how you could make your automatic database backups be stored on a remote server via SFTP. The first two arguments are directly passed to the Flysystem adapter (see Flysystem docs for more information):

// Mount an SFTP adapter to `/backups`.
$config->mountAdapter(
    'sftp',         
    ['host' => 'example.com', 'port' => 22, 'username' => 'foobar', 'password' => 's3cr3t'],
    'backups'
);