folded / file
Manipulate files with functions for your web app.
Requires
- webmozart/assert: 1.*
Requires (Dev)
- friendsofphp/php-cs-fixer: 2.*
- pestphp/pest: 0.3.*
- phpstan/phpstan: 0.12.*
- phpunit/phpunit: 9.*
This package is auto-updated.
Last update: 2024-11-17 16:31:28 UTC
README
Manipulate files with functions for your web app.
Summary
About
I created this library, to avoid having to throw exception in my code when I use the file functions.
Folded is a constellation of packages to help you setting up a web app easily, using ready to plug in packages.
- folded/action: A way to organize your controllers for your web app.
- folded/config: Configuration utilities for your PHP web app.
- folded/crypt: Encrypt and decrypt strings for your web app.
- folded/exception: Various kind of exception to throw for your web app.
- folded/history: Manipulate the browser history for your web app.
- folded/http: HTTP utilities for your web app.
- folded/orm: An ORM for you web app.
- folded/routing: Routing functions for your PHP web app.
- folded/request: Request utilities, including a request validator, for your PHP web app.
- folded/session: Session functions for your web app.
- folded/view: View utilities for your PHP web app.
Features
- Will throw an Exception if an error occured while using the functions
- Have the exact same signature as the native functions
Requirements
- PHP version >= 7.4.0
- Composer installed
Installation
In your root folder, run this command:
composer required folded/file
Examples
- 1. Open a file
- 2. Close a file
- 3. Delete a file
- 4. Write a CSV row to a file
- 5. Read a CSV row from a file
- 6. Rename a file
- 7. Write on file
1. Open a file
In this example, we will get an opened file.
use function Folded\openFile; $file = openFile("path/to/file.txt", "r");
2. Close a file
In this example, we will close an opened file.
use function Folded\openFile; use function Folded\closeFile; $file = openFile("path/to/file.txt", "r"); closeFile($file);
3. Delete a file
In this example, we will delete an existing file.
use function Folded\deleteFile; deleteFile("path/to/file.txt");
4. Write a CSV row to a file
In this example, we will write a CSV row in a file.
use function Folded\openFile; use function Folded\addCsvRowToFile; $file = openFile("path/to/file.csv", "w"); addCsvRowToFile($file, ["foo", "bar"]);
5. Read a CSV row from a file
In this example, we will get a CSV row from a file. Subsequent calls will get the next rows from the file.
use function Folded\openFile; use function Folded\getCsvRowFromFile; $file = openFile("path/to/file.csv", "r"); $firstRow = getCsvRowFromFile($file); $secondRow = getCsvRowFromFile($file);
6. Rename a file
In this example, we will rename a file.
use function Folded\changeName; changeName("path/to/old.txt", "path/to/new.txt");
7. Write on file
In this example, we will write on an opened file.
use function Folded\writeOnFile; $file = fopen("path/to/file.txt"); writeToFile($file, "some text");
If you need to get the number of bytes written, get the return of the function.
use function Folded\writeOnFile; $file = fopen("path/to/file.txt"); $numberOfBytesWritten = writeToFile($file, "some text"); echo "$numberOfBytesWritten bytes written";