metin/exodus

Simple and flexible data export library for PHP

0.3.0 2025-01-29 08:13 UTC

Requires

• php: ^8.2
• ext-fileinfo: *
• ext-json: *
• ext-mbstring: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• phpunit/phpunit: ^10.0

MIT

README

Simple and flexible data export library for PHP.

$exporter = new ExportManager(new CsvExporter());
$options = new ExportOptions(
    path: '/path/to/export',
    delimiter: ',',
    includeHeaders: true
);
$result = $exporter->process($data, $options);

Installation

You can install the package via composer:

composer require metin/exodus

Requirements

• PHP 8.2 or higher
• ext-json
• ext-fileinfo
• ext-mbstring

Basic Usage

CSV Export

use Metin\Exodus\Core\ExportManager;
use Metin\Exodus\Exporters\CsvExporter;
use Metin\Exodus\Dto\ExportOptions;
// Prepare data
$data = [
    ['name' => 'John Doe', 'email' => '[e-mail]'],
    ['name' => 'Jane Doe', 'email' => '[e-mail]']
];
// Configure export options
$options = new ExportOptions(
    path: '/path/to/export',
    delimiter: ',',
    includeHeaders: true,
    filename: 'users.csv'
);
// Create exporter and process
$exporter = new ExportManager(new CsvExporter());
$result = $exporter->process($data, $options);
if ($result->success) {
    echo "File exported to: " . $result->path;
} else {
    echo "Export failed: " . $result->error;
}

JSON Export

use Metin\Exodus\Core\ExportManager;
use Metin\Exodus\Exporters\JsonExporter;
use Metin\Exodus\Dto\ExportOptions;

// Prepare data
$data = [
    ['name' => 'John Doe', 'email' => '[e-mail]'],
    ['name' => 'Jane Doe', 'email' => '[e-mail]']
];

// Configure export options
$options = new ExportOptions(
    path: '/path/to/export',
    filename: 'users.json',
    formatOptions: [
        'prettyPrint' => true,
        'unescapeUnicode' => true
    ]
);

// Create exporter and process
$exporter = new ExportManager(new JsonExporter());
$result = $exporter->process($data, $options);

if ($result->success) {
    echo "File exported to: " . $result->path;
} else {
    echo "Export failed: " . $result->error;
}

Features

• Export data to multiple formats (CSV, JSON)
• Format specific options support
• CSV Features:
• • Configurable delimiter
• • Optional headers
• JSON Features:
• • Pretty print option
• • Unicode character support
• Comprehensive error handling
• Data validation
• Type-safe objects

Testing

The package comes with a PHPUnit test suite. To run the tests:

composer test

Test Directory Structure

tests/
├── TestCase.php              # Base test case with helper methods
├── Dto/                      # Tests for Data Transfer Objects
├── Exporters/               # Tests for Export implementations
└── data/                    # Test data directory (auto-created)

Testing Different Scenarios

The test suite covers:

• CSV export with/without headers
• Custom delimiters
• Auto-generated and custom filenames
• Error scenarios (invalid directory, empty data, etc.)
• Data validation

License

The MIT License (MIT). Please see License File for more information.