Wallogit.com
2017 © Pedro Peláez
A simple filereader. PHP 7+
A simple file/directory reader for all (well, most... ok. some.) of your file-reading needs., (*1)
![license][license-badge]
![Travis][travis-badge]
![Coverage][coverage-badge]
![Scrunitizer][scrutinizer-badge]
![Packagist downloads][downloads-badge]
![PayPal donate][donate-badge], (*2)
requires composer, (*3)
(note: replace dev-master with a version boundary), (*4)
{
"require": {
"php": ">=7.2.0",
"chillerlan/database": "dev-master"
}
}
Download the desired version of the package from master or
release and extract the contents to your project folder. After that:
- run composer install to install the required dependencies and generate /vendor/autoload.php.
- if you use a custom autoloader, point the namespace chillerlan\Filereader to the folder src of the package, (*5)
Profit!, (*6)
You can just invoke one a FSDriverInterface and use it right away:, (*7)
use chillerlan\Filereader\Drivers\DiskDriver;
$filereader = new DiskDriver;
$filereader->isDir('/some/path');
$directory = new Directory($filereader, '/some/path');
/** @var \chillerlan\Filereader\File $file */
foreach($directory->read() as $file){
echo $file->name;
// ...
}
FSDriverInterface methods| method | return |
|---|---|
fileExists(string $path) |
bool |
isFile(string $path) |
bool |
fileContents(string $path) |
string |
getRequire(string $path) |
mixed |
deleteFile(string $path) |
bool |
copyFile(string $source, string $destination, bool $overwrite = true) |
bool |
isDir(string $path) |
bool |
makeDir(string $path) |
bool |
deleteDir(string $path) |
bool |
rename(string $oldname, string $newname, bool $overwrite = true) |
bool |
Directory public methods| method | return |
|---|---|
__construct(FSDriverInterface $driver, string $path) |
- |
change(string $path) |
Directory |
read() |
array of File objects |
create(string $subdir = null) |
bool |
delete(string $subdir = null) |
bool |
rename(string $newname, bool $overwrite = true) |
Directory |
File public methods| method | return |
|---|---|
__construct(FSDriverInterface $driver, Directory $directory, string $name) |
- |
exists() |
bool |
content() |
string |
getRequire() |
mixed |
copy(string $destination, bool $overwrite = true) |
bool |
rename(string $newname, bool $overwrite = true) |
File |
delete() |
bool |
Directory and File
| property | type | description |
|---|---|---|
$path |
string | the full path to the resource |
File
| property | type | description |
|---|---|---|
$name |
string | the basename of the file |
$directory |
Directory |
the Directory which contains the file |
A simple filereader. PHP 7+
MIT
A simple filereader. PHP 7+
MIT
A simple filereader. PHP 7+
MIT