Skip to content

judus/argon-filesystem

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

argon-filesystem

PHP Build codecov Psalm Level Latest Version Total Downloads License: MIT

Flysystem storage disk integration for the Argon runtime stack.

Installation

composer require maduser/argon-filesystem

The local adapter is installed with this package. Other adapters remain application-owned:

composer require league/flysystem-aws-s3-v3
composer require league/flysystem-sftp-v3
composer require league/flysystem-ftp

Service Providers

Register FilesystemServiceProvider, then configure disks from an application service provider.

use League\Flysystem\Filesystem;
use League\Flysystem\Local\LocalFilesystemAdapter;
use Maduser\Argon\Container\AbstractServiceProvider;
use Maduser\Argon\Container\ArgonContainer;
use Maduser\Argon\Filesystem\FilesystemDiskRegistry;
use Maduser\Argon\Filesystem\Provider\FilesystemServiceProvider;

final class AppServiceProvider extends AbstractServiceProvider
{
    #[\Override]
    public function register(ArgonContainer $container): void
    {
        $container->register(FilesystemServiceProvider::class);
        $container->register(StorageServiceProvider::class);
    }
}

final class StorageServiceProvider extends AbstractServiceProvider
{
    #[\Override]
    public function register(ArgonContainer $container): void
    {
        $basePath = $container->getParameters()->get('basePath');
        assert(is_string($basePath));

        $container->get(FilesystemDiskRegistry::class)
            ->add('local', new Filesystem(new LocalFilesystemAdapter($basePath . '/storage/app')))
            ->setDefault('local');
    }
}

Usage

Resolve the manager for named disks:

use Maduser\Argon\Filesystem\FilesystemManager;

$storage = $container->get(FilesystemManager::class);

$storage->disk('local')->write('notes/hello.txt', 'Argon');

Resolve League\Flysystem\FilesystemOperator when a service only needs the default disk:

use League\Flysystem\FilesystemOperator;

$filesystem = $container->get(FilesystemOperator::class);

$contents = $filesystem->read('notes/hello.txt');

Boundaries

  • This package wires Flysystem into Argon. It does not define a storage DSL.
  • Applications own adapter packages, credentials, paths, buckets, and visibility rules.
  • Configuration is explicit service-provider code, not automatic file discovery.
  • FilesystemOperator resolves to the configured default disk. Use FilesystemManager for named disks.

Quality Gates

composer check
composer test:coverage
composer psalm
composer phpcs

About

Flysystem storage disk integration for the Argon runtime stack.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages