kelsoncm/php-fwf

PHP library for reading, writing, and parsing Fixed Width Files (FWF)

1.0.0 2026-07-20 20:51 UTC

Requires

• php: >=8.2

Requires (Dev)

• phpunit/phpunit: ^10.5 || ^11.0

MIT

• Kelson da Costa Medeiros

Published on Packagist.org on 2026-07-20 21:00 UTC

README

php-fwf

php-fwf is a fast, type-safe PHP library for parsing, validating, and exporting Fixed Width Files (FWF).

It is part of the Fixed Width File Ecosystem and fully implements the fwf-compliance-tests v1.0.0 specification.

🌟 Key Features

• Type-Safe Columns: CharColumn, RightCharColumn, PositiveIntegerColumn, PositiveDecimalColumn, DateColumn, TimeColumn, and DateTimeColumn.
• Flexible Descriptors: Structured records with HeaderRowDescriptor, DetailRowDescriptor, and FooterRowDescriptor.
• Multiple Output Renders: Export layout specifications to Markdown, ReStructuredText (RST), or HTML tables via RenderUtils.
• Full Test Suite & Compliance: 100% compliant with fwf-compliance-tests v1.0.0.
• Git Hooks Ready: Pre-configured pre-commit and pre-push hooks.

🚀 Installation

Install via Composer:

composer require kelsoncm/php-fwf

💡 Quickstart

<?php

use Kelsoncm\Fwf\Columns\CharColumn;
use Kelsoncm\Fwf\Columns\PositiveIntegerColumn;
use Kelsoncm\Fwf\Descriptors\DetailRowDescriptor;
use Kelsoncm\Fwf\Descriptors\FileDescriptor;
use Kelsoncm\Fwf\Readers\Reader;

// 1. Define columns
$nameCol = new CharColumn('name', 20, 'User Name');
$ageCol = new PositiveIntegerColumn('age', 3, 'Age in years');

// 2. Define row and file descriptors
$detail = new DetailRowDescriptor([$nameCol, $ageCol]);
$fileDescriptor = new FileDescriptor([$detail]);

// 3. Read fixed-width file content
$content = "KELSON MEDEIROS     045\nMARIA SILVA         030\n";
$reader = new Reader($content, $fileDescriptor, "\n");

foreach ($reader as $row) {
    echo "Name: {$row['name']} | Age: {$row['age']}\n";
}

📖 phpDocumentor & GitHub Pages

Generated documentation is ready for GitHub Pages publication in the docs/ directory:

• Landing Page: docs/index.html
• API Documentation: docs/apidocs/index.html

🧪 Testing & Compliance

Run all unit tests and compliance checks using PHPUnit:

vendor/bin/phpunit

⚓ Pre-Commit & Pre-Push Setup

Set up pre-commit and pre-push hooks:

pre-commit install
pre-commit install --hook-type pre-push

Run checks manually:

pre-commit run --all-files

📄 License

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