Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/debuss/finder
This Finder class finds files and directories via a set of rules, the same way as the Finder Component from Symfony but in a much simpler implementation.
https://github.com/debuss/finder
Last synced: about 2 months ago
JSON representation
This Finder class finds files and directories via a set of rules, the same way as the Finder Component from Symfony but in a much simpler implementation.
- Host: GitHub
- URL: https://github.com/debuss/finder
- Owner: debuss
- License: mit
- Created: 2016-10-26T13:00:50.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-09T13:35:15.000Z (almost 7 years ago)
- Last Synced: 2024-04-23T15:42:32.275Z (9 months ago)
- Language: PHP
- Size: 95.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Finder
This Finder class finds files and directories via a set of rules, the same way as [the Finder Component from Symfony](https://symfony.com/doc/current/components/finder.html) but in a much simpler implementation.
The main purpose was to create an alternative to the **Symfony Finder** because I find it too "heavy" for what it is suppose to do.
Many files, folder, iterators, comparators, classes and exceptions (~20). **That's too much for a finder...**
**Let's keep it simple !**
As my Finder is a simpler version of the Symfony one, you won't find some features :
* Custom exceptions _(only Exception classes from SPL)_
* Custom SplFileInfo, therefore these methods are not available :
* getRelativePath()
* getRelativePathname()
* getContents()
_(It is still easy to implement them by your own...)_
## Installation
Via composer :
```
$ composer require debuss-a/finder "dev-master"
```
## Usage
#### List files and folders in a directory
```php
use KeepItSimple\FileSystem\Finder;
foreach (Finder::create()->in(__DIR__) as $file) {
// Magic here
// $file is an instance of SplFileInfo
}
```
#### List only files or only folders in a directory
```php
use KeepItSimple\FileSystem\Finder;
foreach (Finder::create()->files()->in(__DIR__) as $file) {
// Magic here
// $file is an instance of SplFileInfo
}
foreach (Finder::create()->directories()->in(__DIR__) as $file) {
// Magic here
// $file is an instance of SplFileInfo
}
```
#### Select a directory
The only compulsory parameter is a path.
You may use the _in()_ method with glob() like path.
The _in()_ method can be chained to include many paths or an array of path can be provided.
```php
use KeepItSimple\FileSystem\Finder;
foreach (Finder::create()->in(__DIR__.'/*/*/test') as $file) {
// Magic here
// $file is an instance of SplFileInfo
}
foreach (Finder::create()->in(__DIR__)->in('/home/alex/docs') as $file) {
// Magic here
// $file is an instance of SplFileInfo
}
foreach (Finder::create()->in([__DIR__, '/home/alex/docs']) as $file) {
// Magic here
// $file is an instance of SplFileInfo
}
```
#### Sorting
Some sorting method are already provided but you can also supply your own.
```php
use KeepItSimple\FileSystem\Finder;
foreach (Finder::create()->in(__DIR__)->sortByName() as $file) {
// Magic here
// $file is an instance of SplFileInfo
}
$finder = Finder::create()->in(__DIR__)->sort(function (SplFileInfo $a, SplFileInfo $b) {
// Equivalent to the method sortByName()
return strcmp($a->getFilename(), $b->getFilename())
});
foreach ($finder as $file) {
// Magic here
// $file is an instance of SplFileInfo
}
```
#### Filtering
Some filtering method are already provided but you can also supply your own.
```php
use KeepItSimple\FileSystem\Finder;
// The name() method accepts globs, strings, or regexes
foreach (Finder::create()->in(__DIR__)->name('*.php') as $file) {
// Magic here
// $file is an instance of SplFileInfo
}
$finder = Finder::create()->in(__DIR__)->filter(function (SplFileInfo $current) {
return $current->getBasename() !== 'index.php';
});
foreach ($finder as $file) {
// Magic here
// $file is an instance of SplFileInfo
}
```
## Complete documentation
The complete documentation is provided in the _documentation_ folder.
Generated with [APIGen](http://www.apigen.org/).