https://github.com/stk2k/file-system
simple file system library for PHP
https://github.com/stk2k/file-system
Last synced: 5 months ago
JSON representation
simple file system library for PHP
- Host: GitHub
- URL: https://github.com/stk2k/file-system
- Owner: stk2k
- License: mit
- Created: 2021-06-05T04:22:48.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-03T05:13:00.000Z (about 4 years ago)
- Last Synced: 2025-01-02T00:21:11.263Z (6 months ago)
- Language: PHP
- Size: 636 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A simle file system classes
=======================
[](https://packagist.org/packages/stk2k/file-system)
[](LICENSE.md)
[](https://api.travis-ci.com/stk2k/file-system.svg?branch=main)
[](https://coveralls.io/repos/github/stk2k/file-system/badge.svg?branch=main)
[](https://codeclimate.com/github/stk2k/file-system)
[](https://packagist.org/packages/stk2k/file-system)
## Description
A simle file system classes
## Feature
- Simple file class(File)
- File function facade class(FileFacade)
## Usage
### making a file
```php
use stk2k\filesystem\FileSystem;
FileSystem::put('/path/to/file', 'Hello, World');
```
### deleting a file
```php
use stk2k\filesystem\FileSystem;
FileSystem::delete('/path/to/file');
```
### getting file's content
```php
use stk2k\filesystem\FileSystem;
// getting whole content as string
$ret = FileSystem::get('/path/to/file');
echo $ret;
// getting whole content as array
$ret = FileSystem::getAsArray('/path/to/file');
print_r($ret);
```
### putting file's content
```php
use stk2k\filesystem\File;
use stk2k\filesystem\FileSystem;
// putting string content
$ret = FileSystem::put('/path/to/file', 'Hello, World!');
echo $ret->get(); // Hello, World!
// putting array(of strings) content
$ret = FileSystem::put('/path/to/file', ['Foo', 'Bar']);
echo $ret->get();
// Foo
// Bar
// putting File object
file_put_contents('/path/to/file1', 'Hello, World!');
$ret = FileSystem::put('/path/to/file2', new File('/path/to/file1'));
echo $ret->get(); // Hello, World!
// putting object content(Stringable)
class MyStringableObject
{
public function __toString() : string
{
return 'Hello, World!';
}
}
$ret = FileSystem::put('/path/to/file', new MyStringableObject());
echo $ret->get(); // Hello, World!
```
### file object
```php
use stk2k\filesystem\File;
$ret = new File('/path/to/file');
echo $ret->get();
```
## Requirement
PHP 7.2 or later
## Installing stk2k/file-system
The recommended way to install stk2k/file-system is through
[Composer](http://getcomposer.org).
```bash
composer require stk2k/file-system
```
After installing, you need to require Composer's autoloader:
```php
require 'vendor/autoload.php';
```
## License
This library is licensed under the MIT license.
## Author
[stk2k](https://github.com/stk2k)
## Disclaimer
This software is no warranty.
We are not responsible for any results caused by the use of this software.
Please use the responsibility of the your self.