PHPackages                             yiisoft/yii-filesystem - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. yiisoft/yii-filesystem

AbandonedArchivedLibrary[Framework](/categories/framework)

yiisoft/yii-filesystem
======================

yii-filesystem

1673.5k—0%11[3 issues](https://github.com/yiisoft/yii-filesystem/issues)[1 PRs](https://github.com/yiisoft/yii-filesystem/pulls)PHP

Since Oct 15Pushed 3y ago14 watchersCompare

[ Source](https://github.com/yiisoft/yii-filesystem)[ Packagist](https://packagist.org/packages/yiisoft/yii-filesystem)[ RSS](/packages/yiisoft-yii-filesystem/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (2)Used By (0)

  **This package is deprecated. Use  directly.**

 ❌

---

 [ ![](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft)

Yii filesystem
==============

[](#yii-filesystem)

An abstract filesystem that allows to swap underlying file system without rewriting application code. Based on [Flysystem](https://flysystem.thephpleague.com/v2/docs/).

[![Latest Stable Version](https://camo.githubusercontent.com/bd88c57c1f1441295c16d92637aa39d7b4dfe02205ff358227ebc14fd315f138/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f7969692d66696c6573797374656d2f762f737461626c652e706e67)](https://packagist.org/packages/yiisoft/yii-filesystem)[![Total Downloads](https://camo.githubusercontent.com/cedc7f90f01f3d095839f71a48fb161a70fc8ce3020e0552e44d03d72df191b9/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f7969692d66696c6573797374656d2f646f776e6c6f6164732e706e67)](https://packagist.org/packages/yiisoft/yii-filesystem)[![Build status](https://github.com/yiisoft/yii-filesystem/workflows/build/badge.svg)](https://github.com/yiisoft/yii-filesystem/actions?query=workflow%3Abuild)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/8eed65d60e2e1ba177af575808cd979c71fe65146ca77ec3f67469e5fb8fb27e/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f796969736f66742f7969692d66696c6573797374656d2f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/yiisoft/yii-filesystem/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/8f2f7b4e1fe66bb32139bb4bff42a460238870221271c60a973e315d916180cc/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f796969736f66742f7969692d66696c6573797374656d2f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/yiisoft/yii-filesystem/?branch=master)[![Mutation testing badge](https://camo.githubusercontent.com/78304dc6b2b4d4b45d1eaa1bab6ba7e63f2556c70ada893a6983ecd61c01a6f0/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f66742532467969692d66696c6573797374656d2532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/yii-filesystem/master)[![static analysis](https://github.com/yiisoft/yii-filesystem/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/yii-filesystem/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/72044b474eb3ea39d8a756ed6f8a7a50d402afce26bfdd1832a4a8ef7fbff18c/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f7969692d66696c6573797374656d2f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/yii-filesystem)

Requirements
------------

[](#requirements)

The package requires PHP 8.0 and is meant to be used with Yii3.

Installation
------------

[](#installation)

```
composer require yiisoft/yii-filesystem

```

After installation, the `Yiisoft\Yii\Filesystem\FilesystemInterface` will be automatically registered in the main application container. This interface provides a local filesystem with root, as defined in the `@root` alias of the `aliases` parameter.

Getting started
---------------

[](#getting-started)

The service could be obtained via DI container autowiring:

```
public function view(\Yiisoft\Yii\Filesystem\FilesystemInterface $filesystem)
{
    $someFileContent = $filesystem->read('/runtime/somefile.txt');
    //...
}
```

Also you can use aliases

```
$someFileContent = $filesystem->write('@views/site/testfile.txt', 'Test content');
```

Configuration
-------------

[](#configuration)

Additional filesystems could be configured in `config/params.php` as described below:

```
'file.storage' => [
    'runtimeStorage' => [
        'adapter' => [
            'class' => \League\Flysystem\Local\LocalFilesystemAdapter::class,
            '__construct()' => [
                dirname(__DIR__) . '/runtime',
                \League\Flysystem\UnixVisibility\PortableVisibilityConverter::fromArray([
                    'file' => [
                        'public' => 0644,
                        'private' => 0600,
                    ],
                    'dir' => [
                        'public' => 0755,
                        'private' => 0700,
                    ],
                ]),
                LOCK_EX,
                \League\Flysystem\Local\LocalFilesystemAdapter::DISALLOW_LINKS
            ]
        ],
        'aliases' => [
            '@cache' => '@root/cache',
        ]
    ],
    'documentStorage' => [
        'adapter' => [
            'class' => \League\Flysystem\Local\LocalFilesystemAdapter::class,
            '__construct()' => [
                dirname(__DIR__) . '/docs',
                \League\Flysystem\UnixVisibility\PortableVisibilityConverter::fromArray([
                    'file' => [
                        'public' => 0644,
                        'private' => 0600,
                        ],
                    'dir' => [
                        'public' => 0755,
                        'private' => 0700,
                        ],
                    ]),
                    LOCK_EX,
                    \League\Flysystem\Local\LocalFilesystemAdapter::DISALLOW_LINKS
                ]
        ],
        'aliases' => [
             '@invoices' => '@root/export/invoices',
             '@orders' => '@root/export/orders',
        ],
    ],
],
```

Aliases `runtimeStorage` and `documentStorage` will be automatically registered in the main application container. So, you can get it from the container:

```
public function index(ContainerInterface $container)
{
    $documentStorage = $container->get('documentStorage');
}
```

If you prefer to use autowiring, you can create own interface for your filesystem.

```
interface ImageStorageInterface extends \Yiisoft\Yii\Filesystem\FilesystemInterface
{
}
```

And then register it in the `params`:

```
'file.storage' => [
    ImageStorageInterface::class => [
        'adapter' => [
            'class' => \League\Flysystem\Local\LocalFilesystemAdapter::class,
            '__construct()' => [
                dirname(__DIR__) . '/storage/images',
                \League\Flysystem\UnixVisibility\PortableVisibilityConverter::fromArray([
                    'file' => [
                        'public' => 0644,
                        'private' => 0600,
                    ],
                    'dir' => [
                        'public' => 0755,
                        'private' => 0700,
                    ],
                ]),
                LOCK_EX,
                \League\Flysystem\Local\LocalFilesystemAdapter::DISALLOW_LINKS
            ]
        ],
    ],
]
```

Now you can use it like this:

```
//controller action
public function addImage(ImageStorageInterface $imageStorage)
{
    //get image stream...

    $imageStorage->writeStream('/path/to/image/myimage.jpeg', $myImageStream);
}
```

You can find documentation on `FilesystemInterface` methods in the [Flysystem Docs](https://flysystem.thephpleague.com/v2/docs/).

### Unit testing

[](#unit-testing)

The package is tested with [PHPUnit](https://phpunit.de/). To run tests:

```
./vendor/bin/phpunit
```

### Mutation testing

[](#mutation-testing)

The package tests are checked with [Infection](https://infection.github.io/) mutation framework. To run it:

```
./vendor/bin/infection
```

### Static analysis

[](#static-analysis)

The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:

```
./vendor/bin/psalm
```

### Support the project

[](#support-the-project)

[![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft)

### Follow updates

[](#follow-updates)

[![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack)

License
-------

[](#license)

The Yii filesystem is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).

###  Health Score

27

—

LowBetter than 52% of packages

Maintenance16

Infrequent updates — may be unmaintained

Popularity37

Limited adoption so far

Community26

Small or concentrated contributor base

Maturity26

Early-stage or recently created project

 Bus Factor1

Top contributor holds 50.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe)

![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark)

![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire)

![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol)

---

Top Contributors

[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (28 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (10 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (7 commits)")[![yiiliveext](https://avatars.githubusercontent.com/u/37578608?v=4)](https://github.com/yiiliveext "yiiliveext (2 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (2 commits)")[![Nex-Otaku](https://avatars.githubusercontent.com/u/2260071?v=4)](https://github.com/Nex-Otaku "Nex-Otaku (1 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (1 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (1 commits)")[![Fantom409](https://avatars.githubusercontent.com/u/14968877?v=4)](https://github.com/Fantom409 "Fantom409 (1 commits)")[![roxblnfk](https://avatars.githubusercontent.com/u/4152481?v=4)](https://github.com/roxblnfk "roxblnfk (1 commits)")

---

Tags

filesystem

### Embed Badge

![Health badge](/badges/yiisoft-yii-filesystem/health.svg)

```
[![Health](https://phpackages.com/badges/yiisoft-yii-filesystem/health.svg)](https://phpackages.com/packages/yiisoft-yii-filesystem)
```

###  Alternatives

[laravel/telescope

An elegant debug assistant for the Laravel framework.

5.2k65.4M154](/packages/laravel-telescope)[spiral/roadrunner

RoadRunner: High-performance PHP application server and process manager written in Go and powered with plugins

8.4k11.6M74](/packages/spiral-roadrunner)[composer/installers

A multi-framework Composer library installer

1.4k133.5M5.5k](/packages/composer-installers)[laravel/dusk

Laravel Dusk provides simple end-to-end testing and browser automation.

1.9k35.9M222](/packages/laravel-dusk)[laravel/fortify

Backend controllers and scaffolding for Laravel authentication.

1.7k38.8M190](/packages/laravel-fortify)[cakephp/chronos

A simple API extension for DateTime.

1.4k47.0M101](/packages/cakephp-chronos)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
