https://github.com/yiisoft/files
Useful methods to manage files and directories
https://github.com/yiisoft/files
directories directory file files filesystem hacktoberfest yii3
Last synced: 2 months ago
JSON representation
Useful methods to manage files and directories
- Host: GitHub
- URL: https://github.com/yiisoft/files
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2019-07-17T21:39:30.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-07T15:27:06.000Z (9 months ago)
- Last Synced: 2024-10-29T14:36:14.389Z (7 months ago)
- Topics: directories, directory, file, files, filesystem, hacktoberfest, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 193 KB
- Stars: 33
- Watchers: 20
- Forks: 17
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Files
[](https://packagist.org/packages/yiisoft/files)
[](https://packagist.org/packages/yiisoft/files)
[](https://github.com/yiisoft/files/actions/workflows/build.yml)
[](https://codecov.io/gh/yiisoft/files)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/files/master)
[](https://github.com/yiisoft/files/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/files)
The package provides useful methods to manage files and directories.
## Requirements
- PHP 8.0 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/files
```
## FileHelper usage
FileHelper provides static methods you can use for various filesystem-related operations.
### Working with directories
Ensure a directory exists:
```php
use \Yiisoft\Files\FileHelper;
$directory = '/path/to/dir';
FileHelper::ensureDirectory($directory);
```
Ensure a directory exists, and permission specified is set:
```php
use \Yiisoft\Files\FileHelper;
$directory = '/path/to/dir';
FileHelper::ensureDirectory($directory, 0775);
```
Remove a directory:
```php
use \Yiisoft\Files\FileHelper;
$directory = '/path/to/dir';
FileHelper::removeDirectory($directory);
```
Remove everything within a directory but not directory itself:
```php
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:
```php
use \Yiisoft\Files\FileHelper;
$directory = '/path/to/dir';
FileHelper::isEmptyDirectory($directory);
```
Copy directory:
```php
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:
```php
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
Searching for files:
```php
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:
```php
use \Yiisoft\Files\FileHelper;
use Yiisoft\Files\PathMatcher\PathMatcher;
$directories = FileHelper::findDirectories('/path/to/where/to/search', [
'filter' => (new PathMatcher())->except('**meta'),
]);
```
### 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
Open a file. Same as PHP's `fopen()` but throwing exceptions.
```php
use \Yiisoft\Files\FileHelper;
$handler = FileHelper::openFile('/path/to/file', 'rb');
```
Get last modified time for a directory or file:
```php
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:
```php
use \Yiisoft\Files\FileHelper;
$file = '/path/to/file.txt';
FileHelper::unlink($file);
```
Normalize a path:
```php
use \Yiisoft\Files\FileHelper;
$path = '/home/samdark/./test/..///dev\yii/';
echo FileHelper::normalizePath($path);
// outputs:
// /home/samdark/dev/yii
```
## 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
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
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)