sgh / comparable-filesystem
Provides Comparators for the file system.
Requires
- php: >=5.4.0
- sgh/comparable: >=1.0.0
Requires (Dev)
- mikey179/vfsstream: 1.*
- phpunit/phpunit: 4.*
This package is not auto-updated.
Last update: 2024-10-26 15:54:58 UTC
README
This package provides Comparators for the file system, i.e. for SplFileInfo objects. They can be used with the sorting and comparing tools in the Comparable package.
Requirements
The package requires PHP 5.4 or later and the Comparable package in version 1.0 or later.
Install
Via Composer
$ composer require sgh/comparable-filesystem
Usage
The following comparators are available:
- FileATimeComparator
- FileCTimeComparator
- FileMTimeComparator
- FileNameComparator
- FileSizeComparator
- FileTypeComparator
You can use all the methods in \SGH\Comparable\SortFunctions
and \SGH\Comparable\SetFunctions
with the comparators.
If you prefer, you can also use the factory method ::callback()
to retrieve a comparison callback, that can be used
in any function that expects a user defined comparison callback:
usort($arrayOfFiles, \SGH\Comparable\Filesystem\Comparator\FileSizeComparator::callback());
Testing
$ phpunit
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email fschmengler@sgh-it.eu instead of using the issue tracker.
Credits
- Fabian Schmengler(https://github.com/schmengler)
- All Contributors
License
The MIT License (MIT). Please see License File for more information.