PHPackages                             yiisoft/files - 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/files

ActiveLibrary[Framework](/categories/framework)

yiisoft/files
=============

Helper to manage files and directories

2.1.0(5mo ago)361.3M↓18.7%16[3 issues](https://github.com/yiisoft/files/issues)[1 PRs](https://github.com/yiisoft/files/pulls)20BSD-3-ClausePHPPHP 8.0 - 8.5CI passing

Since Feb 10Pushed 4mo ago16 watchersCompare

[ Source](https://github.com/yiisoft/files)[ Packagist](https://packagist.org/packages/yiisoft/files)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-files/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (6)Versions (6)Used By (20)

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

Yii Files
=========

[](#yii-files)

[![Latest Stable Version](https://camo.githubusercontent.com/590150193ba94d9eaeba2d8aea3426bfd97376bf67e71f1ee9bd658deebcc9e8/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f66696c65732f76)](https://packagist.org/packages/yiisoft/files)[![Total Downloads](https://camo.githubusercontent.com/efdb760ec31ce7eb80aed396d1b1796a8c8066cf89eef3dfded30a33ac0b888c/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f66696c65732f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/files)[![Build status](https://github.com/yiisoft/files/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/files/actions/workflows/build.yml)[![Code Coverage](https://camo.githubusercontent.com/7d7223cd1accdb689228551efa451c65ef871e07d41bffc7dd7bfbf6caf90b95/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f66696c65732f67726170682f62616467652e7376673f746f6b656e3d4c704b48304338505963)](https://codecov.io/gh/yiisoft/files)[![Mutation testing badge](https://camo.githubusercontent.com/2bb5e42272c75ce0a06107316874311e6938eed8bedab709d4f32a292bb1cc09/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f667425324666696c65732532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/files/master)[![static analysis](https://github.com/yiisoft/files/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/files/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/9c1fd8ac848fe7e8b63e4dc15830ed9f89cc023a8ec719bf56df2599560df6ab/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f66696c65732f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/files)

The package provides useful methods to manage files and directories.

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

[](#requirements)

- PHP 8.0 - 8.5.

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

[](#installation)

The package could be installed with [Composer](https://getcomposer.org):

```
composer require yiisoft/files
```

FileHelper usage
----------------

[](#filehelper-usage)

FileHelper provides static methods you can use for various filesystem-related operations.

### Working with directories

[](#working-with-directories)

Ensure a directory exists:

```
use \Yiisoft\Files\FileHelper;

$directory = '/path/to/dir';
FileHelper::ensureDirectory($directory);
```

Ensure a directory exists, and permission specified is set:

```
use \Yiisoft\Files\FileHelper;

$directory = '/path/to/dir';
FileHelper::ensureDirectory($directory, 0775);
```

Remove a directory:

```
use \Yiisoft\Files\FileHelper;

$directory = '/path/to/dir';
FileHelper::removeDirectory($directory);
```

Remove everything within a directory but not directory itself:

```
use \Yiisoft\Files\FileHelper;

$directory = '/path/to/dir';
FileHelper::clearDirectory($directory, [
    'traverseSymlinks' => false,
    'filter' => (new PathMatcher())
        ->only('**.png', '**.jpg')
        ->except('**/logo.png'),
]);
```

Check if directory is empty:

```
use \Yiisoft\Files\FileHelper;

$directory = '/path/to/dir';
FileHelper::isEmptyDirectory($directory);
```

Copy directory:

```
use \Yiisoft\Files\FileHelper;

$source = '/path/to/source';
$destination = '/path/to/destination';
FileHelper::copyDirectory($source, $destination);
```

Additional options could be specified as third argument such as `filter` or `copyEmptyDirectories`. Check method phpdoc for a full list of options.

Copy file:

```
use \Yiisoft\Files\FileHelper;

$source = '/path/to/file';
$destination = '/path/to/destination';
FileHelper::copyFile($source, $destination);
```

Additional options could be specified as third argument such as `beforeCopy` or `afterCopy`. Check method phpdoc for a full list of options.

### Search

[](#search)

Searching for files:

```
use \Yiisoft\Files\FileHelper;
use Yiisoft\Files\PathMatcher\PathMatcher;

$files = FileHelper::findFiles('/path/to/where/to/search', [
    'filter' => (new PathMatcher())
        ->only('**.png', '**.jpg')
        ->except('**/logo.png'),
]);
```

Searching for directories:

```
use \Yiisoft\Files\FileHelper;
use Yiisoft\Files\PathMatcher\PathMatcher;

$directories = FileHelper::findDirectories('/path/to/where/to/search', [
    'filter' => (new PathMatcher())->except('**meta'),
]);
```

### Path matchers

[](#path-matchers)

A `PathMatcherInterface` can be passed by `filter` key in the `options` argument of a method. Both `PathMatcher` and `CompositeMatcher` implement the `PathMatcherInterface`. `CompositeMatcher` allows using a list of `PathMatcherInterface` sequentially.

Pattern matching is based on `yiisoft/strings` package [and is described in its readme](https://github.com/yiisoft/strings#wildcardpattern-usage).

### Other

[](#other)

Open a file. Same as PHP's `fopen()` but throwing exceptions.

```
use \Yiisoft\Files\FileHelper;

$handler = FileHelper::openFile('/path/to/file', 'rb');
```

Get last modified time for a directory or file:

```
use \Yiisoft\Files\FileHelper;

$directory = '/path/to/dir';
$time = FileHelper::lastModifiedTime($directory);
```

The method is different from PHP's `filemtime()` because it actually scans a directory and selects the largest modification time from all files.

Remove a file or symlink:

```
use \Yiisoft\Files\FileHelper;

$file = '/path/to/file.txt';
FileHelper::unlink($file);
```

Normalize a path:

```
use \Yiisoft\Files\FileHelper;

$path = '/home/samdark/./test/..///dev\yii/';
echo FileHelper::normalizePath($path);
// outputs:
// /home/samdark/dev/yii
```

Documentation
-------------

[](#documentation)

- [Internals](docs/internals.md)

If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).

License
-------

[](#license)

The Yii Files 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/).

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)

###  Health Score

63

—

FairBetter than 99% of packages

Maintenance72

Regular maintenance activity

Popularity52

Moderate usage in the ecosystem

Community45

Growing community involvement

Maturity74

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

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.

###  Release Activity

Cadence

Every ~438 days

Total

5

Last Release

168d ago

Major Versions

1.0.2 → 2.0.02022-07-05

PHP version history (3 changes)1.0.0PHP ^7.4|^8.0

2.0.0PHP ^8.0

2.1.0PHP 8.0 - 8.5

### 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 (57 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (29 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (9 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (8 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (8 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (8 commits)")[![StyleCIBot](https://avatars.githubusercontent.com/u/11048387?v=4)](https://github.com/StyleCIBot "StyleCIBot (4 commits)")[![KartaviK](https://avatars.githubusercontent.com/u/5941637?v=4)](https://github.com/KartaviK "KartaviK (3 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (3 commits)")[![DplusG](https://avatars.githubusercontent.com/u/11989901?v=4)](https://github.com/DplusG "DplusG (2 commits)")[![Gerych1984](https://avatars.githubusercontent.com/u/90403480?v=4)](https://github.com/Gerych1984 "Gerych1984 (2 commits)")[![tomaszkane](https://avatars.githubusercontent.com/u/1530354?v=4)](https://github.com/tomaszkane "tomaszkane (1 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (1 commits)")[![mspirkov](https://avatars.githubusercontent.com/u/63721828?v=4)](https://github.com/mspirkov "mspirkov (1 commits)")[![darkdef](https://avatars.githubusercontent.com/u/8342004?v=4)](https://github.com/darkdef "darkdef (1 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (1 commits)")[![dood-](https://avatars.githubusercontent.com/u/10099592?v=4)](https://github.com/dood- "dood- (1 commits)")[![Fantom409](https://avatars.githubusercontent.com/u/14968877?v=4)](https://github.com/Fantom409 "Fantom409 (1 commits)")[![Insolita](https://avatars.githubusercontent.com/u/1847402?v=4)](https://github.com/Insolita "Insolita (1 commits)")[![cazak](https://avatars.githubusercontent.com/u/74562331?v=4)](https://github.com/cazak "cazak (1 commits)")

---

Tags

directoriesdirectoryfilefilesfilesystemhacktoberfestyii3files

###  Code Quality

TestsPHPUnit

Static AnalysisRector

### Embed Badge

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

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

###  Alternatives

[amranidev/scaffold-interface

A Smart CRUD Generator For Laravel

92120.7k1](/packages/amranidev-scaffold-interface)[yiisoft/validator

Yii Validator

164367.7k20](/packages/yiisoft-validator)[yiisoft/arrays

Yii Array Helper

562.0M56](/packages/yiisoft-arrays)[yiisoft/security

Security utilities

43451.3k6](/packages/yiisoft-security)[yiisoft/yii-middleware

Yii Middleware

21151.3k1](/packages/yiisoft-yii-middleware)[cakephp/filesystem

CakePHP filesystem convenience classes to help you work with files and folders.

19179.1k10](/packages/cakephp-filesystem)

PHPackages © 2026

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