FlySystemLocalFilesystemFactory.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Filesystem\Provider\FlySystem;

use ILIAS\Filesystem\FilesystemFacade;
use ILIAS\Filesystem\Provider\Configuration\LocalConfig;
use League\Flysystem\Adapter\Local;
use League\Flysystem\Local\LocalFilesystemAdapter;
use League\Flysystem\UnixVisibility\PortableVisibilityConverter;

final class FlySystemLocalFilesystemFactory
{
    public const PRIVATE_ACCESS_KEY = 'private';
    public const PUBLIC_ACCESS_KEY = 'public';
    public const FILE_ACCESS_KEY = 'file';
    public const DIRECTORY_ACCESS_KEY = 'dir';

    public function getInstance(LocalConfig $config): \ILIAS\Filesystem\FilesystemFacade
    {
        $this->validateFileLockMode($config->getLockMode());

        $visibility = new PortableVisibilityConverter(
            $config->getFileAccessPublic(),
            $config->getFileAccessPrivate(),
            $config->getDirectoryAccessPublic(),
            $config->getDirectoryAccessPrivate()
        );

        $adapter = new LocalFilesystemAdapter(
            $config->getRootPath(),
            $visibility,
            $config->getLockMode(),
            $this->mapConfigLinkToLocalLinks($config->getLinkBehaviour())
        );

        $filesystem = new \League\Flysystem\Filesystem($adapter);

        $fileAccess = new FlySystemFileAccess($filesystem);

        return new FilesystemFacade(
            new FlySystemFileStreamAccess($filesystem),
            $fileAccess,
            new FlySystemDirectoryAccess($filesystem, $fileAccess)
        );
    }

    private function mapConfigLinkToLocalLinks(int $configLinkBehaviour): int
    {
        return match ($configLinkBehaviour) {
            LocalConfig::DISALLOW_LINKS => LocalFilesystemAdapter::DISALLOW_LINKS,
            LocalConfig::SKIP_LINKS => LocalFilesystemAdapter::SKIP_LINKS,
            default => throw new \InvalidArgumentException(
                "The supplied value \"$configLinkBehaviour\" is not a valid LocalConfig link behaviour constant."
            ),
        };
    }

    private function validateFileLockMode(int $code): void
    {
        if ($code === LOCK_EX) {
            return;
        }
        if ($code === LOCK_SH) {
            return;
        }
        throw new \InvalidArgumentException(
            "The supplied value \"$code\" is not a valid file lock mode please check your local file storage configurations."
        );
    }
}