jdz/dump

JDZ simple file dumper helper

Maintainers

Package info

github.com/joffreydemetz/dump

Homepage

pkg:composer/jdz/dump

Statistics

Installs: 12

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

1.0.1 2026-04-09 13:15 UTC

This package is auto-updated.

Last update: 2026-04-09 13:16:27 UTC


README

Simple file dumper helper

Installation

composer require jdz/dump

Requirements

  • PHP 8.2 or higher

Usage

Basic Example

use JDZ\Utils\Dump;

$dump = new Dump('/path/to/logfile.txt');

// Write content (appends to file)
$dump->write('First line');
$dump->write('Second line');

// Read file contents
$content = $dump->read(); // "First line\nSecond line\n"

// Check if file exists
$dump->exists(); // true

// Delete file
$dump->delete();
$dump->exists(); // false

Fluent Interface

write() and delete() return $this for chaining:

$dump = new Dump('/tmp/debug.log');
$dump->write('Starting process')
     ->write('Step 1 complete')
     ->write('Step 2 complete');

Reading a Non-Existent File

$dump = new Dump('/path/to/missing.txt');
$dump->read(); // null

Testing

composer test
# or
vendor/bin/phpunit

License

This project is licensed under the MIT License - see the LICENSE file for details.